Systems.Security.AccessKeys Entity

Namespace: Systems.Security

Access keys provide the basic locking mechanism for data security. Each record can be secured by specifying an access key. Then the users are given access to access keys through groups. Entity: Sec_Access_Keys

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: SystemData
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track 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.AccessKeys

Attributes

Name	Type	Description
Code	string (16) nullable	Unique code for the access key. The codes can be null for legacy keys or entities that do not support codes. The codes are unique only among non-null entries. `Filter(eq;like)` `ORD`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EntityId	guid nullable	The field stores the Id of the entity that the key was created from. `Filter(multi eq)` `Introduced in version 25.1.1.32`
EntityName	string (64) nullable	What entitity the key secures. Can be null for private, legacy keys. `Filter(eq;like)` `ORD`
Id	guid
Name	MultilanguageString (1024) nullable	Multilanguage descriptive name of the security key. Can be null for legacy keys. `Filter(eq;like)`
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.
ShareLevel	ShareLevel	Specifies the extent to which the key can be shared among multiple entities. `Required` `Default("PRI")` `Filter(eq)` `Introduced in version 25.1.1.32`

Attribute Details

Code

Unique code for the access key. The codes can be null for legacy keys or entities that do not support codes. The codes are unique only among non-null entries. Filter(eq;like) ORD

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

Back-End Default Expression:
obj.IncMax( o => o.Code, o => ( o.EntityName == obj.EntityName), "00000")

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

EntityId

The field stores the Id of the entity that the key was created from. Filter(multi eq) Introduced in version 25.1.1.32

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

EntityName

What entitity the key secures. Can be null for private, legacy keys. Filter(eq;like) ORD

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

Id

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

Name

Multilanguage descriptive name of the security key. Can be null for legacy keys. Filter(eq;like)

Type: MultilanguageString (1024) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
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

ShareLevel

Specifies the extent to which the key can be shared among multiple entities. Required Default("PRI") Filter(eq) Introduced in version 25.1.1.32

Type: ShareLevel
Category: System
Allowed values for the ShareLevel(Systems.Security.AccessKeys.md#sharelevel) data attribute
Allowed Values (Systems.Security.AccessKeysRepository.ShareLevel Enum Members)

Value	Description
Private	The key is private to the entity.. Stored as 'PRI'. Database Value: 'PRI' Model Value: 0 Domain API Value: 'Private'
Referenceable	The key can be referenced from other entities.. Stored as 'RFA'. Database Value: 'RFA' Model Value: 1 Domain API Value: 'Referenceable'
Referencing	The access permissions of the selected object are applied.. Stored as 'RFI'. Database Value: 'RFI' Model Value: 2 Domain API Value: 'Referencing'
Inheriting	The access permissions of the parent object are inherited.. Stored as 'IHI'. Database Value: 'IHI' Model Value: 3 Domain API Value: 'Inheriting'
Shared	The key is not specific to any entity.. Stored as 'SHA'. Database Value: 'SHA' Model Value: 4 Domain API Value: 'Shared'

Supported Filters: Equals
Supports Order By: False
Default Value: Private
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