Skip to content

Latest commit

 

History

History
298 lines (213 loc) · 11.2 KB

Production.Resources.Resources.md

File metadata and controls

298 lines (213 loc) · 11.2 KB
uid
Production.Resources.Resources

Production.Resources.Resources Entity

Namespace: Production.Resources

Resource types available to production. Entity: Prd_Resources

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Production.Resources.ResourceGroups
Aggregate Root:
Production.Resources.ResourceGroups

Attributes

Name Type Description
Active boolean Indicates whether the current resource is active. Required Default(true) Filter(eq) Introduced in version 22.1.5.26
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
Name string (64) Name of the resource. Required Filter(like)
Notes string (254) nullable User notes for the resource.
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.
SetupDurationHours decimal (6, 2) The usual duration of setup when changing production. Required Default(0)
SetupScrapQuantity Quantity (18, 3) The usual quantity of fixed scrap occurring when changing production. . Unit: SetupScrapUnit Required Default(0)
StandardCostPerHour Amount (18, 6) nullable Standard cost per hour for this resource. It participates in the calculation of standard cost for production recipes in which the current resource is used. Currency: ResourceCurrency
StandardPricePerHour Amount (18, 6) nullable Standard price per hour for this resource. It participates in the calculation of standard price for production recipes in which the current resource is used. Currency: ResourceCurrency

References

Name Type Description
PrimaryUnit MeasurementUnits Primary measurement unit for quantities of the resource. Required Filter(multi eq)
ResourceCurrency Currencies (nullable) Currency for this resource. This currency applies for the standard price and cost per hour. Filter(multi eq)
ResourceGroup ResourceGroups The Id of the containing resource group. Required Filter(multi eq) Owner
SetupScrapUnit MeasurementUnits The measurement units of Setup_Scrap_Quantity. Required Filter(multi eq)

Child Collections

Name Type Description
Functions ResourceFunctions List of ResourceFunction(Production.Resources.ResourceFunctions.md) child objects, based on the Production.Resources.ResourceFunction.Resource(Production.Resources.ResourceFunctions.md#resource) back reference

Attribute Details

Active

Indicates whether the current resource is active. Required Default(true) Filter(eq) Introduced in version 22.1.5.26

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
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

Id

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

Name

Name of the resource. Required Filter(like)

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

Notes

User notes for the resource.

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

SetupDurationHours

The usual duration of setup when changing production. Required Default(0)

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

SetupScrapQuantity

The usual quantity of fixed scrap occurring when changing production. . Unit: SetupScrapUnit Required Default(0)

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

StandardCostPerHour

Standard cost per hour for this resource. It participates in the calculation of standard cost for production recipes in which the current resource is used. Currency: ResourceCurrency

Type: Amount (18, 6) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

StandardPricePerHour

Standard price per hour for this resource. It participates in the calculation of standard price for production recipes in which the current resource is used. Currency: ResourceCurrency

Type: Amount (18, 6) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

PrimaryUnit

Primary measurement unit for quantities of the resource. Required Filter(multi eq)

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

ResourceCurrency

Currency for this resource. This currency applies for the standard price and cost per hour. Filter(multi eq)

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

ResourceGroup

The Id of the containing resource group. Required Filter(multi eq) Owner

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

SetupScrapUnit

The measurement units of Setup_Scrap_Quantity. 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

Creates a notification and sends 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 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

[!list limit=1000 erp.entity=Production.Resources.Resources erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Production.Resources.Resources erp.type=front-end-business-rule default-text="None"]

API

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

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