Systems.Monitoring.AuditLogEntries Entity

Each record represents the occurrence of one logged event. Entity: Sys_Audit_Log_Entries (Introduced in version 18.2)

Renames

Old name: Systems.Core.AuditLogEntries
New name: Systems.Monitoring.AuditLogEntries
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{ApplicationName}
Default Search Members:
ApplicationName
Name Data Member:
ApplicationName
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

Systems.Monitoring.AuditLogEntries

Attributes

Name	Type	Description
ApplicationName	string (64) nullable	The client application that triggered the event. Null when unknown or N/A. `Filter(eq;like)`
Details	string (max) nullable	Detailed contents of the event. Contents depend on the Event Type and Event Name.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EntityItemId	guid nullable	The Id of the record, which is referenced by the event. Null when unknown or N/A. `Filter(multi eq)`
EntityName	string (64) nullable	The entity, which is being referenced by the event. Null when unknown or N/A. `Filter(eq;like)`
EventClass	EventClass	The event primary classification, which shows the source of the event. E=Entity methods; A=Auth events; S=Server events. `Required` `Filter(multi eq)`
EventName	string (128) nullable	Specific event or method name. Contents depend on the Event Type. Null when N/A. `Filter(eq;like)`
EventTimeUtc	datetime	The exact date and time (in Utc) when the event occurred. `Required` `Default(Now)` `Filter(ge;le)` `ORD`
EventType	EventType	Detailed action type. EID=Read one record by Id; ELD=Load many records; EUP=Update data; EDE=Delete record; EMT=Call method; ETH=Other entity event; AIN=Login; AOU=Log out; AUP=Sign Up; AFL=Login failed; APW=Change password; ATH=Other auth event; STH=Other server event. `Required` `Filter(multi eq)`
Id	guid
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.

References

Name	Type	Description
PersonalDataProcess	PersonalDataProcesses (nullable)	The personal data process, which was used to process the data, referenced by the event. Null when unknown or N/A. `Filter(multi eq)`
User	Users (nullable)	The user account under which the event has occurred. Null only for events which are not user-specific. `Filter(multi eq)`

Attribute Details

ApplicationName

The client application that triggered the event. Null when unknown or N/A. Filter(eq;like)

Type: string (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Details

Detailed contents of the event. Contents depend on the Event Type and Event Name.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
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

EntityItemId

The Id of the record, which is referenced by the event. Null when unknown or N/A. Filter(multi eq)

Type: guid nullable
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

EntityName

The entity, which is being referenced by the event. Null when unknown or N/A. Filter(eq;like)

Type: string (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

EventClass

The event primary classification, which shows the source of the event. E=Entity methods; A=Auth events; S=Server events. Required Filter(multi eq)

Type: EventClass
Category: System
Allowed values for the EventClass(Systems.Monitoring.AuditLogEntries.md#eventclass) data attribute
Allowed Values (Systems.Monitoring.AuditLogEntriesRepository.EventClass Enum Members)

Value	Description
Entity	Entity value. Stored as 'E'. Database Value: 'E' Model Value: 0 Domain API Value: 'Entity'
Authentication	Authentication value. Stored as 'A'. Database Value: 'A' Model Value: 1 Domain API Value: 'Authentication'
Server	Server value. Stored as 'S'. Database Value: 'S' Model Value: 2 Domain API Value: 'Server'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

EventName

Specific event or method name. Contents depend on the Event Type. Null when N/A. Filter(eq;like)

Type: string (128) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

EventTimeUtc

The exact date and time (in Utc) when the event occurred. Required Default(Now) Filter(ge;le) ORD

Type: datetime
Indexed: True
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDateTime
Show in UI: ShownByDefault

EventType

Detailed action type. EID=Read one record by Id; ELD=Load many records; EUP=Update data; EDE=Delete record; EMT=Call method; ETH=Other entity event; AIN=Login; AOU=Log out; AUP=Sign Up; AFL=Login failed; APW=Change password; ATH=Other auth event; STH=Other server event. Required Filter(multi eq)

Type: EventType
Category: System
Allowed values for the EventType(Systems.Monitoring.AuditLogEntries.md#eventtype) data attribute
Allowed Values (Systems.Monitoring.AuditLogEntriesRepository.EventType Enum Members)

Value	Description
ReadOneRecordById	ReadOneRecordById value. Stored as 'EID'. Database Value: 'EID' Model Value: 0 Domain API Value: 'ReadOneRecordById'
LoadManyRecords	LoadManyRecords value. Stored as 'ELD'. Database Value: 'ELD' Model Value: 1 Domain API Value: 'LoadManyRecords'
CreateRecord	CreateRecord value. Stored as 'ECR'. Database Value: 'ECR' Model Value: 2 Domain API Value: 'CreateRecord'
UpdateData	UpdateData value. Stored as 'EUP'. Database Value: 'EUP' Model Value: 3 Domain API Value: 'UpdateData'
DeleteRecord	DeleteRecord value. Stored as 'EDE'. Database Value: 'EDE' Model Value: 4 Domain API Value: 'DeleteRecord'
CallMethod	CallMethod value. Stored as 'EMT'. Database Value: 'EMT' Model Value: 5 Domain API Value: 'CallMethod'
OtherEntityEvent	OtherEntityEvent value. Stored as 'ETH'. Database Value: 'ETH' Model Value: 6 Domain API Value: 'OtherEntityEvent'
Login	Login value. Stored as 'AIN'. Database Value: 'AIN' Model Value: 7 Domain API Value: 'Login'
LogOut	LogOut value. Stored as 'AOU'. Database Value: 'AOU' Model Value: 8 Domain API Value: 'LogOut'
SignUp	SignUp value. Stored as 'AUP'. Database Value: 'AUP' Model Value: 9 Domain API Value: 'SignUp'
LoginFailed	LoginFailed value. Stored as 'AFL'. Database Value: 'AFL' Model Value: 10 Domain API Value: 'LoginFailed'
ChangePassword	ChangePassword value. Stored as 'APW'. Database Value: 'APW' Model Value: 11 Domain API Value: 'ChangePassword'
OtherAuthEvent	OtherAuthEvent value. Stored as 'ATH'. Database Value: 'ATH' Model Value: 12 Domain API Value: 'OtherAuthEvent'
OtherServerEvent	OtherServerEvent value. Stored as 'STH'. Database Value: 'STH' Model Value: 13 Domain API Value: 'OtherServerEvent'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: HiddenByDefault

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

Reference Details

PersonalDataProcess

The personal data process, which was used to process the data, referenced by the event. Null when unknown or N/A. Filter(multi eq)

Type: PersonalDataProcesses (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

User

The user account under which the event has occurred. Null only for events which are not user-specific. Filter(multi eq)

Type: Users (nullable)
Category: System
Supported Filters: Equals, EqualsIn
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: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
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