Systems.Security.Groups Entity

Namespace: Systems.Security

Groups of users. Used for providing group access to secured data. Entity: Sec_Groups

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Name
Name Data Member:
Name
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.
EditPeriodDays int32 nullable The number of days before which the documents can not be corrected, released or voided.
GroupType GroupType Group type. G=Normal user-definable group; U=System group for 1 user; A=Admin; E=Everybody. Required Default("G") ReadOnly
Id guid
Name MultilanguageString (254) The name of this Group. Required Filter(like) ORD
Notes string (254) nullable Notes for this Group.
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
GroupForUser Users (nullable) When Group_Type=U, contains the user for which the group is defined, null otherwise. Filter(multi eq) ReadOnly

Child Collections

Name Type Description
AccessKeys GroupAccessKeys List of GroupAccessKey(Systems.Security.GroupAccessKeys.md) child objects, based on the Systems.Security.GroupAccessKey.Group(Systems.Security.GroupAccessKeys.md#group) back reference

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

EditPeriodDays

The number of days before which the documents can not be corrected, released or voided.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

GroupType

Group type. G=Normal user-definable group; U=System group for 1 user; A=Admin; E=Everybody. Required Default("G") ReadOnly

Type: GroupType
Category: System
Allowed values for the GroupType(Systems.Security.Groups.md#grouptype) data attribute
Allowed Values (Systems.Security.GroupsRepository.GroupType Enum Members)

Value Description
NormalUserDefinableGroup NormalUserDefinableGroup value. Stored as 'G'.
Database Value: 'G'
Model Value: 0
Domain API Value: 'NormalUserDefinableGroup'
SystemGroupForOneUser SystemGroupForOneUser value. Stored as 'U'.
Database Value: 'U'
Model Value: 1
Domain API Value: 'SystemGroupForOneUser'
Administrators Administrators value. Stored as 'A'.
Database Value: 'A'
Model Value: 2
Domain API Value: 'Administrators'
Everybody Everybody value. Stored as 'E'.
Database Value: 'E'
Model Value: 3
Domain API Value: 'Everybody'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: NormalUserDefinableGroup
Show in UI: ShownByDefault

Id

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

Name

The name of this Group. Required Filter(like) ORD

Type: MultilanguageString (254)
Category: System
Supported Filters: Like
Supports Order By: True
Show in UI: ShownByDefault

Notes

Notes for this Group.

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

Reference Details

GroupForUser

When Group_Type=U, contains the user for which the group is defined, null otherwise. Filter(multi eq) ReadOnly

Type: Users (nullable)
Indexed: True
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

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: Users

  • notificationClass
    The notification class.
    Type: string

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

None

Front-End Business Rules

None

API

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

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