Template:— support_component_option (sup_comp_opt)
Context:— UK_Defence
Date: 2009/04/17 11:58:02
Revision: 1.3

This section specifies the template support_component_option.

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 support option recommended for further investigation for the related support component within the context of the related support concept.

Business perspective

The support component option business object is used by those UK_Defence Data Exchange Specifications that require information about the support option recommended for further investigation for the related support component within the context of the related support concept.

Business object definition


Figure 1 —  Graphical Representation for Business Object Support Component Option

Figure 1 —  Graphical Representation for Business Object Support Component Option

Support Component Option:

The definition of a Support Component Option object is: Data about the support option recommended for further investigation for the related support component within the context of the related support concept.

Attribute name

Attribute description

Attribute type

Optionality

ID This is the identifier of the recommended document. Identifier Mandatory
Recommended by This is the reference to the person or organization that made the recommendation. Relationship to Person or Organization Mandatory
Related support component This is the reference to the support component for which related support option is recommended for further investigation. Relationship to Support Component Mandatory
Related support concept This is the reference to the support concept for with this support component option was defined. Relationship to Support Concept Mandatory
Related support option This is the reference to the support option that is recommended for the related support component. Relationship to Support Option Mandatory

Table 1 — Support Component Option attribute details

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


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

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

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


Figure 3 —  The graphical representation of the support_component_option template

Figure 3 —  The graphical representation of the support_component_option template

Input parameters
The following input parameters are defined for this template:
ID (Type='STRING')
This is the identifier of the support component option
source_organization (Type='STRING')
The organization that created the support component option. Additionally a Person or Information System could be defined when either of these are the source; see Identifier template.
recommended_by (Type= 'SELECT (organization_or_person_in_organization_select)' )
This is the reference to the person or organization that made the recommendation.
related_support_component (Type= 'ENTITY (Document)' )
This is the reference to the support component for which related support option is recommended for further investigation.
related_support_concept (Type= 'ENTITY (Task_method)' )
This is the reference to the support concept for with this support component option was defined.
related_support_option (Type= 'ENTITY (Document)' )
This is the reference to the support option that is recommended for the related support component.
Reference parameters
The following reference parameters are defined for this template:
doc(Type='ENTITY (Document)')
Allow the Document entity instantiated in this path to be referenced when this template is used.
Note: The Document entity can be referenced in a template path by:
%^target = $support_component_option.doc%
where target is the parameter to which the Document is bound.
doc_def(Type='ENTITY (Document_definition)')
Allow the Document_definition entity instantiated in this path to be referenced when this template is used.
Note: The Document_definition entity can be referenced in a template path by:
%^target = $support_component_option.doc_def%
where target is the parameter to which the Document_definition is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Support_component_option
Each instance of the entity (Document) within the data set shall be uniquely identified by a combination of the following parameters on this template (support_component_option) namely: ID, related_support_component, related_support_concept, related_support_option.
The instance is referenced by the following template parameter: doc.
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.
-- Instantiate a document
/representing_document(
    doc_id=@ID,
    doc_id_class_name='Support_component_option_identifier',
    doc_id_ecl_id='urn:plcs:rdl:uk_defence',
    doc_org_id=@source_organization,
    doc_org_id_class_name='Identifier_owner',
    doc_org_id_ecl_id='urn:plcs:rdl:uk_defence',
    doc_vn_id='/NULL',
    doc_vn_id_class_name='/NULL',
    doc_vn_id_ecl_id='urn:plcs:rdl:uk_defence',
    doc_vn_org_id='/NULL',
    doc_vn_org_id_class_name='/NULL',
    doc_vn_org_id_ecl_id='urn:plcs:rdl:uk_defence',
    domain='Product_life_cycle_support',
    domain_ecl_id='urn:plcs:rdl:std',
    life_cycle_stage='Support_stage',
    life_cycle_stage_ecl_id='urn:plcs:rdl:std')/
%^doc = $representing_document.document%
%^doc_def = $representing_document.document_definition%

-- recommended_by
/assigning_document(
    doc_ass_role='Recommended_by_assignment',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^doc,
    is_assigned_to=@recommended_by)/

-- related_support_component
/assigning_document(
    doc_ass_role='Support_component_assignment',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^doc,
    is_assigned_to=@related_support_component)/

-- related_support_concept
/assigning_document(
    doc_ass_role='Support_concept_assignment',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^doc,
    is_assigned_to=@related_support_concept)/

-- related_support_option
/assigning_document(
    doc_ass_role='Support_option_assignment',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^doc,
    is_assigned_to=@related_support_option)/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/support_component_option(ID='RC123', source_organization='UK_Defence', recommended_by='@997', related_support_component='@904', related_support_concept='@738', related_support_option='@818')/
(an illustration of the consolidated support_component_option template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by support_component_option template

Figure 4 —  Entities instantiated by support_component_option 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:
/support_component_option(ID='RC123', source_organization='UK_Defence', recommended_by='@997', related_support_component='@904', related_support_concept='@738', related_support_option='@818')/


Figure 5 —  Instantiation of support_component_option template

Figure 5 —  Instantiation of support_component_option template

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

© UK MOD 2010 — All rights reserved