This section specifies the template WorkOrder.
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 WorkOrder template.
The specification comprises the following sections:
- Section Description provides a
description of the template;
- Section Template Block specifies the SysML
Block that represents the template;
- Section Template Properties specifies
the properties, i.e. the Part, Reference and Value properties of the
templates SysML Block;
- Section Template Output Ports
specifies the Output Ports of the templates SysML Block. These bind to the
templates and PLCS PSM objects
instantiated by the WorkOrder template as
described in section Template
Parametric Diagram;
- Section Template Constraints specifies
the constraints on PLCS PSM objects instantiated by the
WorkOrder template;
- Section Template Parametric
Diagram specifies the templates and PLCS PSM objects instantiated by the
WorkOrder template;
- Section Instantiated blocks specifies
the templates and PLCS PSM objects instantiated by the
WorkOrder template and bound to private
parts of the template;
- Section Default instances species the
instances that have been instantiated in the template. These are used to set
the default value of blocks.
- Section Constraint blocks identifies the
constraint blocks that have been specified in this template;
- Section Example data
provides example XML data sets that have been instantiated in accordance
with this template.
NOTE
An explanation of a template and its specification is provided in
the
Template
overview
The WorkOrder template describes how to represent a work order - the authority to
undertake
some work and the activity authorized by the work order.
The WorkOrder is one of a set of templates
used to represent activities. These are summarized in Figure 1
which shows that the model contains templates for:
- representing request and authority for work,
- managed planned authorized activities and a corresponding record of the work done,
- unmanaged planned activities and a corresponding record of the activity done,
- record of activities performed by a product.
The actual templates are:
-
Managed work
- The WorkRequest template represents a
request for work to be undertaken;
- The WorkOrder template represents the
authorization of work to be undertaken, often in response to a WorkRequest;
- The DirectedActivity template represents
an activity that is planned to be undertaken under the authority of a given
WorkOrder.
- The WorkDone template represents a record
of the work done in response to an authorized DirectedActivity.
-
UnManaged activities
- The PlannedActivity template represents an
activity that is planned to be undertaken that is neither governed by a WorkOrder nor an activity to be performed by a
product.
- The ActualActivity template represents a
record of an activity that is performed in response to a PlannedActivity.
-
Product activities
- The ActualProductUsage template represents
a record of an activity that has been performed by a product, the
usage of a product.
Figure 1 - Templates representing activities
The SysML Block Definition diagram in Figure 2 shows how Work
order is represented in the PLCS PSM.
Figure 2 - Work order model
The following templates are related to the WorkOrder template:
NOTE
The WorkOrder template may make reference
to other templates as part of the Parametric Diagram. These are not listed
here.
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.
Figure 3 - Template block definition diagram for WorkOrder
The following Part, Reference, and Value properties are defined for this template:
References:
status [0..1] (Template: OASIS:
StateAssertion)
The status of the work order.
The reference data used in Template: OASIS:
StateAssertion is restricted as follows:
RDL constraint 1:The status is represented subclasses of State_of_work_order.
The reference data for:
OASIS:StateAssertion.sameAs -> ExternalOwlObject.individual
is restricted to the following class or a subclass:
Example reference data is:
Parts:
ids [1..*] (Template: OASIS:
Identification)
The identifiers assigned to the work order.
The reference data used in Template: OASIS:
Identification is restricted as follows:
RDL constraint 1:The ids must be classified as an Work_order_identification_code or a
subclass thereof.
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
classifications [0..*] (Template: OASIS:
Classifier)
The classification of the work order.
The reference data used in Template: OASIS:
Classifier is restricted as follows:
RDL constraint 1:The reference data for:
OASIS:Classifier.class -> ExternalOwlClass.class
is restricted to classes that are subclasses of the following class:
name [0..1] (Template: OASIS:
Name)
An optional name assigned to the work order.
Values:
The following output ports are defined for this template:
work_order (Block: Ap239Ap233Psm:
WorkOrder)
Enables the
Block: Ap239Ap233Psm:
WorkOrder instantiated by this template to be referenced
when the template is used.
The following constraints are defined for this template:
Constraint: uniqueWorkOrderSpecification: (OCL2.0)
WorkOrder::allInstance()->isUnique(id)
There shall only be one
WorkOrder within the data set uniquely identified by the following
parameter on this template namely:
WorkOrder.id.
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 WorkOrder.
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.
Figure 4 - Parametric diagram for WorkOrder
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:
workOrder [1] (Block: Ap239Ap233Psm:
WorkOrder)
Private Part Property:
statusAssg [0..1] (Block: Ap239Ap233Psm:
StateAssignment)
Private Reference Property:
classDateOfIssue [0..1] (Block: Ap239Ap233Psm:
ExternalOwlClass)
The following constraint, normally a uniqueness constraint, is
applicable when instantiating the ExternalOwlClass:
rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Private Reference Property:
classIssuingBody [1] (Block: Ap239Ap233Psm:
ExternalOwlClass)
The following constraint, normally a uniqueness constraint, is
applicable when instantiating the ExternalOwlClass:
rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Private Part Property:
issueDateClassifier [0..1] (Template: OASIS:
Classifier)
Private Part Property:
issuingOrgClassifier [1] (Template: OASIS:
Classifier)
Figure 3 shows the instances that have been instantiated in the template. These are
used to set the default value of blocks.
Figure 3 - Model instance diagram for WorkOrder
The following instances have been created:
classIssuerOf instance of Block: Ap239Ap233Psm:
ExternalOwlClass.
This is used within the template to correctly classify the person and organization
assignment to
to the work order.
There are no constraint blocks defined in this template.
The following section provides an example XML dataset that has been instantiated in
accordance with this template.
Data set: Work order
This example shows the XML instantiated to represent an Work order raised on a Realized
Part.