Systems.Security.EntitySettings Entity

Namespace: Systems.Security

Contains entities, which have secured access. Entity: Sys_Entities

Renames

Old name: Systems.Core.EntitySettings
New name: Systems.Security.EntitySettings
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Track Changes

Min level: 3 - Track object and attribute changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

• Systems.Security.EntitySettings

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DisplayTextFormat	string (128) nullable	Interpolated string, containing the default format for displaying values of the entity. null means to use the system-wide default. Introduced in version 22.1.4.18
Id	guid
LogCreate	boolean	Specifies whether to log every insert for this entity. Required Default(false) Introduced in version 18.2
LogDelete	boolean	Specifies whether to log every delete for this entity. Required Default(false) Introduced in version 18.2
LogReadById	boolean	Specifies whether to log every load by Id for this entity. Required Default(false) Introduced in version 18.2
LogReadMany	boolean	Specifies whether to log every load of many records for this entity. Required Default(false) Introduced in version 18.2
LogUpdate	boolean	Specifies whether to log every update for this entity. Required Default(false) Introduced in version 18.2
Name	string (64)	The system name of the entity, which is being secured. Required Filter(eq;like) ORD
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.
TrackChangesLevel	TrackChangesLevel	The track changes level for the entity. Required Default(0) Filter(multi eq) Introduced in version 19.1

References

Name	Type	Description
AccessKey	AccessKeys (nullable)	The access key, required to access the secured entity. Filter(multi eq)

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

DisplayTextFormat

Interpolated string, containing the default format for displaying values of the entity. null means to use the system-wide default. Introduced in version 22.1.4.18

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

Id

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

LogCreate

Specifies whether to log every insert for this entity. Required Default(false) Introduced in version 18.2

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

LogDelete

Specifies whether to log every delete for this entity. Required Default(false) Introduced in version 18.2

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

LogReadById

Specifies whether to log every load by Id for this entity. Required Default(false) Introduced in version 18.2

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

LogReadMany

Specifies whether to log every load of many records for this entity. Required Default(false) Introduced in version 18.2

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

LogUpdate

Specifies whether to log every update for this entity. Required Default(false) Introduced in version 18.2

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Name

The system name of the entity, which is being secured. Required Filter(eq;like) ORD

Type: string (64)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 64
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

TrackChangesLevel

The track changes level for the entity. Required Default(0) Filter(multi eq) Introduced in version 19.1

Type: TrackChangesLevel
Category: System
Represents the different levels of tracking changes for a specific entity.
Allowed Values (Core.TrackChangesLevel Enum Members)

Value	Description
DoNotTrackChanges	The do not track changes for this entity. Database Value: 0 Model Value: 0 Domain API Value: 'DoNotTrackChanges'
TrackLastChangesOnly	The track last changes only: creation time, creation user, last update time, last update user. Database Value: 1 Model Value: 1 Domain API Value: 'TrackLastChangesOnly'
TrackObjectChanges	Only object changes are tracked. The changed attributes are not tracked. Database Value: 2 Model Value: 2 Domain API Value: 'TrackObjectChanges'
TrackObjectAnd AttributeChanges	Object and attribute changes are tracked excluding BLOB attributes. Database Value: 3 Model Value: 3 Domain API Value: 'TrackObjectAnd AttributeChanges'
TrackObjectAttribute AndBlobChanges	Object and attribute changes are tracked including BLOB attributes. Database Value: 4 Model Value: 4 Domain API Value: 'TrackObjectAttribute AndBlobChanges'

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

Reference Details

AccessKey

The access key, required to access the secured entity. Filter(multi eq)

Type: AccessKeys (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown

Remarks
Supported permissions

Permission	Type
Update	-
Delete	-
Administer (manage security)	-
Open a form	Permission1
Opena a navigator	Permission2

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

Parameters

• user
  The user.
  Type: Users

• notificationClass
  The notification class.
  Type: string

• subject
  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

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Security_EntitySettings?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Security_EntitySettings?$top=10