Template:— facility_demand (fac_dmnd)
Context:— UK_Defence
Date: 2009/04/17 11:21:20
Revision: 1.2

This section specifies the template facility_demand.

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 demand for a facility or a type of facility, for the purpose of carrying out an activity over a period of time.

Business perspective

A Facility Demand is the means to demand a facility or a type of facility, for the purpose of carrying out an activity over a period of time.

Business object definition

This information object represents the information about a Facility Demand.



Figure 1 —  A MOOD Business Architect representation of the Business Object: Facility Demand

Figure 1 —  A MOOD Business Architect representation of the Business Object: Facility Demand

The attributes of the Facility Demand object are tabled below.

Attribute name

Attribute description

Attribute type

Optionality

Required start date This is the start date of the period over which the facility is required. Relationship to Date_time Mandatory
Required end date This is the end date of the period over which the facility is required. Relationship to Date_time Mandatory
Authority to demand This is the authority to demand the related facility. intrinsic Mandatory
Reason This is the reason for the demand for a facility. intrinsic Mandatory
Special requirements This is for specifications of any special requirements. intrinsic Mandatory
Preferred Facility This is the reference to the actual facilty that is preferred. Relationship to Facility Optional
Type of facility This is a reference to the required facility type. Relationship to Facility Type Mandatory

Table 1 — Facility Demand attribute details

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


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

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

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

Figure 3 —  The graphical representation of the facility_demand template

Input parameters
The following input parameters are defined for this template:
id (Type='STRING')
The identifier assigned to a requirement.
source_organization_id (Type='STRING')
Intrinsic
lack_of_item_impact (Type='STRING', Optional)
This is the description of the impact of the resource demand not being met.
demanding_organization_unit (Type= 'ENTITY (Organization)' )
The organization or unit demanding the resource.
demanding_person (Type= 'ENTITY (Person_in_organization)' )
The person making the resource demand.
demand_date (Type= 'SELECT (date_or_date_time_select)' )
This is the date the resource demand is made.
demanded_quantity (Type='STRING')
The quantity of the demanded resource.
demanded_quantity_unit (Type='CLASS')
The units of measure for the quantity of the demanded resource.
The following classes and their sub-classes can be used:
classifications: "Unit" (urn:plcs:rdl:std:Unit)
demanded_quantity_si_unit (Type='BOOLEAN')
Value should be set to true if the unit is a SI base unit defined by ISO, i.e. kilogram (kg) for Mass, second (s) for Time, metre (m) for Displacement, ampere (A) for Electrical current, kelvin (K) for Temperature, mole (mol) for Amount of substance, and candela (cd) for Luminous intensity. If this is not the case it should be set to false.
Note that the representation of true and false depends on exchange format. In Part 11 (a STEP file) true is represented by the string ".T.", and false by ".F.", while in Part 28 (XML) they are represented by text strings "true" and "false".
authority_to_demand (Type='STRING')
This is the authority to demand the related facility.
reason (Type='STRING')
This is the reason for the demand for a facility.
special_requirements (Type='STRING')
This is for specifications of any special requirements.
required_start_date (Type= 'SELECT (date_or_date_time_select)' )
This is the start date of the period over which the facility is required.
required_end_date (Type= 'SELECT (date_or_date_time_select)' )
This is the end date of the period over which the facility is required.
prefered_facility (Type= 'ENTITY (Product_as_realized)' , Optional)
This is the reference to the actual facilty that is preferred.
type_of_facility (Type= 'ENTITY (Part_version)' )
This is a reference to the required facility type.
Reference parameters
The following reference parameters are defined for this template:
facility_demand(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 = $facility_demand.facility_demand%
where target is the parameter to which the Resource_item is bound.
ref_demand(Type='ENTITY (Activity)')
Allow the Activity entity instantiated in this path to be referenced when this template is used.
Note: The Activity entity can be referenced in a template path by:
%^target = $facility_demand.ref_demand%
where target is the parameter to which the Activity 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.
-- Facility demand is based upon resource demand
/resource_demand(
    id=@id,
    source_organization_id=@source_organization_id,
    lack_of_item_impact=@lack_of_item_impact,
    demanding_organization_unit=@demanding_organization_unit,
    demanding_person=@demanding_person,
    demand_date=@demand_date,
    demanded_quantity=@demanded_quantity,
    demanded_quantity_unit=@demanded_quantity_unit,
    demanded_quantity_si_unit=@demanded_quantity_si_unit)/
%^ref_demand = $resource_demand.resource_demand%

-- Create the resource item to link to the Type of Facility and [Optional Prefered Facility]
/representing_resource_item_realization(
    res_item_id=@id,
    res_item_id_class='Resource_item_identification_code',
    res_item_id_ecl_id='urn:plcs:rdl:std',
    res_item_id_org_id=@source_organization_id,
    res_item_id_org_id_class='Organization_identification_code',
    res_item_id_org_id_ecl_id='urn:plcs:rdl:std',
    res_item_items=@type_of_facility,
    res_item_items=@prefered_facility)/
%^facility_demand = $representing_resource_item_realization.res_item%

-- Relate the refered resource demand to the facility demand
/assigning_required_resource(
    item=^ref_demand,
    resource_item=^facility_demand,
    class_name='Required_resource',
    ecl_id='urn:plcs:rdl:std')/

-- authority_to_demand
/assigning_descriptor(
    descr=@authority_to_demand,
    class_name='Authority_to_demand',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^facility_demand)/

-- reason
/assigning_descriptor(
    descr=@reason,
    class_name='Reason',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^facility_demand)/

-- special_requirements
/assigning_descriptor(
    descr=@special_requirements,
    class_name='Special_requirements',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^facility_demand)/

-- Required_start_date
Date_or_date_time_assignment
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> ^facility_demand
Date_or_date_time_assignment.assigned_date -> @required_start_date

-- Required_end_date
-- Note this is a second instance or usage of Date_or_date_time_assignment - Graphical Instance cannot handle this
Date_or_date_time_assignment
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> ^facility_demand
Date_or_date_time_assignment.assigned_date -> @required_end_date
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Date_or_date_time_assignment.role '/IGNORE'
Date_or_date_time_assignment.role '/IGNORE'
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/facility_demand(id='', source_organization_id='', lack_of_item_impact='', demanding_organization_unit='@306', demanding_person='@273', demand_date='@135', demanded_quantity='', demanded_quantity_unit='', demanded_quantity_si_unit='', authority_to_demand='', reason='', special_requirements='', required_start_date='@125', required_end_date='@130', prefered_facility='@140', type_of_facility='@217')/
(an illustration of the consolidated facility_demand template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by facility_demand template

Figure 4 —  Entities instantiated by facility_demand 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:
/facility_demand(id='', source_organization_id='', lack_of_item_impact='', demanding_organization_unit='@306', demanding_person='@273', demand_date='@135', demanded_quantity='', demanded_quantity_unit='', demanded_quantity_si_unit='', authority_to_demand='', reason='', special_requirements='', required_start_date='@125', required_end_date='@130', prefered_facility='@140', type_of_facility='@217')/


Figure 5 —  Instantiation of facility_demand template

Figure 5 —  Instantiation of facility_demand template

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