Table of Contents

Production.ShopFloor.WorkOrderItems Entity

Namespace: Production.ShopFloor

The different items that are produced with a work order. Entity: Prd_Work_Order_Items

Default Visualization

Default Display Text Format:
{LineOrd}. {WorkOrder.DocumentNo} {WorkOrder.DocumentType.TypeName:T}
Default Search Members:
WorkOrder.DocumentNo
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:
Production.ShopFloor.WorkOrders
Aggregate Root:
Production.ShopFloor.WorkOrders

Attributes

Name Type Description
CompletionDate datetime nullable The date, when the item should be completed. null means that there is no constraint for completion date. Filter(ge;le)
CurrentBalanceBase Quantity The current balance of the product in the selected store and enterprise company. If lot, serial number or product variant are specified the quantity is calculated accordingly.
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
LineOrd int32 The order of the line within the work order. Required Filter(eq;like)
LotSize Quantity (18, 3) Quantity produced in one production run. Unit: ProducedQuantityUnit Required Default(1)
Notes string (max) nullable Notes for this WorkOrderItem.
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.
ParentLineId guid nullable If not null contains the Id of the line of the parent document, that created the current row. Filter(multi eq)
ParentLineNo int32 nullable The number of the line within the parent document, which the current line executes. null when the current line does not execute another line. Filter(eq)
Priority Priority Priority of the production of the item. Initially inherits the priority of the work order. 1=Lowest ... 5=Highest. Required Default(3)
ProducedQuantity Quantity (18, 3) The quantity produced in the operation. Unit: ProducedQuantityUnit Required Default(1)
ProducedQuantityBase Quantity (18, 3) The equivalence of Produced Quantity in the base measurement category of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required ReadOnly
ProducedStandard
QuantityBase		 Quantity (18, 3) The theoretical quantity in base measurement unit according to the current measurement dimensions of the product. Used to measure the execution. null means to take the value from Produced Quantity Base. Unit: Product.BaseMeasurementCategory.BaseUnit Required ReadOnly Introduced in version 18.2
ReleaseDate datetime nullable The date, when the item is released to production. null means that still there is no plan when the item will be released to production. Filter(ge;le)
ScheduledEndDateTime datetime nullable Date and time when the production of this item is scheduled to end. Filter(ge;le)
ScheduledStartDateTime datetime nullable Date and time when the production of this item is scheduled to begin. Filter(ge;le)

References

Name Type Description
Document WorkOrders The Id of the work order, containing the item. Required Filter(multi eq)
Lot Lots (nullable) The lot of the produced product. Filter(multi eq)
OutputStore Stores (nullable) Output store for the production. Filter(multi eq)
ParentDocument Documents (nullable) The document, which the current line executes. null when the current line does not execute another line. Filter(multi eq)
ProducedQuantityUnit MeasurementUnits The measurement unit of the quantity produced in the operation. Required Filter(multi eq)
Product Products The Id of the produced product. Required Filter(multi eq)
ProductCode ProductCodes (nullable) Selects the product thru some of the product codes. Filter(multi eq)
Recipe Recipes (nullable) The base recipe. null means that the item is produced without recipe. Filter(multi eq)
SerialNumber SerialNumbers (nullable) If not null, specifies that the product was (has to be) produced with specific serial number. Filter(multi eq)
StoreBin StoreBins (nullable) The store bin in which to store the products. Filter(multi eq)
WorkOrder WorkOrders The Id of the work order, containing the item. Required Filter(multi eq) Owner

Child Collections

Name Type Description
Operations WorkOrderItemOperations List of WorkOrderItemOperation(Production.ShopFloor.WorkOrderItemOperations.md) child objects, based on the Production.ShopFloor.WorkOrderItemOperation.WorkOrderItem(Production.ShopFloor.WorkOrderItemOperations.md#workorderitem) back reference

Attribute Details

CompletionDate

The date, when the item should be completed. null means that there is no constraint for completion date. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
obj.WorkOrder.CompletionDate

Front-End Recalc Expressions:
obj.WorkOrder.CompletionDate

CurrentBalanceBase

The current balance of the product in the selected store and enterprise company. If lot, serial number or product variant are specified the quantity is calculated accordingly.

Type: Quantity
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

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

LineOrd

The order of the line within the work order. Required Filter(eq;like)

Type: int32
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.WorkOrder.Items.Select( c => c.LineOrd).DefaultIfEmpty( 0).Max( ) + 10)

Front-End Recalc Expressions:
( obj.WorkOrder.Items.Select( c => c.LineOrd).DefaultIfEmpty( 0).Max( ) + 10)

LotSize

Quantity produced in one production run. Unit: ProducedQuantityUnit Required Default(1)

Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
new Quantity( obj.Recipe.ProduceQuantity.Value, obj.ProducedQuantity.Unit)

Notes

Notes for this WorkOrderItem.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: HiddenByDefault

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

ParentLineId

If not null contains the Id of the line of the parent document, that created the current row. Filter(multi eq)

Type: guid nullable
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown

ParentLineNo

The number of the line within the parent document, which the current line executes. null when the current line does not execute another line. Filter(eq)

Type: int32 nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: HiddenByDefault

Priority

Priority of the production of the item. Initially inherits the priority of the work order. 1=Lowest ... 5=Highest. Required Default(3)

Type: Priority
Category: System
Allowed values for the Priority(Production.ShopFloor.WorkOrderItems.md#priority) data attribute
Allowed Values (Production.ShopFloor.WorkOrderItemsRepository.Priority Enum Members)

Value Description
Lowest Lowest value. Stored as 1.
Database Value: 1
Model Value: 1
Domain API Value: 'Lowest'
Two Two value. Stored as 2.
Database Value: 2
Model Value: 2
Domain API Value: 'Two'
Three Three value. Stored as 3.
Database Value: 3
Model Value: 3
Domain API Value: 'Three'
Four Four value. Stored as 4.
Database Value: 4
Model Value: 4
Domain API Value: 'Four'
Highest Highest value. Stored as 5.
Database Value: 5
Model Value: 5
Domain API Value: 'Highest'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: 3
Show in UI: HiddenByDefault

ProducedQuantity

The quantity produced in the operation. Unit: ProducedQuantityUnit Required Default(1)

Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

Front-End Recalc Expressions:
new Quantity( obj.Recipe.ProduceQuantity.Value, obj.ProducedQuantity.Unit)

ProducedQuantityBase

The equivalence of Produced Quantity in the base measurement category of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required ReadOnly

Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
IIF( ( ( ( obj.ProducedQuantity != null) AndAlso ( obj.ProducedQuantityUnit != null)) AndAlso ( obj.Product != null)), obj.ProducedQuantity.ConvertTo( obj.Product.BaseUnit, obj.Product), obj.ProducedQuantityBase)

Front-End Recalc Expressions:
IIF( ( ( ( obj.ProducedQuantity != null) AndAlso ( obj.ProducedQuantityUnit != null)) AndAlso ( obj.Product != null)), obj.ProducedQuantity.ConvertTo( obj.Product.BaseUnit, obj.Product), obj.ProducedQuantityBase)

ProducedStandardQuantityBase

The theoretical quantity in base measurement unit according to the current measurement dimensions of the product. Used to measure the execution. null means to take the value from Produced Quantity Base. Unit: Product.BaseMeasurementCategory.BaseUnit Required ReadOnly Introduced in version 18.2

Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
IIF( ( ( ( obj.ProducedQuantity != null) AndAlso ( obj.ProducedQuantityUnit != null)) AndAlso ( obj.Product != null)), IIF( obj.Product.AllowVariableMeasurementRatios, obj.ProducedQuantity.ConvertTo( obj.Product.BaseUnit, obj.Product), obj.ProducedQuantityBase), obj.ProducedStandardQuantityBase)

Front-End Recalc Expressions:
IIF( ( ( ( obj.ProducedQuantity != null) AndAlso ( obj.ProducedQuantityUnit != null)) AndAlso ( obj.Product != null)), obj.ProducedQuantity.ConvertTo( obj.Product.BaseUnit, obj.Product), obj.ProducedStandardQuantityBase)

ReleaseDate

The date, when the item is released to production. null means that still there is no plan when the item will be released to production. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
obj.WorkOrder.ReleaseDate

Front-End Recalc Expressions:
obj.WorkOrder.ReleaseDate

ScheduledEndDateTime

Date and time when the production of this item is scheduled to end. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

ScheduledStartDateTime

Date and time when the production of this item is scheduled to begin. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

Reference Details

Document

The Id of the work order, containing the item. Required Filter(multi eq)

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

Lot

The lot of the produced product. Filter(multi eq)

Type: Lots (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Back-End Default Expression:
IIF( ( obj.Lot.Product != obj.Product), null, obj.Lot)

Front-End Recalc Expressions:
IIF( ( obj.Lot.Product != obj.Product), null, obj.Lot)

OutputStore

Output store for the production. Filter(multi eq)

Type: Stores (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Back-End Default Expression:
obj.WorkOrder.DefaultOutputStore

Front-End Recalc Expressions:
obj.WorkOrder.DefaultOutputStore

ParentDocument

The document, which the current line executes. null when the current line does not execute another line. Filter(multi eq)

Type: Documents (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

ProducedQuantityUnit

The measurement unit of the quantity produced in the operation. Required Filter(multi eq)

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

Back-End Default Expression:
obj.ProductCode.CodingSystem.DefaultMeasurementUnit.IfNullThen( obj.Product.MeasurementUnit.IfNullThen( obj.ProducedQuantityUnit))

Front-End Recalc Expressions:
obj.ProductCode.CodingSystem.DefaultMeasurementUnit.IfNullThen( obj.Product.MeasurementUnit.IfNullThen( obj.ProducedQuantityUnit))

Product

The Id of the produced product. Required Filter(multi eq)

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

Back-End Default Expression:
obj.ProductCode.Product.IfNullThen( obj.Product)

Front-End Recalc Expressions:
obj.ProductCode.Product.IfNullThen( obj.Product)

ProductCode

Selects the product thru some of the product codes. Filter(multi eq)

Type: ProductCodes (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Back-End Default Expression:
IIF( ( obj.ProductCode.Product != obj.Product), null, obj.ProductCode)

Front-End Recalc Expressions:
IIF( ( obj.ProductCode.Product != obj.Product), null, obj.ProductCode)

Recipe

The base recipe. null means that the item is produced without recipe. Filter(multi eq)

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

Front-End Recalc Expressions:
obj.Product.GetDefaultRecipe( ( obj.ReleaseDate ?? obj.WorkOrder.DocumentDate), obj.OutputStore.IfNullThen( obj.WorkOrder.DefaultOutputStore))

SerialNumber

If not null, specifies that the product was (has to be) produced with specific serial number. Filter(multi eq)

Type: SerialNumbers (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

StoreBin

The store bin in which to store the products. Filter(multi eq)

Type: StoreBins (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

WorkOrder

The Id of the work order, containing the item. Required Filter(multi eq) Owner

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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

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

API

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

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

Suggest improvement to this page