Template: OASIS:CatalogItemRealization

This section specifies the template CatalogItemRealization.

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

The specification comprises the following sections:

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

The CatalogItemRealization template describes how to represent the realization of a catalog item

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

Figure 1 -  Breakdown model

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

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

Figure 2 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 constraints shown on the template's SysML Block are described in the template constraints section.

The SysML Parametric diagrams for the template Block are shown in template parametric diagram section.

Figure 2 -  Template block definition diagram for CatalogItemRealization

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

References:
catalogItem [1] (Template: OASIS:CatalogItem)
The Catalog item beeing realized
product [1] (Block: Ap239Ap233Psm:ProductSelect)
The Product realizing the Catalog item
Parts:
ids [0..*] (Template: OASIS:Identification)
The collection of identifications for the realization relationship
The reference data used in Template: OASIS:Identification is restricted as follows:
RDL constraint 1:
The id must be classified as a Breakdown_element_realization_identification_code or a subclass thereof.
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
effectivityRole [0..1] (Template: OASIS:Classifier)
The role for the date effectivity
classifications [1..*] (Template: OASIS:Classifier)
The collection of classifications for the realization relationship
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:
Values:
endEffectivityDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)
The date when the relationship ends to be valid

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')
startEffectivityDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)
The date when the relationship starts to be valid

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')

The following output ports are defined for this template:

catalogItemRealization (Template: OASIS:BreakdownElementRealization)
Enables the Template: OASIS:BreakdownElementRealization instantiated by this template to be referenced when the template is used.

The following constraints are defined for this template:

Constraint: definitionMustBeSet
Specification: (English)
viewDefinitionContext must be set
Constraint: classificationsRestriction
Specification: (English)
Classifications are restricted to or subclasses of http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Catalogue_item_realization

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 CatalogItemRealization.

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 a Parametric Diagram.

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

Figure 3 -  Parametric diagram for CatalogItemRealization

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

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 CatalogItemRealization

The following instances have been created:

There are no constraint blocks defined in this template.

No example data sets have been provided for this Template.