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 system relationship in terms of PLCS model elements (templates, entities, and reference data).

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

Figure 1 — Graphical Representation for Business Object System Relationship

Attribute name	Attribute description	Attribute type	Optionality
child	This attribute identifies the child node in a hierarchical relationship.	System Element	Mandatory
id	This attribute provides the identifier of the system relationship.	Identifier	Mandatory
Identifier.id	This is the value of the id attribute of the Identifier applied to the system relationship.	intrinsic	Mandatory
Identifier.type	This attribute is the type associated with the id of the Identifier given to the system relationship.	System_element_usage_id_code	Mandatory
Identifier.source_organization	This attribute is the value representing the source organization that provides the id of the Identifier given to the system relationship. This value is assumed to be a type of Organization_identification_code.	Organization_identification_code	Mandatory
name	This attribute provides the name of the system relationship.	Intrinsic	Mandatory
parent	This attribute specifies the parent or upper node in a hierarchical relationship.	System Element	Mandatory
version	This attribute provides the version of the system relationship.	Intrinsic	Mandatory

Table 1 — System Relationship attribute details

The following input parameters are defined for this template:

The following reference parameters are defined for this template:

Allow the System_element_usage entity instantiated in this path to be referenced when this template is used.

Note: The System_element_usage entity can be referenced in a template path by:

%^target = $system_relationship.sys_relationship%

where target is the parameter to which the System_element_usage is bound.

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_system_structure(
    rel_type_name='System_element_usage',
    rel_ecl_id='urn:plcs:rdl:uk_defence',
    parent=@parent,
    child=@child)/

-- assign ref parameters
%^sys_relationship = $representing_system_structure.usage%

-- id
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='System_element_usage_id_code',
    items=^sys_relationship)/

-- name
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='System_element_usage_name',
    items=^sys_relationship)/

-- version
/identifier(
    ID=@version,
    source_organization=@source_organization,
    type='System_element_usage_version_id_code',
    items=^sys_relationship)/

The instance diagram in Figure 4 shows an example of the EXPRESS entities and templates that are instantiated by the template:

/system_relationship(id='BKNSR3', source_organization='6421', name='midship gauge monitor #1', version='strat bkn 6', parent='@124', child='@70')/

(an illustration of the consolidated system_relationship template is shown in Figure 5 below.)