Production.ShopFloor.WorkOrderItemIngredients Entity

The materials consumed in the production order operations. Entity: Prd_Work_Order_Item_Ingredients

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
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DistributeBy	DistributeBy nullable	Distribution method in case the materials from the line are distributed amongst all work order items. Should be NOT null iif Work_Order_Item_Id is null. MC=Measurement, SP=Standard_Price.
FixedScrapQuantity	Quantity (18, 3)	The quantity of the material, which will be used for setup. `Unit: UsedQuantityUnit` `Required` `Default(0)`
Id	guid
LineOrd	int32	The order of the line within the item. `Required` `Filter(eq;like)`
Notes	string (254) nullable	Notes for this WorkOrderItemIngredient.
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.
UsedQuantity	Quantity (18, 3)	The quantity of the material consumed in the operation. `Unit: UsedQuantityUnit` `Required` `Default(1)`
UsedQuantityBase	Quantity (18, 3)	The equivalence of Used Quantity in the base measurement category of the material. `Unit: Material.BaseMeasurementCategory.BaseUnit` `Required` `ReadOnly`
UsedStandardQuantityBase	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 Used Quantity Base. `Unit: Material.BaseMeasurementCategory.BaseUnit` `Required` `ReadOnly` `Introduced in version 18.2`

References

Name	Type	Description
DistributeByMeasurement Category	MeasurementCategories (nullable)	Measurement category by which the materials from the line are distributed amongst all work order items in case Distribute_By = MC. Should be NOT null iif Distribute_By = MC. `Filter(multi eq)`
Document	WorkOrders	The to which this WorkOrderItemIngredient belongs. `Required` `Filter(multi eq)`
Lot	Lots (nullable)	Lot from which to get the material. When null, any lot can be used. `Filter(multi eq)`
Material	Products	The Id of the consumed material (Gen_Products_Table). `Required` `Filter(multi eq)`
Operation	Operations (nullable)	Specifies for which operation this ingredient is used. `Filter(multi eq)`
PrincipalRecipeIngredient	PrincipalRecipeIngredients (nullable)	The principal recipe ingredient on which this record is based. `Filter(multi eq)`
ProductCode	ProductCodes (nullable)	Selects the product thru some of the product codes. `Filter(multi eq)`
SerialNumber	SerialNumbers (nullable)	If not null, specifies the serial number of the ingredient. `Filter(multi eq)`
Store	Stores (nullable)	The store from which to retrieve the material. `Filter(multi eq)`
StoreBin	StoreBins (nullable)	The store bin from which to take the ingredients. `Filter(multi eq)`
UsedQuantityUnit	MeasurementUnits	The measurement unit of the quantity of the material consumed in the operation. `Required` `Filter(multi eq)`
WorkOrder	WorkOrders	The to which this WorkOrderItemIngredient belongs. `Required` `Filter(multi eq)` `Owner`
WorkOrderItem	WorkOrderItems (nullable)	The work order item for which the materials in this line are used. If null means that the materials are distributed amongst all work order items in the document. `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

DistributeBy

Distribution method in case the materials from the line are distributed amongst all work order items. Should be NOT null iif Work_Order_Item_Id is null. MC=Measurement, SP=Standard_Price.

Type: DistributeBy nullable
Category: System
Allowed values for the DistributeBy(Production.ShopFloor.WorkOrderItemIngredients.md#distributeby) data attribute
Allowed Values (Production.ShopFloor.WorkOrderItemIngredientsRepository.DistributeBy Enum Members)

Value	Description
StandardPrice	StandardPrice value. Stored as 'SP'. Database Value: 'SP' Model Value: 0 Domain API Value: 'StandardPrice'
Measurement	Measurement value. Stored as 'MC'. Database Value: 'MC' Model Value: 1 Domain API Value: 'Measurement'
StandardCost	StandardCost value. Stored as 'SC'. Database Value: 'SC' Model Value: 2 Domain API Value: 'StandardCost'

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

Front-End Recalc Expressions:
IIF( ( obj.WorkOrderItem != null), null, obj.DistributeBy)

FixedScrapQuantity

The quantity of the material, which will be used for setup. Unit: UsedQuantityUnit Required Default(0)

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

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 item. 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.ItemIngredients.Select( c => c.LineOrd).DefaultIfEmpty( 0).Max( ) + 10)

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

Notes

Notes for this WorkOrderItemIngredient.

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

UsedQuantity

The quantity of the material consumed in the operation. Unit: UsedQuantityUnit Required Default(1)

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

UsedQuantityBase

The equivalence of Used Quantity in the base measurement category of the material. Unit: Material.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.Material != null) AndAlso ( obj.UsedQuantity != null)) AndAlso ( obj.UsedQuantityUnit != null)), obj.UsedQuantity.ConvertTo( obj.Material.BaseUnit, obj.Material), obj.UsedQuantityBase)

Front-End Recalc Expressions:
IIF( ( ( ( obj.Material != null) AndAlso ( obj.UsedQuantity != null)) AndAlso ( obj.UsedQuantityUnit != null)), obj.UsedQuantity.ConvertTo( obj.Material.BaseUnit, obj.Material), obj.UsedQuantityBase)

UsedStandardQuantityBase

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 Used Quantity Base. Unit: Material.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: ShownByDefault

Back-End Default Expression:
IIF( ( ( ( obj.UsedQuantity != null) AndAlso ( obj.UsedQuantityUnit != null)) AndAlso ( obj.Material != null)), IIF( obj.Material.AllowVariableMeasurementRatios, obj.UsedQuantity.ConvertTo( obj.Material.BaseUnit, obj.Material), obj.UsedQuantityBase), obj.UsedStandardQuantityBase)

Front-End Recalc Expressions:
IIF( ( ( ( obj.UsedQuantity != null) AndAlso ( obj.UsedQuantityUnit != null)) AndAlso ( obj.Material != null)), obj.UsedQuantity.ConvertTo( obj.Material.BaseUnit, obj.Material), obj.UsedStandardQuantityBase)

Reference Details

DistributeByMeasurementCategory

Measurement category by which the materials from the line are distributed amongst all work order items in case Distribute_By = MC. Should be NOT null iif Distribute_By = MC. Filter(multi eq)

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

Front-End Recalc Expressions:
IIF( ( ( obj.DistributeBy == null) OrElse ( Convert( obj.DistributeBy.Value, Int32) != 1)), null, obj.DistributeByMeasurementCategory)

Document

The to which this WorkOrderItemIngredient belongs. Required Filter(multi eq)

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

Lot

Lot from which to get the material. When null, any lot can be used. Filter(multi eq)

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

Material

The Id of the consumed material (Gen_Products_Table). Required Filter(multi eq)

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

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

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

Operation

Specifies for which operation this ingredient is used. Filter(multi eq)

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

PrincipalRecipeIngredient

The principal recipe ingredient on which this record is based. Filter(multi eq)

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

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: ShownByDefault

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

SerialNumber

If not null, specifies the serial number of the ingredient. Filter(multi eq)

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

Store

The store from which to retrieve the material. Filter(multi eq)

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

Back-End Default Expression:
obj.WorkOrder.DefaultMaterialsStore

Front-End Recalc Expressions:
obj.WorkOrder.DefaultMaterialsStore

StoreBin

The store bin from which to take the ingredients. Filter(multi eq)

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

UsedQuantityUnit

The measurement unit of the quantity of the material consumed 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.Material.MeasurementUnit.IfNullThen( obj.UsedQuantityUnit))

Front-End Recalc Expressions:
obj.ProductCode.CodingSystem.DefaultMeasurementUnit.IfNullThen( obj.Material.MeasurementUnit.IfNullThen( obj.UsedQuantityUnit))

WorkOrder

The to which this WorkOrderItemIngredient belongs. Required Filter(multi eq) Owner

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

WorkOrderItem

The work order item for which the materials in this line are used. If null means that the materials are distributed amongst all work order items in the document. Filter(multi eq)

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

Front-End Recalc Expressions:
IIF( ( obj.DistributeBy != null), null, obj.WorkOrderItem)

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