Template: Message

This section specifies the template Message.

The specification comprises a SysML Block that represents the template and an associated Parametric Diagram that defines the templates and PLCS PSMTemplate objects instantiated by the Message 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 SysML Part, Reference and Value properties of the templates SysML Block;
Section Template Output Ports specifies the SysML Output Ports of the templates SysML Block. These bind to the templates and PLCS PSM objects instantiated by the Message template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the Message template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the Message template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the Message 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

Description

The Message template describes how to represent Message conveying the information about one or many Reportable Events, the assets effected by these events and the results of the event upon those assets.

Related Templates

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

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

Template Block

Figure 1 shows the SysML Block that represents the template. The Block is an abstraction representing a pattern of templates and PLCS PSMTemplate 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 SysML Parametric diagrams for the template Block are shown in template parametric diagram section.

Figure 1 - Template block definition diagram for Message

Template Properties

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

References:

securityClassification [1] (Block: Ap239Ap233Psm:ExternalOwlObject)

The level of Security Classification to be applied to the contents of the message.

The following constraint, normally a uniqueness constraint, is applicable when instantiating the ExternalOwlObject:

rule.Ap239Ap233Psm.ExternalOwlClass.ur1

Constraint: ur1

Specification: (OCL2.0)

ExternalOwlObject::allInstances()->isUnique(individual)

The reference data used in Block: Ap239Ap233Psm:ExternalOwlObject is restricted as follows:

RDL constraint 1:

There must be one identifier that is the part number.

The reference data for:

OASIS:ExternalOwlObject.class -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/plcs/plcs-psm/refdata/plcs-psm#SecurityClassification

sentBy [1] (Block: Ap239Ap233Psm:Organization)

The Organisation that sent the Message.

The reference data used in Block: Ap239Ap233Psm:Organization is restricted as follows:

RDL constraint 1:

There must be one identifier that is the part number.

The reference data for:

OASIS:Organization.class -> 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#NCAGE_code

sentTo [1] (Block: Ap239Ap233Psm:Organization)

The Organisation that is the intended recipient of the data

contents [1..*] (Block: Ap239Ap233Psm:MessageContentSelect)

The set of Reportable Events that are encapsulated by this message.

Parts:

transactionIdentifier [1] (Template: OASIS:Identification)

The unique identifier of the Message.

The reference data used in Template: OASIS:Identification is restricted as follows:

RDL constraint 1:

The identifier must be classified as a message identification code

The reference data for:

OASIS:Identification.class -> 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#Message_identification_code

Values:

dateSent [1] (Block: Ap239Ap233Psm:DateTimeString)

The Date upon which the Message was sent.

The following constraint, normally a uniqueness constraint, is applicable when instantiating the DateTimeString:

rule.Ap239Ap233Psm.ExternalOwlClass.ur1

Constraint: XSDDATETIME

Specification: (OCL2.0)

self.matches('[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z')

Template Output Ports

The following output ports are defined for this template:

envelope (Block: Ap239Ap233Psm:Envelope)

Enables the Block: Ap239Ap233Psm:Envelope instantiated by this template to be referenced when the template is used.

message (Block: Ap239Ap233Psm:Message)

Enables the Block: Ap239Ap233Psm:Message instantiated by this template to be referenced when the template is used.

Template constraints

There are no constraints defined for this template.

Template Parametric diagram

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

The public properties, i.e. those visible in the template's SysML block (See Figure 1) 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 a Parametric Diagram.

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

Figure 2 - Parametric diagram for Message

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:oasisEnvelope [1] (Template: OASIS:Envelope)

Private Part Property:oasisMessage [1] (Template: OASIS:Message)

Private Part Property:securityClsif [1] (Block: Ap239Ap233Psm:SecurityClassification)

Private Part Property:securityClassificationAssignment [1] (Block: Ap239Ap233Psm:SecurityClassificationAssignment)

Private Part Property:securityProxy [1] (Block: Ap239Ap233Psm:Proxy)

Default instances

There are no instances that have been instantiated in this template.

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

The following section provides an example XML dataset that has been instantiated in accordance with this template.

Data set: Exemplar:Message

Exemplar:Message

message.xml

View

download

This example shows the Exemplar Message Template instantiated in XML.