Table of Contents

Production.Technologies.Recipes Entity

Namespace: Production.Technologies

Contains the characteristics of operations used to create products. Entity: Prd_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 Tree

Attributes

Name Type Description
CreationTime datetime nullable Date and time when the Recipe was created. Filter(ge;le) ReadOnly
CreationUser string (64) nullable Login name of the user, who created the Recipe. Filter(like) ReadOnly
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExpiryDate datetime nullable The last date, when the recipe should be used. null means that the recipe might still be in use. Filter(ge;le)
Id guid
IsDefault boolean Default for period: Release_Date - Expiry_Date. Required Default(false) Filter(eq)
Name string (64) The name of the recipe. When there is only 1 recipe, it is often equal to the product name. However, when there are multiple recipes for one product, the name is used for diferentiation. Required Filter(like)
Notes string (254) nullable User comments for the 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.
Price Amount (18, 4) The price for the specified Produce_Quantity. Currency: Product.CostingCurrency Required Default(0)
PricePerLot Amount (18, 4) Price for one lot of the product (according to Lot_Size_Quantity_Base). Currency: Product.CostingCurrency Required Default(0)
ProduceQuantity Quantity (18, 3) Lot size. This is the produced quantity in one production run. The quantity is measured in the primary unit of Product_Id. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(1)
ReleaseDate datetime The date, when the recipe was released to production. Required Default(Today) Filter(ge;le)
ScrapRate decimal (7, 6) The percentage (0..1) of scrap usually occurring during the operation. Specifying this leads to inflated requirements of all raw materials for this recipe. Required Default(0)
UpdateTime datetime nullable Date and time when the Recipe was last updated. Filter(ge;le) ReadOnly
UpdateUser string (64) nullable Login name of the user, who last updated the Recipe. Filter(like) ReadOnly

References

Name Type Description
CurrencyDirectory CurrencyDirectories (nullable) Currency directory, which is used to convert the costs and prices of materials, operations and resources into the currency of the product. Filter(multi eq)
PrincipalRecipe PrincipalRecipes (nullable) The prinicipal recipe, used to create this recipe. null means that this recipe was created without the help of principal recipe. Filter(multi eq)
Product Products (nullable) The Id of the produced product. Filter(multi eq)
Store Stores (nullable) The store for which this technology is valid. The store is matched with the output store specified in the production order. When null, the technology is valid for all stores. Filter(multi eq)

Child Collections

Name Type Description
Ingredients RecipeIngredients List of RecipeIngredient(Production.Technologies.RecipeIngredients.md) child objects, based on the Production.Technologies.RecipeIngredient.Recipe(Production.Technologies.RecipeIngredients.md#recipe) back reference
Operations RecipeOperations List of RecipeOperation(Production.Technologies.RecipeOperations.md) child objects, based on the Production.Technologies.RecipeOperation.Recipe(Production.Technologies.RecipeOperations.md#recipe) back reference

Attribute Details

CreationTime

Date and time when the Recipe was created. Filter(ge;le) ReadOnly

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

CreationUser

Login name of the user, who created the Recipe. Filter(like) ReadOnly

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

ExpiryDate

The last date, when the recipe should be used. null means that the recipe might still be in use. 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

IsDefault

Default for period: Release_Date - Expiry_Date. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Name

The name of the recipe. When there is only 1 recipe, it is often equal to the product name. However, when there are multiple recipes for one product, the name is used for diferentiation. 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 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

Price

The price for the specified Produce_Quantity. Currency: Product.CostingCurrency Required Default(0)

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

PricePerLot

Price for one lot of the product (according to Lot_Size_Quantity_Base). Currency: Product.CostingCurrency Required Default(0)

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

ProduceQuantity

Lot size. This is the produced quantity in one production run. The quantity is measured in the primary unit of Product_Id. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(1)

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

ReleaseDate

The date, when the recipe was released to production. 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 operation. Specifying this leads to inflated requirements of all raw materials 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

UpdateTime

Date and time when the Recipe was last updated. Filter(ge;le) ReadOnly

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

UpdateUser

Login name of the user, who last updated the Recipe. Filter(like) ReadOnly

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

Reference Details

CurrencyDirectory

Currency directory, which is used to convert the costs and prices of materials, operations and resources into the currency of the product. Filter(multi eq)

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

PrincipalRecipe

The prinicipal recipe, used to create this recipe. null means that this recipe was created without the help of principal recipe. Filter(multi eq)

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

Product

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

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

Store

The store for which this technology is valid. The store is matched with the output store specified in the production order. When null, the technology is valid for all stores. Filter(multi eq)

Type: Stores (nullable)
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

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

None

API

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

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