Logistics.Wms.WarehousePolicies Entity

Namespace: Logistics.Wms

Warehouse Policies is a hierarchical system for applying policies to warehouse operations. Entity: Wms_Warehouse_Policies (Introduced in version 22.1.4.23)

Default Visualization

Default Display Text Format:
{Warehouse} {Code}
Default Search Members:
Code; Warehouse.Name
Code Data Member:
Code
Name Data Member:
Warehouse.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
Code	string (16)	The unique code of the warehouse policy. `Required` `Introduced in version 22.1.6.60`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate	date nullable	When set, specifies the activation date of the policy. `Filter(eq;ge;le)`
Id	guid
Importance	int32	The importance of the policy, relative to other applicable policies. Higher numbers indicate higher importance. `Required` `Default(0)` `Filter(eq;ge;le)`
Note	string (max) nullable	Notes.
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.
PolicyKind	PolicyKind	The kind of policy, which is being applied. `Required` `Filter(multi eq)`
ToDate	date nullable	When set, specifies the de-activation date of the policy. `Filter(eq;ge;le)`
Value	string (64)	The value specified for the policy. For boolean policies, allowed values are "true" and "false". `Required` `Filter(eq;ge;le)`

References

Name	Type	Description
Product	Products (nullable)	When set, specifies that the policy will apply to the specified product only. `Filter(multi eq)`
ProductGroup	ProductGroups (nullable)	When set, specifies that the policy will apply to the specified product group only. `Filter(multi eq)` `Introduced in version 22.1.4.36`
ProductType	ProductTypes (nullable)	When set, specifies that the policy will apply to the specified product type only. `Filter(multi eq)`
Warehouse	Warehouses	The warehouse for which the policy is defined. . `Required` `Filter(multi eq)` `ReadOnly` `Owner`
Zone	WarehouseZones (nullable)	When set, specifies that the policy will apply to the specified zone and its sub-zones. `Filter(multi eq)`

Attribute Details

Code

The unique code of the warehouse policy. Required Introduced in version 22.1.6.60

Type: string (16)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault

Back-End Default Expression:
obj.GetNextDefaultCode( )

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

FromDate

When set, specifies the activation date of the policy. Filter(eq;ge;le)

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

Id

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

Importance

The importance of the policy, relative to other applicable policies. Higher numbers indicate higher importance. Required Default(0) Filter(eq;ge;le)

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

Note

Notes.

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

PolicyKind

The kind of policy, which is being applied. Required Filter(multi eq)

Type: PolicyKind
Category: System
Allowed values for the PolicyKind(Logistics.Wms.WarehousePolicies.md#policykind) data attribute
Allowed Values (Logistics.Wms.WarehousePoliciesRepository.PolicyKind Enum Members)

Value	Description
AllowLineSkip	Allow skipping of an order line when executing (allow quantity = 0). Stored as 'ALS'. Database Value: 'ALS' Model Value: 0 Domain API Value: 'AllowLineSkip'
AllowLocationChange	Allow executing from a different location than the ordered.. Stored as 'ALC'. Database Value: 'ALC' Model Value: 1 Domain API Value: 'AllowLocationChange'
AllowLotChange	Allow executing with a different lot than the ordered.. Stored as 'ATC'. Database Value: 'ATC' Model Value: 2 Domain API Value: 'AllowLotChange'
AllowProductChange	Allow executing with а different product than the ordered.. Stored as 'APC'. Database Value: 'APC' Model Value: 3 Domain API Value: 'AllowProductChange'
AllowUnitChange	Allow executing of a quantity in a different measurement unit than the ordered.. Stored as 'AUC'. Database Value: 'AUC' Model Value: 4 Domain API Value: 'AllowUnitChange'
DekittingControllingLevel	Specifies the level of control during the dekitting of the composite product.. Stored as 'DCL'. Database Value: 'DCL' Model Value: 5 Domain API Value: 'DekittingControllingLevel'
GS1SSCCCompanyPrefix	Specifies the GS1 company prefix issued by the national GS1 organization. A digit number used when generating SSCC codes.. Stored as 'GCP'. Database Value: 'GCP' Model Value: 6 Domain API Value: 'GS1SSCCCompanyPrefix'
GS1SSCCNextSerial	Specifies the next reference serial number used when generating SSCC codes. А digit number acting as a counter: e.g. 0000001, 0000002… .. Stored as 'GNS'. Database Value: 'GNS' Model Value: 7 Domain API Value: 'GS1SSCCNextSerial'
KittingControllingLevel	Specifies the level of control during the kitting of the composite product’s components.. Stored as 'KCL'. Database Value: 'KCL' Model Value: 8 Domain API Value: 'KittingControllingLevel'
RequireDestinationScan	Require scanning of the destination location when moving/receiving. Stored as 'RDS'. Database Value: 'RDS' Model Value: 9 Domain API Value: 'RequireDestinationScan'
RequireProductScan	Require scanning of the product. Stored as 'RPS'. Database Value: 'RPS' Model Value: 10 Domain API Value: 'RequireProductScan'
RequireSourceScan	Require scanning of the source location when moving/dispatching. Stored as 'RSS'. Database Value: 'RSS' Model Value: 11 Domain API Value: 'RequireSourceScan'
ZoneType	Specifies the type of zone. Eg for receiving, shipping, packing, etc.. Stored as 'ZTY'. Database Value: 'ZTY' Model Value: 12 Domain API Value: 'ZoneType'
CustomRouting	Specifies a custom routing, based on a user-defined attribute of the locations. The policy specifies the code of the user-defined attribute, whose values contain the sequence of the route. The custom routing is employed by the Suggest Routing function and can be defined only at warehouse level.. Stored as 'CRO'. Database Value: 'CRO' Model Value: 13 Domain API Value: 'CustomRouting'
UnassignedOrders SectionVisibility	Show or hide the Unassigned Orders section in the warehouse orders list.. Stored as 'UOS'. Database Value: 'UOS' Model Value: 14 Domain API Value: 'UnassignedOrders SectionVisibility'
StartedByOthers SectionVisibility	Show or hide the Started by Others section in the warehouse orders list.. Stored as 'SOS'. Database Value: 'SOS' Model Value: 15 Domain API Value: 'StartedByOthers SectionVisibility'
AssignedToOthers SectionVisibility	Show or hide the Assign to Others section in the warehouse orders list.. Stored as 'AOS'. Database Value: 'AOS' Model Value: 16 Domain API Value: 'AssignedToOthers SectionVisibility'
LogisticUnitScreen Visibility	Always show, hide, or use the default behavior on the logistic unit screen when executing warehouse order lines.. Stored as 'LUS'. Database Value: 'LUS' Model Value: 17 Domain API Value: 'LogisticUnitScreen Visibility'
BarcodeScanEnters QuantityOfOnePce	If no quantity is entered, scanning a barcode in the SCAN field enters 1 PCE.. Stored as 'QOP'. Database Value: 'QOP' Model Value: 18 Domain API Value: 'BarcodeScanEnters QuantityOfOnePce'
RoutingAlgorithm	RoutingAlgorithm value. Stored as 'RAL'. Database Value: 'RAL' Model Value: 19 Domain API Value: 'RoutingAlgorithm'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

ToDate

When set, specifies the de-activation date of the policy. Filter(eq;ge;le)

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

Value

The value specified for the policy. For boolean policies, allowed values are "true" and "false". Required Filter(eq;ge;le)

Type: string (64)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Reference Details

Product

When set, specifies that the policy will apply to the specified product only. Filter(multi eq)

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

ProductGroup

When set, specifies that the policy will apply to the specified product group only. Filter(multi eq) Introduced in version 22.1.4.36

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

ProductType

When set, specifies that the policy will apply to the specified product type only. Filter(multi eq)

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

Warehouse

The warehouse for which the policy is defined. . Required Filter(multi eq) ReadOnly Owner

Type: Warehouses
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

Zone

When set, specifies that the policy will apply to the specified zone and its sub-zones. Filter(multi eq)

Type: WarehouseZones (nullable)
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