Template:— recommended_utilities (recomm_utilities)
Context:— UK_Defence
Date: 2010/02/17 17:10:35
Revision: 1.7

This section specifies the template recommended_utilities.

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

Business perspective

This information object identifies the recommended utilities required, over a defined period of time, to support the Platform, system and equipment for which the associated Support Solution Definition was developed.

Business object definition

This information object identifies the recommended utilities required, over a defined period of time, to support the Platform, system and equipment for which the associated Support Solution Definition was developed.



Figure 1 —  Graphical Representation for Business Object Recommended Utilities

Figure 1 —  Graphical Representation for Business Object Recommended Utilities

Attribute name

Attribute description

Attribute type

Optionality

Assumptions This is a reference to the assumptions on which the utility recommendations are based. Relationship to Assumption. Optional (0:?)
Constraints This is a reference to the constraints on which the utility recommendations are based. Relationship to Constraint. Optional (0:?)
ID This is the identifier of the utility recommendations. Identifier Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the utility recommendations. intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the utility recommendations. Recommended_utilities_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 utility recommendations. This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Name This is the name of the utility recommendations. intrinsic Mandatory
Related support solution This is the reference to the support solution for which the recommended utilities have been derived. Relationship to Support Solution Definition. Mandatory
Time Period This is the time period for which the utility recommendations are made. intrinsic Mandatory
Utilities This is the reference to the individual utilities recommended for this support solution. Relationship to Utility. Optional (0:?)
Utility Types This is a reference to the Utility types recommended for this support solution. Relationship to Recommended Utility Type. Optional (0:?)
Version This is the version of the utility recommendations. intrinsic Mandatory

Table 1 — Recommended Utilities attribute details

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


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

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

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

Figure 3 —  The graphical representation of the recommended_utilities template

Input parameters
The following input parameters are defined for this template:
assumptions (Type= 'ENTITY (Document_version)' , Optional)
The related assumptions.
constraints (Type= 'ENTITY (Requirement_view_definition)' , Optional)
The related constraints.
id (Type='STRING')
The identifier applied to the recommended utilities.
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 utilities.
related_support_solution (Type= 'ENTITY (Document_version)' )
The related support solution.
time_period (Type='STRING')
The time period of the recommendation.
time_period_units (Default=Man_hour,Type='CLASS', Optional)
The time for which the resource is allocated to the activity.
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 (Product_as_individual)' , Optional)
The recommended utilities.
utility_types (Type= 'ENTITY (Required_resource)' , Optional)
The required utility types.
version (Type='STRING')
The version of the recommendation.
Reference parameters
The following reference parameters are defined for this template:
utility_req_res_spec(Type='ENTITY (Required_resource_by_specification)')
Allow the Required_resource_by_specification entity instantiated in this path to be referenced when this template is used.
Note: The Required_resource_by_specification entity can be referenced in a template path by:
%^target = $recommended_utilities.utility_req_res_spec%
where target is the parameter to which the Required_resource_by_specification is bound.
utility_req_res_item(Type='ENTITY (Required_resource_by_resource_item)')
Allow the Required_resource_by_resource_item entity instantiated in this path to be referenced when this template is used.
Note: The Required_resource_by_resource_item entity can be referenced in a template path by:
%^target = $recommended_utilities.utility_req_res_item%
where target is the parameter to which the Required_resource_by_resource_item is bound.
utility_res_item(Type='ENTITY (Resource_item)')
Allow the Resource_item entity instantiated in this path to be referenced when this template is used.
Note: The Resource_item entity can be referenced in a template path by:
%^target = $recommended_utilities.utility_res_item%
where target is the parameter to which the Resource_item 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.
-- required resource
Required_resource_by_specification
%^utility_req_res_spec = Required_resource_by_specification%

-- utilities
/representing_resource_item_realization(
    res_item_id='',
    res_item_id_class='',
    res_item_id_ecl_id='urn:plcs:rdl:std',
    res_item_id_org_id='',
    res_item_id_org_id_class='',
    res_item_id_org_id_ecl_id='urn:plcs:rdl:std',
    res_item_items=@utilities)/
%^utility_res_item = $representing_resource_item_realization.res_item%

-- required resource resource item
Required_resource_by_resource_item
Required_resource_by_resource_item.resource_item -> ^utility_res_item
%^utility_req_res_item = Required_resource_by_resource_item%

-- relate required resources specification and resource item
/representing_required_resource_relationship(
    req_res_rel_class_name='Required_resource_relationship',
    req_res_rel_ecl_id='urn:plcs:rdl:std',
    relating_req_res=^utility_req_res_spec,
    related_req_res=^utility_req_res_item)/

-- [optional utility_types [0:?]]
/representing_required_resource_relationship(
    req_res_rel_class_name='Required_resource_relationship',
    req_res_rel_ecl_id='urn:plcs:rdl:std',
    relating_req_res=^utility_req_res_spec,
    related_req_res=@utility_types)/

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

-- [Optional constraints 0:?]
Requirement_assignment
Requirement_assignment.assigned_requirement -> @constraints
Requirement_assignment.assigned_to -> ^utility_req_res_spec

-- related_support_solution
/assigning_document(
    doc_ass_role='Related_support_solution_definition',
    doc_ar_ecl_id='urn:plcs:rdl:std',
    assigned_document=@related_support_solution,
    is_assigned_to=^utility_req_res_spec)/

-- provide the role of the required resource
/assigning_reference_data(
    items=^utility_req_res_spec,
    class_name='recommended',
    ecl_id='urn:plcs:rdl:uk_defence')/

-- id
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='Recommended_utilities_id_code',
    items=^utility_req_res_spec )/

-- name
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='Recommended_utilities_name',
    items=^utility_req_res_spec )/

-- version
/assigning_descriptor(
    descr=@version,
    class_name='Recommended_utilities_version',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^utility_req_res_spec)/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/recommended_utilities(assumptions='#75', constraints='#152', id='rec_utilities_1', source_organization='6421', name='Water_supplies', related_support_solution='#372', time_period='24', time_period_units='Hour', utilities='#407', utiltity_types='#506', version='1')/
(an illustration of the consolidated recommended_utilities template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by recommended_utilities template

Figure 4 —  Entities instantiated by recommended_utilities 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:
/recommended_utilities(assumptions='#75', constraints='#152', id='rec_utilities_1', source_organization='6421', name='Water_supplies', related_support_solution='#372', time_period='24', time_period_units='Hour', utilities='#407', utiltity_types='#506', version='1')/


Figure 5 —  Instantiation of recommended_utilities template

Figure 5 —  Instantiation of recommended_utilities template

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