Systems.Workflow.RoleUsers Entity

The roles "played" by the security users. Entity: Wf_Role_Users

Default Visualization

Default Display Text Format:
{User.Name:T}
Default Search Members:
User.Name
Name Data Member:
User.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 Parent:
Systems.Security.Users
Aggregate Root:
Systems.Security.Users

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
IsLayoutAdmin	boolean	Specifies whether the user can manage the layouts for the role. `Required` `Default(false)` `Filter(eq)` `Introduced in version 23.1.2.58`
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
CompanyLocation	CompanyLocations (nullable)	Specifies the Enterprise Company Location of the selected role. Null means that role is valid for all locations belonging to the Enterprise Company. `Filter(multi eq)` `Introduced in version 23.1.2.11`
EnterpriseCompany	EnterpriseCompanies (nullable)	Specifies the Enterprise Company of the selected role. Null means that the role is valid for all Enterprise Companiеs. `Filter(multi eq)` `Introduced in version 23.1.2.11`
Role	Roles	The role, played by the user. `Required` `Filter(multi eq)`
User	Users	The user, which plays the role. `Required` `Filter(multi eq)` `Owner`

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

IsLayoutAdmin

Specifies whether the user can manage the layouts for the role. Required Default(false) Filter(eq) Introduced in version 23.1.2.58

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: 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

Reference Details

CompanyLocation

Specifies the Enterprise Company Location of the selected role. Null means that role is valid for all locations belonging to the Enterprise Company. Filter(multi eq) Introduced in version 23.1.2.11

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

EnterpriseCompany

Specifies the Enterprise Company of the selected role. Null means that the role is valid for all Enterprise Companiеs. Filter(multi eq) Introduced in version 23.1.2.11

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

Role

The role, played by the user. Required Filter(multi eq)

Type: Roles
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

User

The user, which plays the role. Required Filter(multi eq) Owner

Type: Users
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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