Template: OASIS:ActualProductUsage

This section specifies the template ActualProductUsage.

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 ActualProductUsage 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 ActualProductUsage template as described in section Template Parametric Diagram;
• Section Template Constraints specifies the constraints on PLCS PSM objects instantiated by the ActualProductUsage template;
• Section Template Parametric Diagram specifies the templates and PLCS PSM objects instantiated by the ActualProductUsage template;
• Section Instantiated blocks specifies the templates and PLCS PSM objects instantiated by the ActualProductUsage 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.

The ActualProductUsage template describes how to represent a record of the usage of a product, e.g. the use of an airplane for a specific mission or the use of a truck for a specific transportation.

It represents an activity that has at least started and may have finished - an actual activity.

It can be used to record any information about a product usage, such as what product individual was used, who has reported the product usage, what typical activity was followed, and when the product was used. It is mandatory to assign an identifier or name to the activity, provide a start time if the activity, and identify the product being used.

The ActualProductUsage 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.

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

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

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 following Part, Reference, and Value properties are defined for this template:

The following output ports are defined for this template:

There are no constraints defined for this template.

This section describes the template's Parametric Diagrams. Each diagram details the pattern of templates and PLCS PSM objects that are required to represent the template ActualProductUsage.

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.

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.

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

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

The following instances have been created:

There are no constraint blocks defined in this template.

No example data sets have been provided for this DEX.