Template:— support_solution_definition_resource_recommendation (ssrrs)
Context:— UK_Defence
Date: 2009/04/17 12:04:17
Revision: 1.5

This section specifies the template support_solution_definition_resource_recommendation.

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 recommended resources required to support the Platform, system and equipment for which the associated Support Solution Definition was developed. The resources include facilities, utilities, item stockholdings, and human resources.

Business perspective

The Support Solution Definition Resource Recommendation business object is used by those UK_Defence Data Exchange Specifications that require information about the recommended resources required to support the Platform, system and equipment for which the associated Support Solution Definition was developed.

Business object definition


Figure 1 —  Graphical Representation for Business Object Support Solution Definition Resource Recommendation

Figure 1 —  Graphical Representation for Business Object Support Solution Definition Resource Recommendation

Support Solution Definition Resource Recommendation:

The definition of a Support Solution Definition Resource Recommendation object is: Data about those UK_Defence Data Exchange Specifications that require information about the recommended resources required to support the Platform, system and equipment for which the associated Support Solution Definition was developed.

Attribute name

Attribute description

Attribute type

Optionality

Assumptions This is a reference to the assumptions on which the resource recommendations are based Relationship to Assumption Optional (0:?)
Constraints This is a reference to the constraints on which the resource recommendations are based. Relationship to Constraint Optional (0:?)
Documentation This is a reference to the recommended documentation required to support the Platform, system or equipment. Relationship to Recommended Document Optional (0:?)
Facilities This is a reference to the recommended facilities required to support the Platform, system or equipment Relationship to Recommended Facilities Optional (0:?)
Human Resources This is a reference to human resources required to support the Platform, system or equipment. Relationship to Recommended Human Resources Optional (0:?)
ID This is the identifier of the resource recommendations. Identifier Mandatory
Name This is the name of the resource recommendations Identifier Mandatory
Related support solution This is the reference to the support solution for which the resource recommendations have been derived. Relationship to Support Solution Definition Mandatory
Stock Items This is a reference to the items of supply and their stockholdings, required for the support of the Platform, system or equipment. Relationship to Recommended Item Stockholdings Optional (0:?)
Time period This is the time period for which the resource recommendations are made. Intrinsic Mandatory
Utilities A reference to the recommended utilities for this support solution Relationship to Recommended Utilities Optional (0:?)
Version This is the version of the resource recommendations. Intrinsic Mandatory

Table 1 — Support Solution Definition Resource Recommendation 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_solution_definition_resource_recommendation". The text highlighted in blue shows the template parameters.


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

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

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

Figure 3 —  The graphical representation of the support_solution_definition_resource_recommendation template

Input parameters
The following input parameters are defined for this template:
assumptions (Type= 'ENTITY (Document)' , Optional)
This is a reference to the assumptions on which the resource recommendations are based.
constraints (Type= 'ENTITY (Requirement)' , Optional)
This is a reference to the constraints on which the resource recommendations are based.
documentation (Type= 'ENTITY (Required_resource)' , Optional)
This is a reference to the recommended documentation required to support the Platform, system or equipment.
facilities (Type= 'ENTITY (Required_resource)' , Optional)
This is a reference to the recommended facilities required to support the Platform, system or equipment
human_resources (Type= 'ENTITY (Required_resource)' , Optional)
This is a reference to the recommended facilities required to support the Platform, system or equipment
ID (Type='STRING')
This is the identifier of the resource recommendations.
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.
name (Type='STRING')
This is the name of the resource recommendations.
related_support_solution (Type= 'ENTITY (Document)' )
This is the reference to the support solution for which the resource recommendations have been derived.
stock_items (Type= 'ENTITY (Required_resource)' , Optional)
This is the reference to the support solution for which the resource recommendations have been derived.
time_period (Type= 'TYPE (any_number_value)' )
This is the time period for which the resource recommendations are made.
time_period_unit (Type='CLASS')
The units that the time period is in.
The following classes and their sub-classes can be used:
classifications: "Time_unit" (urn:plcs:rdl:std:Time_unit), "Context_dependent_unit" (urn:plcs:rdl:std:Context_dependent_unit)
utilities (Type= 'ENTITY (Required_resource)' , Optional)
A reference to the recommended utilities for this support solution.
version (Type='STRING')
This is the version of the resource recommendations.
Reference parameters
The following reference parameters are defined for this template:
rec_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_solution_definition_resource_recommendation.rec_doc%
where target is the parameter to which the Document is bound.
rec_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_solution_definition_resource_recommendation.rec_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_Solution_Definition_Resource_Recommendation
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_solution_definition_resource_recommendation) namely: ID, related_support_solution, time_period, version.
The instance is referenced by the following template parameter: rec_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='SSD_resource_recommendation_code',
    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=@version,
    doc_vn_id_class_name='Version_identification_code',
    doc_vn_id_ecl_id='urn:plcs:rdl:std',
    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')/
%^rec_doc = $representing_document.document%
%^rec_doc_def = $representing_document.document_definition%

-- ID (mandatory)
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='SSD_resource_recommendation_name',
    items=^rec_doc)/

-- assign a quantity to the recommended document and classify it
/assigning_product_property(
    property_class_name='Estimated_time',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^rec_doc_def)/
%^property = $assigning_product_property.property%

-- assign a value and unit to the asset's book value property
/product_property_numeric(
    value=@time_period,
    unit=@time_period_unit,
    unit_ecl_id='urn:plcs:rdl:uk_defence',
    si_unit='.false.',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:std',
    property=^property)/

-- [optional 0:? assumptions]
/assigning_document(
    doc_ass_role='Related_assumption',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^rec_doc,
    is_assigned_to=@assumptions)/

-- [optional 0:? constraints]
/assigning_document(
    doc_ass_role='Related_constraint',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^rec_doc,
    is_assigned_to=@constraints)/

-- [optional 0:? recommended documentation]
/assigning_document(
    doc_ass_role='Related_recommended_document',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^rec_doc,
    is_assigned_to=@documentation)/

-- [optional 0:? facilities]
/assigning_document(
    doc_ass_role='Related_facilities',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^rec_doc,
    is_assigned_to=@facilities)/

-- [optional 0:? human resources]
/assigning_document(
    doc_ass_role='Related_human_resources',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^rec_doc,
    is_assigned_to=@human_resources)/

-- related support solution
/assigning_document(
    doc_ass_role='Related_support_solution_definition',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^rec_doc,
    is_assigned_to=@related_support_solution)/

-- [optional 0:? stock items]
/assigning_document(
    doc_ass_role='Related_stock_items',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^rec_doc,
    is_assigned_to=@stock_items)/

-- [optional 0:? utilities]
/assigning_document(
    doc_ass_role='Related_utilities',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^rec_doc,
    is_assigned_to=@utilities)/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/support_solution_definition_resource_recommendation(assumptions='@577', constraints='@654', documentation='@874', facilities='@1131', human_resources='@1245', ID='ssdrr123', source_organization='UK_Defence', name='ssdrr123 name', related_support_solution='@968', stock_items='@1358', time_period='ANY_NUMBER_VALUE(200)', time_period_unit='Man_hour', utilities='@1478', version='v01')/
(an illustration of the consolidated support_solution_definition_resource_recommendation template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by support_solution_definition_resource_recommendation template

Figure 4 —  Entities instantiated by support_solution_definition_resource_recommendation 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_solution_definition_resource_recommendation(assumptions='@577', constraints='@654', documentation='@874', facilities='@1131', human_resources='@1245', ID='ssdrr123', source_organization='UK_Defence', name='ssdrr123 name', related_support_solution='@968', stock_items='@1358', time_period='ANY_NUMBER_VALUE(200)', time_period_unit='Man_hour', utilities='@1478', version='v01')/


Figure 5 —  Instantiation of support_solution_definition_resource_recommendation template

Figure 5 —  Instantiation of support_solution_definition_resource_recommendation template

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