Production.Technologies.PrincipalRecipes Entity

Namespace: Production.Technologies

List of base recipe models. Recipe models are used by the Product Configurator to create specific recipes. Entity: Prd_Principal_Recipes

Default Visualization

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

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DurationHour	decimal (10, 0)	The approximate duration of the operation (for the specified quantities) in seconds. This is pure operation time and excludes setup time. `Required` `Default(0)`
ExpiryDate	datetime nullable	The last date, when the recipe should be used. null means that there is no expiry date yet and the recipe model is still active. `Filter(ge;le)`
Id	guid
Name	string (64)	Name of the principal recipe. `Required` `Filter(like)`
Notes	string (254) nullable	User comments for the principal recipe.
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.
ProduceQuantity	Quantity (18, 3)	Suggested quantity to produce. Usually it is equal to 1. `Unit: ProduceUnit` `Required` `Default(1)` `Filter(ge;le)`
ReleaseDate	datetime	The date, when the recipe model is released for use. `Required` `Default(Today)` `Filter(ge;le)`
ScrapRate	decimal (7, 6)	The percentage (0..1) of scrap usually occurring during the production operations. Specifying this leads to inflated requirements of all raw materials for the recipe. `Required` `Default(0)`

References

Name	Type	Description
ProduceUnit	MeasurementUnits	The measurement unit of Produce_Quantity. The selected item must support the specified unit. `Required` `Filter(multi eq)`
ProductGroup	ProductGroups	The production group, whose production is defined by the principal recipe . `Required` `Filter(multi eq)` `Owner`

Child Collections

Name	Type	Description
Ingredients	PrincipalRecipeIngredients	List of `PrincipalRecipe<br />Ingredient`(Production.Technologies.PrincipalRecipeIngredients.md) child objects, based on the `Production.Technologies.PrincipalRecipeIngredient.PrincipalRecipe`(Production.Technologies.PrincipalRecipeIngredients.md#principalrecipe) back reference
Operations	PrincipalRecipeOperations	List of `PrincipalRecipeOperation`(Production.Technologies.PrincipalRecipeOperations.md) child objects, based on the `Production.Technologies.PrincipalRecipeOperation.PrincipalRecipe`(Production.Technologies.PrincipalRecipeOperations.md#principalrecipe) back reference

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

DurationHour

The approximate duration of the operation (for the specified quantities) in seconds. This is pure operation time and excludes setup time. Required Default(0)

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

ExpiryDate

The last date, when the recipe should be used. null means that there is no expiry date yet and the recipe model is still active. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: 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

Name

Name of the principal recipe. Required Filter(like)

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

Notes

User comments for the principal recipe.

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

ProduceQuantity

Suggested quantity to produce. Usually it is equal to 1. Unit: ProduceUnit Required Default(1) Filter(ge;le)

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

ReleaseDate

The date, when the recipe model is released for use. Required Default(Today) Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDate
Show in UI: ShownByDefault

ScrapRate

The percentage (0..1) of scrap usually occurring during the production operations. Specifying this leads to inflated requirements of all raw materials for the recipe. Required Default(0)

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

Reference Details

ProduceUnit

The measurement unit of Produce_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

ProductGroup

The production group, whose production is defined by the principal recipe . Required Filter(multi eq) Owner

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