Template: OASIS:Envelope
Introduction

This section specifies the template Envelope.

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 Envelope template.

The specification comprises the following sections:

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

The Envelope template describes how to represent an Envelope and the message it contains.

The SysML Block Definition diagram in Figure 1 shows how Envelope is represented in the PLCS PSM.

../../../../../data/PLCS/psm_model/images/SysML_Block_Definition_Diagram__Diagrams__Message.png
Figure 1 -  Envelope model
Related Templates

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

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

Figure 2 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.

Template diagram
Figure 2 -  Template block definition diagram for Envelope
Template Properties

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

References:
sender [1] (Block: Ap239Ap233Psm:OrganizationOrPersonInOrganizationSelect)
The organization or person in organization that sent the envelope.
recipient [1] (Block: Ap239Ap233Psm:OrganizationOrPersonInOrganizationSelect)
The intended receiving organization or person in organization for the envelope.
contents [1] (Template: OASIS:Message)
The message contained within the envelope.
securityClassification [0..1] (Block: Ap239Ap233Psm:SecurityClassification)
Optional - the Security Level applied to all the contents of the Envelope
Parts:
ids [1..*] (Template: OASIS:Identification)
The identifiers assigned to the Envelope.
The reference data used in Template: OASIS:Identification is restricted as follows:
RDL constraint 1:
The ids must be classified as envelope identification code.
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#Envelope_identification_code
Values:
dateSent [1] (Block: Ap239Ap233Psm:DateTimeString)
The date or date/time when the envelope was sent.
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.
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 PSM objects that are required to represent the template Envelope.

The public properties, i.e. those visible in the template's SysML block (See Figure 2) 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 3 -  Parametric diagram for Envelope
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:envelope [1] (Block: Ap239Ap233Psm:Envelope)
Private Part Property:sendAssn [1] (Block: Ap239Ap233Psm:OrganizationOrPersonInOrganizationAssignment)
Private Part Property:receiveAssn [1] (Block: Ap239Ap233Psm:OrganizationOrPersonInOrganizationAssignment)
Private Part Property:sendDateAssn [1] (Block: Ap239Ap233Psm:DateTimeAssignment)
Private Reference Property:classSenderOf [1] (Block: Ap239Ap233Psm:ExternalOwlClass)

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1
Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Private Reference Property:classRecieverOf [1] (Block: Ap239Ap233Psm:ExternalOwlClass)

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1
Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Private Reference Property:classDateSent [1] (Block: Ap239Ap233Psm:ExternalOwlClass)

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1
Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Private Part Property:securityClassificationAssignment [0..1] (Block: Ap239Ap233Psm:SecurityClassificationAssignment)
Private Part Property:senderClass [1] (Block: Ap239Ap233Psm:Classification)
Private Part Property:receiverClass [1] (Block: Ap239Ap233Psm:Classification)
Private Part Property:dateClass [1] (Block: Ap239Ap233Psm:Classification)
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 Envelope
Instances

The following instances have been created:

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

The receiver of the Envelope.
classSenderOf instance of Block: Ap239Ap233Psm:ExternalOwlClass.
ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#PersOrgAsg_actual_sender

The sender of the Envelope.
classEnvelopeIdCode instance of Block: Ap239Ap233Psm:ExternalOwlClass.
ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Envelope_identification_code

The identifier is identifying an Envelope.
classDateSent instance of Block: Ap239Ap233Psm:ExternalOwlClass.
ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Date_actual_sent

The date the Envelope sent.
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: Envelope

Envelope envelope.xml View download

This example shows the XML instantiated to represent a Envelope wrapping a Message.