Template: OASIS:DatedEffectivity

This section specifies the template DatedEffectivity.

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

The specification comprises the following sections:

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

The DatedEffectivity template describes how to represent the validity of an item in between a start and an end date.

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

Figure 1 -  Product configuration model

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

NOTE    The DatedEffectivity 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 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.

The constraints shown on the template's SysML Block are described in the template constraints section.

Figure 2 -  Template block definition diagram for DatedEffectivity

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

References:
assignedTo [1] (Block: Ap239Ap233Psm:EffectivityAssignmentSelect)
The item to which the effectivity is assigned to.
Parts:
effectivityRole [0..1] (Template: OASIS:Classifier)
The role of the validity for the item.
Values:
startEffectivityDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)
The validity start date
endEffectivityDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)
The validity end date

The following output ports are defined for this template:

effectivity (Block: Ap239Ap233Psm:DatedEffectivity)
Enables the Block: Ap239Ap233Psm:DatedEffectivity instantiated by this template to be referenced when the template is used.
assignment (Block: Ap239Ap233Psm:EffectivityAssignment)
Enables the Block: Ap239Ap233Psm:EffectivityAssignment instantiated by this template to be referenced when the template is used.

The following constraints are defined for this template:

Constraint: dateRequired
Specification: (OCL2.0)
startEffectivityDate->notEmpty() or endEffectivityDate->notEmpty()

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

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.

Figure 3 -  Parametric diagram for DatedEffectivity

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:datedEffectivity [1] (Block: Ap239Ap233Psm:DatedEffectivity)
Private Part Property:effectivityAssigment [1] (Block: Ap239Ap233Psm:EffectivityAssignment)
Private Part Property:startDateProxy [0..1] (Block: Ap239Ap233Psm:DateTimeStringProxy)
Private Part Property:endDateProxy [0..1] (Block: Ap239Ap233Psm:DateTimeStringProxy)

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

There are no constraint blocks defined in this template.

No example data sets have been provided for this DEX.