NOTE The template has been defined in the context of UK_Defence. Refer to the business context for details of related templates.

NOTE An explanation of a template and the associated instantiation path is provided in the Template overview section.

This template describes how to represent the UK_Defence concept of a configuration item relationship (as a configuration management structure) in terms of PLCS model elements (templates, entities, and reference data).

This information object identifies the relationship between configuration items in a breakdown. It is essentially used to establish the parent child relationships between the configuration items.

Figure 1 — Graphical Representation for Business Object Configuration Item Relationship

Attribute name	Attribute description	Attribute type	Optionality
child	This attribute identifies the child node in a hierarchical relationship.	Configuration Item	Mandatory
description	This attribute provides the description of the configuration item relationship.	Intrinsic	Mandatory
id	This attribute provides the identifier of the configuration item relationship.	Identifier	Mandatory
name	This attribute provides the name of the configuration item relationship.	Intrinsic	Mandatory
parent	This attribute specifies the parent or upper node in a hierarchical relationship.	Configuration Item	Mandatory
version	This attribute provides the version of the configuration item relationship.	Intrinsic	Mandatory

Table 1 — Configuration Item Relationship attribute details

The following input parameters are defined for this template:

The following reference parameters are defined for this template:

The instantiation path shown below specifies the entities that are to be instantiated by the template.

A description of templates and the syntax for the instantiation path is provided in the Templates Help/Information section.

/representing_breakdown_structure(
    rel_type_name='Configuration_item_usage',
    rel_ecl_id='urn:plcs:rdl:uk_defence',
    parent=@parent_config_item,
    child=@child_config_item)/
%^configuration_management_structure = $representing_breakdown_structure.usage%
/identifier(
    items=^configuration_management_structure,
    ID=@cms_id,
    type='Configuration_item_usage_id_code',
    source_organization=@cms_source_organization)/
/identifier(
    items=^configuration_management_structure,
    ID=@cms_name,
    type='Configuration_item_usage_name',
    source_organization=@cms_source_organization)/
/identifier(
    items=^configuration_management_structure,
    ID=@cms_version,
    type='Configuration_item_usage_version_id_code',
    source_organization=cms_source_organization)/
/assigning_descriptor(
    descr=@cms_description,
    class_name='Description',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^configuration_management_structure)/

The following section details how the configuration_management_structure template can be optionally characterized by assigning other constructs to it. These are characterizations commonly applied to the template. The ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.

The following characterizations may apply:

Characterization Property

NOTE this characterization is optional.

A UK_Defence.configuration_management_structure may have specific properties assigned to it, through the use of the following templates (or those based upon these): UK_Defence.property. The following template calls show how these characterizations might be instantiated.

/property(property_identifier='', property_ecl_id='', property_value='', property_unit='', unit_ecl_id='', si_unit='', disposition='', a_property_of='')/

Characterization Status Assignment

NOTE this characterization is optional.

A UK_Defence.configuration_management_structure may have one or more status assigned to it, through the use of the following templates (or those based upon these): UK_Defence.status_assignment. The following template calls show how these characterizations might be instantiated.

/status_assignment(assigned_status='', assigned_status_ecl_id='', ID='', ID_type='', ID_organization='', subject='', type='', type_ecl_id='')/

Characterization Document Association

NOTE this characterization is optional.

A UK_Defence.configuration_management_structure may have specific documents assigned to it, through the use of the following templates (or those based upon these): UK_Defence.document_association , and the associated UK_Defence.document . The following template calls show how these characterizations might be instantiated.

/document_association(id='', type='', source_organization='', purpose='', related_document='', related_item='')/

Characterization Assigning effectivity

NOTE this characterization is optional.

An effectivity may be assigned to the UK_Defence.configuration_management_structure. This shall be done using entity Effectivity_assignment.

For example, a dated effectivity shall be assigned using template assigning_dated_effectivity.

/assigning_dated_effectivity(start_year='2005', start_month='11', start_day='22', start_hour='15', start_minute='15', start_second='00', start_sense='ahead', start_hour_offset='2', role_class_name='Planned_effectivity', role_ecl_id='urn:plcs:rdl:std', items='@@@@')/

NOTE The type of effectivity is described through the application of reference data. In this case the reference data specifies that it is a 'Planned Effectivity', but other types (e.g. 'Required' and 'Actual Effectivty' exist

NOTE The assignment of effectivities is described in capability C006: assigning_effectivity.