Production.Technologies.PrincipalRecipeIngredients Entity

Template for material usage of a principal recipe. Entity: Prd_Principal_Recipe_Ingredients

Default Visualization

Default Display Text Format:
{IngredientName}
Default Search Members:
IngredientName
Name Data Member:
IngredientName
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.PrincipalRecipes
Aggregate Root:
General.Products.ProductGroups

Attributes

Name	Type	Description
ConditionalProperty Description	MultilanguageString (254) nullable	The desired description of Conditional Property in order for the template line to match.
ConditionalPropertyValue	string (254) nullable	The desired value of Conditional Property in order for the template line to match.
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 for setup. `Unit: UsageUnit` `Required` `Default(0)`
Id	guid
~~IngredientId~~	guid	OBSOLETE! Do not use! The Id of the ingredient. When copying principal recipes, this Id remains the same for the new principal recipe to provide upgrade path for old recipes. `Obsolete` `Required` `Default(New Guid)` `Filter(multi eq)` `Obsoleted in version 22.1.6.61`
IngredientName	string (254)	The principal name of the ingredient. `Required` `Filter(like)`
LineOrd	int32	The position of the line in the recipe model. `Required`
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.
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)` `Filter(ge;le)`
UsageQuantity	Quantity (18, 6) nullable	Quantity to be consumed from the material. null means that the quantity is specified with formula. `Unit: UsageUnit` `Default(1)` `Filter(ge;le)`
UsageQuantityFormula	string (max) nullable	Specifies formula for the usage quantity. The formula can reference properties in `<Prop_Name>` style, just like products name and description mask. The formula can contain *, /, + and - operators. The formula can also be simple number, directly specifying quantity.

References

Name	Type	Description
ConditionalProperty	CustomProperties (nullable)	When not null, specifies that, when creating recipe, the ingredient will be added only if this property is set for the main product. `Filter(multi eq)`
ConditionalProperty AllowedValue	CustomPropertyAllowedValues (nullable)	When not null, specifies that, when creating recipe, the ingredient will be added only if the main product property, specified in Conditional_Property_Id equals the specified value. `Filter(multi eq)`
DefaultMaterial	Products (nullable)	If not null, points to default product for this ingredient. `Filter(multi eq)`
DefaultStore	Stores (nullable)	The default store from which to retrieve the material. `Filter(multi eq)`
MaterialFromProperty	CustomProperties (nullable)	When not null, specifies that the material will be obtained from the value of the specified property. The property must have allowed values in the Products domain. `Filter(multi eq)`
MaterialGroup	ProductGroups	Filter for choosing specific material in the recipe (Gen_Product_Groups_Table). `Required` `Filter(multi eq)`
Operation	Operations (nullable)	Specifies for which operation this ingredient will be used. `Filter(multi eq)`
PrincipalRecipe	PrincipalRecipes	The to which this PrincipalRecipeIngredient belongs. `Required` `Filter(multi eq)` `Owner`
UsageUnit	MeasurementUnits	The measurement unit of Usage_Quantity. The selected item must support the specified unit. `Required` `Filter(multi eq)`

Attribute Details

ConditionalPropertyDescription

The desired description of Conditional Property in order for the template line to match.

Type: MultilanguageString (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

ConditionalPropertyValue

The desired value of Conditional Property in order for the template line to match.

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

IngredientId

OBSOLETE! Do not use! The Id of the ingredient. When copying principal recipes, this Id remains the same for the new principal recipe to provide upgrade path for old recipes. Obsolete Required Default(New Guid) Filter(multi eq) Obsoleted in version 22.1.6.61

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

IngredientName

The principal name of the ingredient. Required Filter(like)

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

Front-End Recalc Expressions:
obj.DefaultMaterial.Name

LineOrd

The position of the line in the recipe model. Required

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

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

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

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

ScrapRate

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

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

UsageQuantity

Quantity to be consumed from the material. null means that the quantity is specified with formula. Unit: UsageUnit Default(1) Filter(ge;le)

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

Front-End Recalc Expressions:
IIF( ( obj.UsageQuantityFormula != null), null, obj.UsageQuantity)

UsageQuantityFormula

Specifies formula for the usage quantity. The formula can reference properties in <Prop_Name> style, just like products name and description mask. The formula can contain *, /, + and - operators. The formula can also be simple number, directly specifying quantity.

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

Front-End Recalc Expressions:
IIF( ( obj.UsageQuantity != null), null, obj.UsageQuantityFormula)

Reference Details

ConditionalProperty

When not null, specifies that, when creating recipe, the ingredient will be added only if this property is set for the main product. Filter(multi eq)

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

ConditionalPropertyAllowedValue

When not null, specifies that, when creating recipe, the ingredient will be added only if the main product property, specified in Conditional_Property_Id equals the specified value. Filter(multi eq)

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

DefaultMaterial

If not null, points to default product for this ingredient. Filter(multi eq)

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

DefaultStore

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

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

MaterialFromProperty

When not null, specifies that the material will be obtained from the value of the specified property. The property must have allowed values in the Products domain. Filter(multi eq)

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

MaterialGroup

Filter for choosing specific material in the recipe (Gen_Product_Groups_Table). Required Filter(multi eq)

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

PrincipalRecipe

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

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

Front-End Recalc Expressions:
obj.DefaultMaterial.BaseUnit

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