Systems.Config.Translations Entity
Namespace: Systems.Config
Contains user-defined translations for non-english languages of the user interface and program messages. Entity: Sys_Translations
Renames
Old name: Systems.Core.Translations
New name: Systems.Config.Translations
Version: 24.1.5.35
Case: 35911
Default Visualization
Default Display Text Format:
{ApplicationName}
Default Search Members:
ApplicationName
Name Data Member:
ApplicationName
Category: Settings
Show in UI: ShownByDefault
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
Attributes
Name | Type | Description |
---|---|---|
Active | boolean | True when the translation is verified and activated. Required Default(true) Filter(eq) |
ApplicationName | string (50) nullable | The application, containing the resource. For base resource types (T,C,H), this is null. Filter(eq) ORD |
CreationTime | datetime | Timestamp when the translation was first created. Required Default(Now) Filter(ge;le) ReadOnly |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
Id | guid | |
Language | string (8) | The code of the language by the ISO639-1 two letter language coding: "en"=English, "bg"=Bulgarian. Required Default("en") Filter(eq) |
ObjectVersion | int32 | The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking. |
ResourceId | string (800) | The unique identifier of the translated resource. Should use ASCII/English chars only. Shorter strings are suggested. Depending on Text_Type: T:TableName; C:ColumnName; H:TableName.ColumnName; E,M,S: Application specific code. Required Filter(eq;like) |
ResourceType | ResourceType | T=Table (entity) Name; C=Column Name; H=Column Hint; R=Meta Resource; E=Error; M=Message; S=Other application specific String. Required Default("S") Filter(eq) |
TranslationField | string (max) | The translated text. Required |
UpdateTime | datetime | When the translation was last updated. Required Default(Now) Filter(ge;le) ReadOnly |
Attribute Details
Active
True when the translation is verified and activated. Required
Default(true)
Filter(eq)
Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault
Front-End Recalc Expressions:
IIF( Not( IsNullOrEmpty( obj.TranslationField)), True, obj.Active)
ApplicationName
The application, containing the resource. For base resource types (T,C,H), this is null. Filter(eq)
ORD
Type: string (50) nullable
Indexed: True
Category: System
Supported Filters: Equals
Supports Order By: True
Maximum Length: 50
Show in UI: ShownByDefault
CreationTime
Timestamp when the translation was first created. Required
Default(Now)
Filter(ge;le)
ReadOnly
Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: ShownByDefault
DisplayText
Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown
Language
The code of the language by the ISO639-1 two letter language coding: "en"=English, "bg"=Bulgarian. Required
Default("en")
Filter(eq)
Type: string (8)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 8
Default Value: en
Show in UI: ShownByDefault
ObjectVersion
The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
ResourceId
The unique identifier of the translated resource. Should use ASCII/English chars only. Shorter strings are suggested. Depending on Text_Type: T:TableName; C:ColumnName; H:TableName.ColumnName; E,M,S: Application specific code. Required
Filter(eq;like)
Type: string (800)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 800
Show in UI: ShownByDefault
ResourceType
T=Table (entity) Name; C=Column Name; H=Column Hint; R=Meta Resource; E=Error; M=Message; S=Other application specific String. Required
Default("S")
Filter(eq)
Type: ResourceType
Category: System
Allowed values for the ResourceType
(Systems.Config.Translations.md#resourcetype) data attribute
Allowed Values (Systems.Config.TranslationsRepository.ResourceType Enum Members)
Value | Description |
---|---|
TableName | TableName value. Stored as 'T'. Database Value: 'T' Model Value: 0 Domain API Value: 'TableName' |
ColumnName | ColumnName value. Stored as 'C'. Database Value: 'C' Model Value: 1 Domain API Value: 'ColumnName' |
ColumnHint | ColumnHint value. Stored as 'H'. Database Value: 'H' Model Value: 2 Domain API Value: 'ColumnHint' |
MetaResource | MetaResource value. Stored as 'R'. Database Value: 'R' Model Value: 3 Domain API Value: 'MetaResource' |
ErrorMessage | ErrorMessage value. Stored as 'E'. Database Value: 'E' Model Value: 4 Domain API Value: 'ErrorMessage' |
Message | Message value. Stored as 'M'. Database Value: 'M' Model Value: 5 Domain API Value: 'Message' |
OtherApplicationSpecific | OtherApplicationSpecific value. Stored as 'S'. Database Value: 'S' Model Value: 6 Domain API Value: 'OtherApplicationSpecific' |
Supported Filters: Equals
Supports Order By: False
Default Value: OtherApplicationSpecific
Show in UI: ShownByDefault
TranslationField
The translated text. Required
Type: string (max)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault
UpdateTime
When the translation was last updated. Required
Default(Now)
Filter(ge;le)
ReadOnly
Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: ShownByDefault
API Methods
Methods that can be invoked in public APIs.
GetAllowedCustomPropertyValues
Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET
Parameters
customPropertyCode
The code of the custom property
Type: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0
CreateNotification
Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST
Parameters
user
The user.
Type: UsersnotificationClass
The notification class.
Type: stringsubject
The notification subject.
Type: string
CreateCopy
Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST
Business Rules
None
Front-End Business Rules
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Config_Translations?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Config_Translations?$top=10