Template:— support_environment (sup_env)
Context:— UK_Defence
Date: 2009/04/17 11:58:03
Revision: 1.3

This section specifies the template support_environment.

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 collection of information that defines the support environment for the related platform, systems and equipment, including references to the assumptions and requirements from which it was derived.

Business perspective

The support environment business object is used by those UK_Defence Data Exchange Specifications that require information that defines the support environment for the related platform, systems and equipment.

Business object definition


Figure 1 —  Graphical Representation for Business Object Support Environment

Figure 1 —  Graphical Representation for Business Object Support Environment

Support Environment:

The definition of an Support Environment object is: Data about the support environment for the related platform, systems and equipment.

Attribute name

Attribute description

Attribute type

Optionality

ID This is the Identifier of the support environment Identifier Mandatory
PSE requiring support This is the reference to the PSE for which the support environment is defined. Relationship to Platform System Equipment Mandatory
Related assumptions This is the reference to the assumptions from which the support environment has been derived. Relationship to Assumption Optional (0:?)
Related constraints This is the reference to the constraints imposed upon definition of the support environment. Relationship to Constraint Optional (0:?)
Related requirements This is the reference to the requirements from which the support environment has been derived. Relationship to Requirement Mandatory (1:?)
Related supply nodes This is the reference to the supply nodes that form part of the support environment. Relationship to Supply Node Mandatory (1:?)
Related support nodes This is the reference to the support nodes that form part of the support environment. Relationship to Support Node Mandatory (1:?)
Related support organizations This is the reference to the organization that performs support activities at the support node. Relationship to Organization Mandatory

Table 1 — Support Environment 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_environment". The text highlighted in blue shows the template parameters.


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

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

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_environment template

Figure 3 —  The graphical representation of the support_environment template

Input parameters
The following input parameters are defined for this template:
ID (Type='STRING')
This is the identifier of the support environment.
source_organization (Type='STRING')
The organization that created the associated identifier. Additionally a Person or Information System could be defined when either of these are the source; see Identifier template.
PSE_requiring_support (Type= 'ENTITY (Product_group)' )
This is the reference to the PSE for which the support environment is defined.
related_assumptions (Type= 'ENTITY (Document)' )
This is the reference to the organization that performs support activities at the support node.
related_constraints (Type= 'ENTITY (Requirement)' )
This is the reference to the constraints imposed upon definition of the support environment.
related_requirements (Type= 'ENTITY (Requirement)' )
This is the reference to the requirements from which the support environment has been derived.
related_supply_nodes (Type= 'ENTITY (Organization)' )
This is the reference to supply nodes that form part of the support environment.
related_support_nodes (Type= 'ENTITY (Organization)' )
This is the reference to support nodes that form part of the support environment.
related_support_organizations (Type= 'ENTITY (Organization)' )
This is the reference to the organization that performs support activities at the support node.
Reference parameters
The following reference parameters are defined for this template:
sup_env(Type='ENTITY (State_definition)')
Allow the State_definition entity instantiated in this path to be referenced when this template is used.
Note: The State_definition entity can be referenced in a template path by:
%^target = $support_environment.sup_env%
where target is the parameter to which the State_definition is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Support_environment
Each instance of the entity (State_definition) within the data set shall be uniquely identified by a combination of the following parameters on this template (support_environment) namely: ID, PSE_requiring_support.
The instance is referenced by the following template parameter: sup_env.
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.
-- initiate assigning_state_type (mandatory)
/assigning_state_type(
    sd_class_name="Support_environment",
    sd_ecl_id='urn:plcs:rdl:uk_defence',
    sd_role_class_name="Support_state_definition_context",
    sd_role_ecl_id='urn:plcs:rdl:std',
    assigned_to=@PSE_requiring_support)/
%^sup_env = $assigning_state_type.state_def%

-- ID (mandatory)
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='Support_environment_identifier',
    items=^sup_env)/

-- related_support_nodes (mandatory)
Organization_or_person_in_organization_assignment

-- Set the Organization_or_person_in_organization_assignment attribute role to be ignored
Organization_or_person_in_organization_assignment.role = '/IGNORE'

-- Assign the Organization_or_person_in_organization_assignment to the support_environment
Organization_or_person_in_organization_assignment.items -> ^sup_env

-- Assign the assigned_entity parameter
Organization_or_person_in_organization_assignment.assigned_entity -> @related_support_nodes

-- related_supply_node (mandatory)
Organization_or_person_in_organization_assignment

-- Set the Organization_or_person_in_organization_assignment attribute role to be ignored
Organization_or_person_in_organization_assignment.role = '/IGNORE'

-- Assign the Organization_or_person_in_organization_assignment to the support_environment
Organization_or_person_in_organization_assignment.items -> ^sup_env

-- Assign the assigned_entity parameter
Organization_or_person_in_organization_assignment.assigned_entity -> @related_supply_nodes

-- related_support_organizations (mandatory)
Organization_or_person_in_organization_assignment

-- Set the Organization_or_person_in_organization_assignment attribute role to be ignored
Organization_or_person_in_organization_assignment.role = '/IGNORE'

-- Assign the Organization_or_person_in_organization_assignment to the support_environment
Organization_or_person_in_organization_assignment.items -> ^sup_env

-- Assign the assigned_entity parameter
Organization_or_person_in_organization_assignment.assigned_entity -> @related_support_organizations

-- Instantiate the Requirement_assignment entity and link it to state_definition.
Requirement_assignment.assigned_requirement -> @related_requirements
Requirement_assignment.id = '/IGNORE'
Requirement_assignment.description = '/IGNORE'

-- [ OPTIONAL Document_assignment ] to indicate the assumption
Document_assignment

-- Set the OPTIONAL Document_assignment attribute role to be ignored
Document_assignment.role = '/IGNORE'
Document_assignment.assigned_document -> @related_assumptions
Document_assignment.is_assigned_to -> ^sup_env

-- [ OPTIONAL Requirement_assignment ] entity and link it to state_definition.
Requirement_assignment.assigned_requirement -> @related_constraints
Requirement_assignment.id = '/IGNORE'
Requirement_assignment.description = '/IGNORE'
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Organization_or_person_in_organization_assignment.role '/IGNORE'
Organization_or_person_in_organization_assignment.role '/IGNORE'
Organization_or_person_in_organization_assignment.role '/IGNORE'
Requirement_assignment.id '/IGNORE'
Requirement_assignment.description '/IGNORE'
Document_assignment.role '/IGNORE'
Requirement_assignment.id '/IGNORE'
Requirement_assignment.description '/IGNORE'
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/support_environment(ID='SE123', source_organization='UK_Defence', PSE_requiring_support='@114', related_assumptions='@496', related_constraints='@578', related_requirements='@338', related_supply_nodes='@299', related_support_nodes='@260', related_support_organizations='@78')/
(an illustration of the consolidated support_environment template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by support_environment template

Figure 4 —  Entities instantiated by support_environment 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_environment(ID='SE123', source_organization='UK_Defence', PSE_requiring_support='@114', related_assumptions='@496', related_constraints='@578', related_requirements='@338', related_supply_nodes='@299', related_support_nodes='@260', related_support_organizations='@78')/


Figure 5 —  Instantiation of support_environment template

Figure 5 —  Instantiation of support_environment template

Characterizations
No common characterizations of the template support_environment 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