Table of Contents

Production.Resources.Load Entity

Namespace: Production.Resources

Contains scheduled operations usage of the resources. Entity: Prd_Load

Default Visualization

Default Display Text Format:
{WorkOrderItemOperation.WorkOrderItem.WorkOrder.EntityName}
Default Search Members:
WorkOrderItemOperation.WorkOrderItem.WorkOrder.EntityName
Name Data Member:
WorkOrderItemOperation.WorkOrderItem.WorkOrder.EntityName
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.ShopFloor.WorkOrderItemOperations
Aggregate Root:
Production.ShopFloor.WorkOrders

Attributes

Name Type Description
CalendarDate datetime Date of the scheduled load. This is date only. Start_Time and End_Time specify time of day. Required Filter(ge;le)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
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.
Priority Priority Priority of the allocation. 1=Lowest ... 5=Highest. Required Default(3)
TimeType TimeType S=Setup; R=Run; W=Wait; M=Move. Required Default("R")
UsageEndTime datetime The ending time of the planned usage. Required Filter(ge;le)
UsageQuantity Quantity (9, 0) Quantity of the resource, which will be used for production. Unit: WorkgroupResource.Resource.PrimaryUnit Required Default(1) Filter(ge;le)
UsageStartTime datetime The starting time of the planned usage. Required Filter(ge;le)
UsageTimeMinutes int32 Time allocated for the operation in minutes. Required Default(0) Filter(ge;le)

References

Name Type Description
WorkgroupResource WorkgroupResources The exact resource being utilised. Required Filter(multi eq)
WorkOrderItemOperation WorkOrderItemOperations The to which this Load belongs. Required Filter(multi eq) Owner

Attribute Details

CalendarDate

Date of the scheduled load. This is date only. Start_Time and End_Time specify time of day. Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
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: CannotBeShown

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

Priority

Priority of the allocation. 1=Lowest ... 5=Highest. Required Default(3)

Type: Priority
Category: System
Allowed values for the Priority(Production.Resources.Load.md#priority) data attribute
Allowed Values (Production.Resources.LoadRepository.Priority Enum Members)

Value Description
Lowest Lowest value. Stored as 1.
Database Value: 1
Model Value: 1
Domain API Value: 'Lowest'
Two Two value. Stored as 2.
Database Value: 2
Model Value: 2
Domain API Value: 'Two'
Three Three value. Stored as 3.
Database Value: 3
Model Value: 3
Domain API Value: 'Three'
Four Four value. Stored as 4.
Database Value: 4
Model Value: 4
Domain API Value: 'Four'
Highest Highest value. Stored as 5.
Database Value: 5
Model Value: 5
Domain API Value: 'Highest'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: 3
Show in UI: ShownByDefault

TimeType

S=Setup; R=Run; W=Wait; M=Move. Required Default("R")

Type: TimeType
Category: System
Allowed values for the TimeType(Production.Resources.Load.md#timetype) data attribute
Allowed Values (Production.Resources.LoadRepository.TimeType Enum Members)

Value Description
Move Move value. Stored as 'M'.
Database Value: 'M'
Model Value: 0
Domain API Value: 'Move'
Run Run value. Stored as 'R'.
Database Value: 'R'
Model Value: 1
Domain API Value: 'Run'
Setup Setup value. Stored as 'S'.
Database Value: 'S'
Model Value: 2
Domain API Value: 'Setup'
Wait Wait value. Stored as 'W'.
Database Value: 'W'
Model Value: 3
Domain API Value: 'Wait'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: Run
Show in UI: ShownByDefault

UsageEndTime

The ending time of the planned usage. Required Filter(ge;le)

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

UsageQuantity

Quantity of the resource, which will be used for production. Unit: WorkgroupResource.Resource.PrimaryUnit Required Default(1) Filter(ge;le)

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

UsageStartTime

The starting time of the planned usage. Required Filter(ge;le)

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

UsageTimeMinutes

Time allocated for the operation in minutes. Required Default(0) Filter(ge;le)

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

Reference Details

WorkgroupResource

The exact resource being utilised. Required Filter(multi eq)

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

WorkOrderItemOperation

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

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

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_Resources_Load?$top=10

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