Systems.Core.InformationMessages Entity
Namespace: Systems.Core
Contains information messages, generated by various system processes. Entity: Sys_Information_Messages
Default Visualization
Default Display Text Format:
{MachineName}
Default Search Members:
MachineName
Name Data Member:
MachineName
Category: Definitions
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 |
---|---|---|
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
Id | guid | |
InformationMessageTime | datetime | Date and time when thet message occurred. Required Default(Now) Filter(ge;le) ORD ReadOnly |
InformationMessageType | InformationMessageType | Type of the information message: 'INF' = Information, 'WRN' = Warning, Error = 'ERR'. Required Default("INF") Filter(multi eq) ReadOnly |
MachineName | string (128) | Machine name of the computer from which the process which creates the message has been initiated. Required ReadOnly |
Message | string (max) | The actual content of the information message. Required Filter(like) ReadOnly |
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. |
ProcessDescription | string (254) | Name or description of the process that creates the message. Required Filter(eq;like) ReadOnly |
URL | string (254) nullable | URL of the record that has posted the information message. Filter(eq) |
UserName | string (128) | Login name of the user that has initiated the process which creates the message. Required Filter(eq) ReadOnly |
Attribute Details
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
InformationMessageTime
Date and time when thet message occurred. Required
Default(Now)
Filter(ge;le)
ORD
ReadOnly
Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDateTime
Show in UI: ShownByDefault
InformationMessageType
Type of the information message: 'INF' = Information, 'WRN' = Warning, Error = 'ERR'. Required
Default("INF")
Filter(multi eq)
ReadOnly
Type: InformationMessageType
Category: System
Allowed values for the InformationMessageType
(Systems.Core.InformationMessages.md#informationmessagetype) data attribute
Allowed Values (Systems.Core.InformationMessagesRepository.InformationMessageType Enum Members)
Value | Description |
---|---|
Information | Information value. Stored as 'INF'. Database Value: 'INF' Model Value: 0 Domain API Value: 'Information' |
Warning | Warning value. Stored as 'WRN'. Database Value: 'WRN' Model Value: 1 Domain API Value: 'Warning' |
Error | Return error message for the Action Field.. Stored as 'ERR'. Database Value: 'ERR' Model Value: 2 Domain API Value: 'Error' |
Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: Information
Show in UI: ShownByDefault
MachineName
Machine name of the computer from which the process which creates the message has been initiated. Required
ReadOnly
Type: string (128)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault
Message
The actual content of the information message. Required
Filter(like)
ReadOnly
Type: string (max)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 2147483647
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
ProcessDescription
Name or description of the process that creates the message. Required
Filter(eq;like)
ReadOnly
Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault
URL
URL of the record that has posted the information message. Filter(eq)
Type: string (254) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault
UserName
Login name of the user that has initiated the process which creates the message. Required
Filter(eq)
ReadOnly
Type: string (128)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 128
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
Creates a notification and sends 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 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
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Core_InformationMessages?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Core_InformationMessages?$top=10