Template: Catalog

This section specifies the template Catalog.

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 Catalog 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 Catalog template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the Catalog template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the Catalog template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the Catalog 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 Catalog template describes how to represent a generic catalog (can be used to represent spare parts catalog from manufacturers or any other business catalog)

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

../../../../../data/PLCS/psm_model/images/SysML_Block_Definition_Diagram__Diagrams__Breakdown.png

Figure 1 - Breakdown model

Related Templates

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

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

Template Properties

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

References:

catalogOf [1] (Block: Ap239Ap233Psm:BreakdownOfSelect)

The reference of the product for which the Catalog is for.

issuer [0..1] (Template: OASIS:Organization)

The Organization issuing the Catalog

Parts:

descriptions [0..*] (Template: OASIS:Descriptor)

The collection of descriptions for the Catalog

ids [1..*] (Template: OASIS:Identification)

The collection of identifiers for the Catalog

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

RDL constraint 1:

The id must be classified as a Breakdown_identification_code or a subclass thereof.

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#Breakdown_identification_code

versionId [1] (Template: OASIS:Identification)

The version identifier for the Catalog

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

RDL constraint 1:

The identifier must be a version identifier.

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#Version_identification_code

classifications [1..*] (Template: OASIS:Classifier)

The collection of classifications for the Catalog

effectivityRole [0..1] (Template: OASIS:Classifier)

The role for the effectivity

names [0..*] (Template: OASIS:Name)

The collection of names for the Catalog

Values:

issueDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)

The date when the catalog was issued

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

endEffectivityDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)

The date when the Catalog ends to be valid for the product

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 Catalog starts to be valid for the product

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:

catalog (Template: OASIS:Breakdown)

Enables the Template: OASIS:Breakdown instantiated by this template to be referenced when the template is used.

Template constraints

The following constraints are defined for this template:

Constraint: classificationConstraint

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

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

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 Catalog

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

Private Part Property:issuerAssignment [0..1] (Block: Ap239Ap233Psm:OrganizationOrPersonInOrganizationAssignment)

Private Reference Property:classIssuerOf [0..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:classifyIssuerAss [0..1] (Template: OASIS:Classifier)

Private Part Property:issueDateAssignment [0..1] (Block: Ap239Ap233Psm:DateTimeAssignment)

Private Reference Property:classIssueDate [0..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:classifyIssueDateAss [0..1] (Template: OASIS:Classifier)

Private Part Property:effectivity [0..1] (Template: OASIS:DatedEffectivity)

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 Catalog

Instances

The following instances have been created:

classIssuerOf 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_issuer

classDateActualCreation 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_creation

classCatalog instance of Block: Ap239Ap233Psm:ExternalOwlClass.

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

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

No example data sets have been provided for this Template.