Template:— configuration_management_breakdown (cnfg_mgt_bkdn)
Context:— UK_Defence

Date: 2009/04/17 10:39:19
Revision: 1.2

Cover Contents Description Bus. perspective Bus. obj.Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues in situ

This section specifies the template configuration_management_breakdown.

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.

Description

This template describes how to represent the UK_Defence concept of a configuration management breakdown in terms of PLCS model elements (templates, entities, and reference data). There is no PLCS subtype of breakdown that fulfills this role, so it has been based upon the PLCS/OASIS template representing_breakdown and classified appropriately.

Business perspective

This information object identifies the information that defines a breakdown that a project wishes to put in place as part of its Configuration Management Plan for the Supportability of the product.

Business object definition

This information object identifies the context of the breakdown that is provided for a related product design.

NOTE Examples of such a breakdown could be defined in terms of a: - LCN: Logistic Support Analysis Control Number (Def Stan 00-60) - CMN: Configuration Management Number (ACA) - CI: Configuration Item (Def Stan 05-57)

Figure 1 — Graphical Representation for Business Object Configuration Management Breakdown

Attribute name	Attribute description	Attribute type	Optionality
description	This attribute provides the description information of the breakdown.	Intrinsic	Mandatory
id	This attribute provides the identification information of the breakdown.	Intrinsic	Mandatory
name	This attribute provides the name of the breakdown.	Intrinsic	Mandatory
Related Product Design	This attribute identifies the design information associated with the breakdown.	Product Design	Mandatory
type	This attribute provides the type information of the breakdown.	Intrinsic	Mandatory
version	This attribute provides the version information of the breakdown.	Intrinsic	Mandatory

Table 1 — Configuration Management Breakdown attribute details

Model diagrams

The EXPRESS-G diagram in Figure 2 shows the templates and EXPRESS entities that are required to represent the template "configuration_management_breakdown". The text highlighted in blue shows the template parameters.

The bolded blue text indicates input parameters used in the final template. The light blue text indicates parameter values set within the final template.

Figure 2 — An EXPRESS-G representation of the Information model for configuration_management_breakdown

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure 3 below.

The angled blue text indicates reference parameters made available by the final template.

Figure 3 — The graphical representation of the configuration_management_breakdown template

Input parameters

The following input parameters are defined for this template:

id (Type='STRING')

The identifier of the breakdown.

source_organization (Type='STRING')

The organization or information system that created the associated identifier. Alternatively this could be set to /NULL when Person or Information System is the source; see Identifier template characterizations.

name (Type='STRING')

The name of the breakdown.

description (Type='STRING')

The description of the breakdown.

type (Default=Configuration_breakdown_type,Type='CLASS')

The type of the breakdown. Sub-classifications of Configuration_breakdown_type should be identified by and between organizations (if necessary) depending upon the business requirements.

The following classes and their sub-classes can be used:

classifications: [Configuration_breakdown_type]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
[Logistically_significant_item_breakdown]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml

version (Type='STRING')

The identifier of the breakdown version.

related_product_design (Type= 'ENTITY (Product_view_definition)' )

The product design that relates to this breakdown.

Reference parameters

The following reference parameters are defined for this template:

cmb_bkdn(Type='ENTITY (Breakdown)')

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

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

%^target = $configuration_management_breakdown.cmb_bkdn%

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

cmb_bkdn_vn(Type='ENTITY (Breakdown_version)')

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

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

%^target = $configuration_management_breakdown.cmb_bkdn_vn%

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

bkdwn_of(Type='ENTITY (Breakdown_of)')

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

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

%^target = $configuration_management_breakdown.bkdwn_of%

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

Instantiation path

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(
    id=@id,
    id_class_name='Configuration_breakdown_identification_code',
    id_ecl_id='urn:plcs:rdl:uk_defence',
    id_owner=@source_organization,
    id_owner_class_name='Organization_identification_code',
    id_owner_ecl_id='urn:plcs:rdl:uk_defence',
    bkdn_type=@type,
    bkdn_type_ecl_id='urn:plcs:rdl:uk_defence',
    vn_id=@version,
    vn_id_class_name='Version_identification_code',
    vn_id_ecl_id='urn:plcs:rdl:uk_defence',
    vn_id_owner=@source_organization,
    vn_id_owner_class_name='Organization_identification_code',
    vn_id_owner_ecl_id='urn:plcs:rdl:uk_defence',
    of_product= @related_product_design)/

-- assign ref parameters
%^cmb_bkdn = $representing_breakdown.bkdn%
%^cmb_bkdn_vn = $representing_breakdown.bkdn_vn%

-- %^bkdwn_of = $representing_breakdown.bkdn_of%
-- ^bkdwn_of.of_view > @related_product_design
-- name
/assigning_identification(
    items=^cmb_bkdn,
    id=@name,
    id_class_name='Configuration_breakdown_name',
    id_ecl_id='urn:plcs:rdl:uk_defence',
    org_id=@source_organization,
    org_id_class_name='Organization_identification_code',
    org_id_ecl_id='urn:plcs:rdl:uk_defence')/

-- description
/assigning_descriptor(
    descr=@description,
    class_name='Description',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^cmb_bkdn)/

Instance diagrams

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

/configuration_management_breakdown(id='', source_organization='', name='', description='', type='', version='', related_product_design='')/

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

Figure 4 — Entities instantiated by configuration_management_breakdown template

The instance diagram in Figure 5 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

/configuration_management_breakdown(id='', source_organization='', name='', description='', type='', version='', related_product_design='')/

Figure 5 — Instantiation of configuration_management_breakdown template

Characterizations

No common characterizations of the template configuration_management_breakdown have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.