Template: OASIS:ResourceOrder
Introduction

This section specifies the template ResourceOrder.

The specification comprises a SysML Block that represents the template and an associated Parametric Diagram that defines the templates and PLCS PSM objects instantiated by the ResourceOrder template.

The specification comprises the following sections:

NOTE    An explanation of a template and its specification is provided in the Template overview
Description

The ResourceOrder template describes how to represent an order(the request) of supplies from a customer to a supplier.

The SysML Block Definition diagram in Figure 2 shows how a work request is represented in the PLCS PSM.

../../../../../data/contexts/OASIS/model_usage_guides/ResourceOrder/images/ResourceOrders.png
Figure 1 -  Templates representing ResourceOrder
../../../../../data/PLCS/psm_model/images/SysML_Block_Definition_Diagram__Diagrams__Work_order.png
Figure 2 -  WorkRequest model
Related Templates

No templates have been explicitly defined as being related to the ResourceOrder template.

NOTE    The ResourceOrder template may make reference to other templates as part of the Parametric Diagram. These are not listed here.
Template Block

Figure 3 shows the SysML Block that represents the template. The Block is an abstraction representing a pattern of templates and PLCS PSM objects.

The properties, i.e. the SysML Block Part, Reference and Value properties, of the template's SysML Block are described in the Template Properties section.

The output ports shown on the template's SysML Block are described in the template output ports section.

The constraints shown on the template's SysML Block are described in the template constraints section.

Template diagram
Figure 3 -  Template block definition diagram for ResourceOrder
Template Properties

The following Part, Reference, and Value properties are defined for this template:

References:
classifications [0..*] (Template: OASIS:Classifier)
The collection of classifications for the order
supplier [0..1] (Template: OASIS:Organization)
The organization receiving the order
customer [0..1] (Template: OASIS:Organization)
The organization sending the order
status [0..1] (Block: Ap239Ap233Psm:ProxyItemSelect)
The status of the order
documents [0..*] (Template: OASIS:Document)
The collection of documents for the order
orderType [0..1] (Block: Ap239Ap233Psm:ClassSelect)
The order type (for instance SparePartOrder)
The reference data used in Block: Ap239Ap233Psm:ClassSelect is restricted as follows:
RDL constraint 1:
The orderType class must be subclass of Resource_order or a subclass thereof.
The reference data for:
OASIS:ResourceOrder.orderType -> ExternalOwlClass.class
is restricted to the following class or a subclass:
http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Resource_order
contract [0..1] (Template: OASIS:Contract)
The contract under which the order is sent
Parts:
ids [1..*] (Template: OASIS:Identification)
The collection of identifications for the resource order
The reference data used in Template: OASIS:Identification is restricted as follows:
RDL constraint 1:
The id must be classified as an Work_request_identification_code or a subclass thereof.
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Work_request_identification_code
name [0..1] (Template: OASIS:Name)
The name for the resource order
description [0..1] (Template: OASIS:Descriptor)
The description for the resource order
Values:
orderDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)
The date when the order is placed
Template Output Ports

The following output ports are defined for this template:

order (Template: OASIS:WorkRequest)
Enables the Template: OASIS:WorkRequest instantiated by this template to be referenced when the template is used.
Template constraints

The following constraints are defined for this template:

Constraint: orderTypeConstraint
Specification: (English)
OrderType must be a subclass of "http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Resource_order"
Template Parametric diagram

This section describes the template's Parametric Diagram. The diagram details the pattern of templates and PLCS PSM objects that are required to represent the template ResourceOrder.

The public properties, i.e. those visible in the template's SysML block (See Figure 3) are shown on the left of a Parametric Diagram.

NOTE    Restrictions on the reference data to be set on the public properties is defined in the Template Properties section.

The output ports are shown on the right of the Parametric Diagram.

PLCS PSM objects are shaded khaki and template shaded light green in a Parametric Diagram.

Binding diagram
Figure 4 -  Parametric diagram for ResourceOrder
Instantiated Blocks

The following blocks are instantiated by this template and bound to private parts of the template as shown in the Parametric Diagram section:

Private Part Property:request [1] (Template: OASIS:WorkRequest)
Private Part Property:docAsg [0..*] (Block: Ap239Ap233Psm:DocumentAssignment)
Private Part Property:contractAsg [0..1] (Block: Ap239Ap233Psm:ContractAssignment)
Default instances

Figure 3 shows the instances that have been instantiated in the template. These are used to set the default value of blocks.

Instance diagram
Figure 3 -  Model instance diagram for ResourceOrder
Instances

The following instances have been created:

classOrder instance of Block: Ap239Ap233Psm:ExternalOwlClass.
ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Resource_order

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

No example data sets have been provided for this DEX.