Template:— resource_requirement (res_req)
Context:— UK_Defence		 Date: 2009/04/17 11:42:30
Revision: 1.2
CoverContentsDescriptionBus. perspectiveBus. obj.Model diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssuesin situ

This section specifies the template resource_requirement.

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

Business perspective

This information object represents the identification and quantification of a resource that is needed to perform an individual task or list of tasks.

Business object definition

This information object represents the identification and quantification of a resource that is needed to perform an individual task or list of tasks.



Figure 1 —  Graphical Representation for Business Object Resource Requirement

Figure 1 —  Graphical Representation for Business Object Resource Requirement

Attribute name

Attribute description

Attribute type

Optionality
ID This attribute provides the identification of the Resource Requirement. Identifier Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the Resource Requirement. intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the Resource Requirement. This must be one of the classes provided. Required_resource_identification_code Mandatory
Identifier.source_organization This attribute is the value representing the source organization that provides the id of the Identifier given to the Resource Requirement. This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Minimum quantity This is the minimum quantity of the required resource. Intrinsic Mandatory
Minimum time This is the minimum time of the required resource. Intrinsic Mandatory
Recommended quantity This is the recommended quantity of the required resource. Intrinsic Optional
Recommended time This is the recommended time of the required resource. Intrinsic Optional
Required by This is the reference to the item for which the related resource is required. SELECT Mandatory
Required resource This is the reference to the item that is required as a resource for the related item. SELECT Mandatory

Table 1 — Resource Requirement attribute details

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


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

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

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

Figure 3 —  The graphical representation of the resource_requirement template

Input parameters
The following input parameters are defined for this template:
id (Type='STRING')
The identifier of the required resource.
source_organization (Type='STRING')
The organization or information system that created the associated identifier. Alternatively this could be set to /NULL and when Person or Information System is the source; see Identifier template characterizations.
minimum_quantity (Type='STRING')
The minimum quantity of required resource.
minimum_time (Type='STRING')
The minimum time for which the resource would be required.
recommended_quantity (Type='STRING', Optional)
The recommended quantity of required resource.
recommended_time (Type='STRING', Optional)
The recommended time for which the resource would be required.
required_by (Type= 'SELECT (required_resource_item)' )
The item for which the required resource is required.
required_resource (Type= 'SELECT (resource_item_select)' )
The resource item.
Reference parameters
The following reference parameters are defined for this template:
req_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 = $resource_requirement.req_res_item%
where target is the parameter to which the Resource_item is bound.
reqd_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 = $resource_requirement.reqd_res_item%
where target is the parameter to which the Required_resource_by_resource_item is bound.
reqd_res_asg(Type='ENTITY (Required_resource_assignment)')
Allow the Required_resource_assignment entity instantiated in this path to be referenced when this template is used.
Note: The Required_resource_assignment entity can be referenced in a template path by:
%^target = $resource_requirement.reqd_res_asg%
where target is the parameter to which the Required_resource_assignment 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_resource_item_realization(
    res_item_id=@id,
    res_item_id_class='Resource_item_identification_code',
    res_item_id_ecl_id='urn:plcs:rdl:uk_defence',
    res_item_id_org_id=@source_organization,
    res_item_id_org_id_class='Organization_identification_code',
    res_item_id_org_id_ecl_id='urn:plcs:rdl:uk_defence',
    res_item_items=@required_resource)/

-- assign ref parameters
%^req_res_item = $representing_resource_item_realization.res_item%
/assigning_required_resource(
    class_name='Required_resource',
    ecl_id='urn:plcs:rdl:uk_defence',
    item=@required_by,
    resource_item=^req_res_item)/

-- assign ref parameters
%^reqd_res_asg = $assigning_required_resource.req_res_asg%
%^reqd_res_item = $assigning_required_resource.req_res_item%

-- minimum quantity
/assigning_resource_property(
    property_class_name='Resource_property_quantified_min',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^reqd_res_item)/
%^property_qty_min = $assigning_resource_property.property%
/resource_property_numeric(
    value=@minimum_quantity,
    unit='Count',
    unit_ecl_id='urn:plcs:rdl:uk_defence',
    si_unit='false',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:uk_defence',
    property=^property_qty_min)/

-- minimum time
/assigning_resource_property(
    property_class_name='Resource_property_time_min',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^reqd_res_item)/
%^property_time_min = $assigning_resource_property.property%
/resource_property_numeric(
    value=@minimum_time,
    unit='Man_hour',
    unit_ecl_id='urn:plcs:rdl:uk_defence',
    si_unit='true',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:uk_defence',
    property=^property_time_min)/

-- recommended quantity
/assigning_resource_property(
    property_class_name='Resource_property_quantified_rec',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^reqd_res_item)/
%^property_qty_rec = $assigning_resource_property.property%
/resource_property_numeric(
    value=@recommended_quantity,
    unit='Count',
    unit_ecl_id='urn:plcs:rdl:uk_defence',
    si_unit='false',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:uk_defence',
    property=^property_qty_rec)/

-- recommended time
/assigning_resource_property(
    property_class_name='Resource_property_time_rec',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^reqd_res_item)/
%^property_time_rec = $assigning_resource_property.property%
/resource_property_numeric(
    value=@recommended_time,
    unit='Man_hour',
    unit_ecl_id='urn:plcs:rdl:uk_defence',
    si_unit='true',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:uk_defence',
    property=^property_time_rec)/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/resource_requirement(id='req-res-921', source_organization='642l', required_by='#', required_resource='#')/
(an illustration of the consolidated resource_requirement template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by resource_requirement template

Figure 4 —  Entities instantiated by resource_requirement 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:
/resource_requirement(id='req-res-921', source_organization='642l', required_by='#', required_resource='#')/


Figure 5 —  Instantiation of resource_requirement template

Figure 5 —  Instantiation of resource_requirement template

Characterizations
The following section details how the resource_requirement template can be optionally characterized by assigning other constructs to it. These are characterizations commonly applied to the template. The ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.
The EXPRESS-G diagram in Figure 6 shows the possible characterizations of the template "resource_requirement".


Figure 6 —  Characterizations for required resource

Figure 6 —  Characterizations for required resource

The following characterizations may apply:
Characterization Status Assignment

NOTE   this characterization is optional.

A UK_Defence.resource_requirement may have one or more status assigned to it, through the use of the following templates (or those based upon these): UK_Defence.status_assignment. The following template calls show how these characterizations might be instantiated.

/status_assignment(assigned_status='', assigned_status_ecl_id='', ID='', ID_type='', ID_organization='', subject='', type='', type_ecl_id='')/
Characterization Document Association

NOTE   this characterization is optional.

A UK_Defence.resource_requirement may have specific documents assigned to it, through the use of the following templates (or those based upon these): UK_Defence.document_association , and the associated UK_Defence.document. The following template calls show how these characterizations might be instantiated.

/document_association(id='', type='', source_organization='', purpose='', related_document='', related_item='')/

© UK MOD 2010 — All rights reserved