Production.Technologies.RecipeIngredients Entity

Contains the materials of a recipe that make up the product. Entity: Prd_Recipe_Ingredients

Default Visualization

Default Display Text Format:
{Recipe.Name}
Default Search Members:
Recipe.Name
Name Data Member:
Recipe.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:
Production.Technologies.Recipes
Aggregate Root:
Production.Technologies.Recipes

Attributes

Name	Type	Description
Cost	Amount (18, 4)	The cost of the specified quantity of the ingredient. `Currency: Recipe.Product.CostingCurrency` `Required` `Default(0)` `Filter(ge;le)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FixedScrapQuantity	Quantity (18, 3)	Fixed scrap quantity of the material, needed for setup. `Unit: UsageUnit` `Required` `Default(0)`
Id	guid
LineOrd	int32	The order of this line in the recipe. `Required`
Notes	string (254) nullable	Notes for this RecipeIngredient.
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.
Price	Amount (18, 4)	Total price of the ingredient. `Currency: Recipe.Product.CostingCurrency` `Required` `Default(0)` `Filter(ge;le)`
ScrapRate	decimal (7, 6)	The usual percentage (0..1) of scrap of the raw material; inflates the requirements of this material for this recipe. `Required` `Default(0)`
UnitCost	Amount (18, 6)	Cost of 1 of Usage_Unit_Id. `Currency: Recipe.Product.CostingCurrency` `Required` `Default(0)` `Filter(ge;le)`
UnitPrice	Amount (18, 6)	Price for 1 of Usage_Unit_Id. `Currency: Recipe.Product.CostingCurrency` `Required` `Default(0)` `Filter(ge;le)`
UsageQuantity	Quantity (18, 6) nullable	Quantity of the material, consumed in the operation. The measurement unit is the primary unit of Material_Item_Id. `Unit: UsageUnit` `Default(1.000)` `Filter(ge;le)`

References

Name	Type	Description
Material	Products	The Id of the consumed material (Gen_Products_Table). `Required` `Filter(multi eq)`
Operation	Operations (nullable)	Specifies for which operation this ingredient will be used. `Filter(multi eq)`
PrincipalRecipeIngredient	PrincipalRecipeIngredients (nullable)	The principal recipe ingredient which was used to create this recipe ingredient. null means that this ingredient is standalone, not created with principal recipe ingredient. `Filter(multi eq)`
Recipe	Recipes	The to which this RecipeIngredient belongs. `Required` `Filter(multi eq)` `Owner`
Store	Stores (nullable)	The store from which to retrieve the material. `Filter(multi eq)`
UsageUnit	MeasurementUnits	The measurement unit of Usage_Quantity. The selected item must support the specified unit. `Required` `Filter(multi eq)`

Attribute Details

Cost

The cost of the specified quantity of the ingredient. Currency: Recipe.Product.CostingCurrency Required Default(0) Filter(ge;le)

Type: Amount (18, 4)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: Constant
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

FixedScrapQuantity

Fixed scrap quantity of the material, needed for setup. Unit: UsageUnit 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 this line in the recipe. Required

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.Recipe.Ingredients.Select( c => c.LineOrd).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.Recipe.Ingredients.Select( c => c.LineOrd).DefaultIfEmpty( 0).Max( ) + 1)

Notes

Notes for this RecipeIngredient.

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

Price

Total price of the ingredient. Currency: Recipe.Product.CostingCurrency Required Default(0) Filter(ge;le)

Type: Amount (18, 4)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

ScrapRate

The usual percentage (0..1) of scrap of the raw material; inflates the requirements of this material for this recipe. Required Default(0)

Type: decimal (7, 6)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

UnitCost

Cost of 1 of Usage_Unit_Id. Currency: Recipe.Product.CostingCurrency Required Default(0) Filter(ge;le)

Type: Amount (18, 6)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

UnitPrice

Price for 1 of Usage_Unit_Id. Currency: Recipe.Product.CostingCurrency Required Default(0) Filter(ge;le)

Type: Amount (18, 6)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

UsageQuantity

Quantity of the material, consumed in the operation. The measurement unit is the primary unit of Material_Item_Id. Unit: UsageUnit Default(1.000) Filter(ge;le)

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

Reference Details

Material

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

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

Operation

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

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

PrincipalRecipeIngredient

The principal recipe ingredient which was used to create this recipe ingredient. null means that this ingredient is standalone, not created with principal recipe ingredient. Filter(multi eq)

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

Recipe

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

Type: Recipes
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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

UsageUnit

The measurement unit of Usage_Quantity. The selected item must support the specified unit. Required Filter(multi eq)

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