Logistics.Wms.WarehouseWorkers Entity

Namespace: Logistics.Wms

Human or robot worker, which can execute warehouse tasks. Entity: Wms_Warehouse_Workers (Introduced in version 22.1.6.31)

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Name
Name Data Member:
Name
Category: Definitions
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 Parent:
Logistics.Wms.Warehouses
Aggregate Root:
Logistics.Wms.Warehouses

Attributes

Name	Type	Description
ActiveFrom	date	The date, from which the worker record has become active in the warehouse. `Required` `Default(Today)` `Filter(eq;ge;le)`
ActiveTo	date nullable	The date of termination of the activity of the worker in the warehouse. Can be null for workers, which are still active and do not have previous terminations. `Filter(eq;ge;le)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsActive	boolean	Specifies whether the worker is active and can execute new warehouse tasks. `Required` `Default(true)` `Filter(eq)`
Name	MultilanguageString (254)	Name of the worker (multi-language). `Required` `Filter(multi eq;like)`
Notes	string (max) nullable	Notes for this WarehouseWorker.
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
Person	Persons (nullable)	The definition of the person, when the worker is human worker. null means that the person is unknown or the worker is non-person. `Filter(multi eq)` `ReadOnly`
User	Users (nullable)	The user who is going to work in the selected warehouse. `Filter(multi eq)` `Introduced in version 24.1.5.0`
Warehouse	Warehouses	The warehouse, where the worker works. `Required` `Filter(multi eq)` `Owner`

Attribute Details

ActiveFrom

The date, from which the worker record has become active in the warehouse. Required Default(Today) Filter(eq;ge;le)

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

ActiveTo

The date of termination of the activity of the worker in the warehouse. Can be null for workers, which are still active and do not have previous terminations. Filter(eq;ge;le)

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

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

Specifies whether the worker is active and can execute new warehouse tasks. Required Default(true) Filter(eq)

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

Name

Name of the worker (multi-language). Required Filter(multi eq;like)

Type: MultilanguageString (254)
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Notes

Notes for this WarehouseWorker.

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

Person

The definition of the person, when the worker is human worker. null means that the person is unknown or the worker is non-person. Filter(multi eq) ReadOnly

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

User

The user who is going to work in the selected warehouse. Filter(multi eq) Introduced in version 24.1.5.0

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

Warehouse

The warehouse, where the worker works. Required Filter(multi eq) Owner

Type: Warehouses
Indexed: True
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

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