Template: ReportableEvent

This section specifies the template ReportableEvent.

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 ReportableEvent 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 ReportableEvent template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the ReportableEvent template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the ReportableEvent template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the ReportableEvent 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 ReportableEvent template describes the representation of an event which warrants the generation of a report, such as the consumption of life for a lifed asset.

Related Templates

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

NOTE The ReportableEvent 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 ReportableEvent

Template Properties

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

References:

eventType [1] (Block: Ap239Ap233Psm:ExternalOwlClass)

The type of event that has generated the report.

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)

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

RDL constraint 1:

There must be one classification of the type of event.

The reference data for:

ClassifiedByOwlClass.class

is restricted to one of the following classes:

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventDailyConsumptionOfLife

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventConsumptionOfLife

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventEngineeringInstructions

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventFitment

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventGeographicalChange

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventInventoryLoss

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventLifingExtension

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventMaintenance

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventOwnershipChange

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventPartNumberChange

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventRemoval

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventScheduledTask

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventSerialNumberChange

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventServiceabilityChange

http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#eventSortie

affectedItem [1..*] (Template: Exemplar:SerialisedAsset)

The Serialized Asset(s) that have changes to be reported due to this event.

Parts:

contract [1] (Template: OASIS:Identification)

The support and maintenance contract for the Asset(s) this report was generated for.

Values:

dateTimeOfExtract [1] (Block: Ap239Ap233Psm:DateTimeString)

The date and time at which the data in the report was extracted.

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:

activityActual (Block: Ap239Ap233Psm:ActivityActual)

Enables the Block: Ap239Ap233Psm:ActivityActual 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 ReportableEvent.

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 ReportableEvent

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:event [1] (Block: Ap239Ap233Psm:ActivityActual)

Private Part Property:extractDate [1] (Block: Ap239Ap233Psm:DateTimeAssignment)

Private Part Property:maintenanceContract [1] (Block: Ap239Ap233Psm:Contract)

Private Part Property:contractAssignment [1] (Block: Ap239Ap233Psm:ContractAssignment)

Private Part Property:affectedItemAsg [1] (Block: Ap239Ap233Psm:ActivityAssignment)

Private Reference Property:classDateTimeOfExtract [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:classSupportContract [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:classProductUsage [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:classificationProductUsage [1] (Block: Ap239Ap233Psm:Classification)

Private Part Property:classificationDateTimeOfExtract [1] (Block: Ap239Ap233Psm:Classification)

Private Part Property:classificationSupportContract [1] (Block: Ap239Ap233Psm:Classification)

Private Part Property:eventClassification [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.

Figure 3 - Model instance diagram for ReportableEvent

Instances

The following instances have been created:

classDateTimeOfExtract 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_extraction

classSupportContract instance of Block: Ap239Ap233Psm:ExternalOwlClass.

ExternalOwlClass.class = http://www.plcs.org/ns/plcslib/data/contexts/Exemplar/refdata/Exemplar-rdl#Support_contract

classProductUsage instance of Block: Ap239Ap233Psm:ExternalOwlClass.

ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Product_usage

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:ReportableEvent

Exemplar:ReportableEvent

reportabl;e_event.xml

View

download

This example shows the Exemplar ReportableEvent Template instantiated in XML.