Crm.Pos.Operators Entity

Namespace: Crm.Pos

Represents one operator (person) in one POS location. Entity: Pos_Operators (Introduced in version 19.1)

Default Visualization

Default Display Text Format:
{PosOperatorCode}
Default Search Members:
PosOperatorCode
Code Data Member:
PosOperatorCode
Category: Definitions
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

Crm.Pos.Operators

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
IsActive	boolean	Indicates whether this operator is active and can be chosen for new records. `Required` `Default(true)` `Filter(multi eq)`
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.
PosOperatorCode	string (16)	Operator code. Unique within the Pos Location. `Required` `Filter(multi eq;like)` `ORD`
StartingDate	date	The first date, when the operator has started working for this POS location. `Required` `Filter(multi eq;ge;le)`
TerminationDate	date nullable	The date, when the operator has ceased working in this POS location. null means, that the operator is still working or the termination date is still unknown. `Filter(multi eq;ge;le)`

References

Name	Type	Description
DefaultPosTerminal	Terminals (nullable)	The default POS terminal for this opertor. null when there is no default. `Filter(multi eq)`
PosLocation	Locations	The POS location where this operator works. `Required` `Filter(multi eq)`
PosRole	Roles	The role, assigned to the operator. The role indicates the permissions of the operator for this POS location. `Required` `Filter(multi eq)`
User	Users	The login user for this POS operator. `Required` `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

Id

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

IsActive

Indicates whether this operator is active and can be chosen for new records. Required Default(true) Filter(multi eq)

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

PosOperatorCode

Operator code. Unique within the Pos Location. Required Filter(multi eq;like) ORD

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

StartingDate

The first date, when the operator has started working for this POS location. Required Filter(multi eq;ge;le)

Type: date
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

TerminationDate

The date, when the operator has ceased working in this POS location. null means, that the operator is still working or the termination date is still unknown. Filter(multi eq;ge;le)

Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

DefaultPosTerminal

The default POS terminal for this opertor. null when there is no default. Filter(multi eq)

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

PosLocation

The POS location where this operator works. Required Filter(multi eq)

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

PosRole

The role, assigned to the operator. The role indicates the permissions of the operator for this POS location. Required Filter(multi eq)

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

User

The login user for this POS operator. Required Filter(multi eq)

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