Template:— facility (fclt)
Context:— UK_Defence
Date: 2009/04/17 21:34:15
Revision: 1.4

This section specifies the template facility.

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 an installation providing one or more functional capabilities necessary to provide support to one or more equipment programmes.

Business perspective

The facility business object is used by those UK_Defence Data Exchange Specifications that require information about facilities.

NOTE    A Facility may be permanently fixed and located at a site (such as buildings, runways, dry docks, roads, bridges, railways ie. things not designed to be moved).

NOTE    A Facility may be mobile (such as mobile workshops, portakabins, mobile bridges ie. things designed to be portable, but only functional when installed at a location).

NOTE    A Facility may also be part of the end item equipment itself (such as workshops and hangars on board ships).

Business object definition


Figure 1 —  Graphical Representation for Business Object Facility

Figure 1 —  Graphical Representation for Business Object Facility

Facility:

The definition of an Facility object is: Data about an installation providing one or more functional capabilities necessary to provide support to one or more equipment programmes.

Attribute name

Attribute description

Attribute type

Optionality

Base location This is the reference to the location where a (mobile) facility is based. Location Optional
Capacity This is a description of the capacity / capability of the facility Intrinsic Optional
Description This is the description of the Facility. Intrinsic Optional
ID This is the Identifier of the Facility. Identifier Mandatory
Located at This is the reference to the location of the Facility. Location Mandatory
Location end date This is the date and time on which the Facility ceased to be at the relating location. Location Optional
Location start date This is the date and time on which the Facility was located at the relating location. Location Optional
Name This is the name of the Facility. Intrinsic Mandatory
Owner This is the reference to the organization that owns the Facility. Organization Optional
Type This is the reference to the type of the Facility. Facility_type Mandatory

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


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

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

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 template

Figure 3 —  The graphical representation of the facility template

Input parameters
The following input parameters are defined for this template:
ID (Type='STRING')
The facility identifier.
ID_source_organization (Type='STRING')
The identifier of the organization responsible for the facility identifier.
Name (Type='STRING')
The facility name.
Name_source_organization (Type='STRING')
The identifier of the organization responsible for the facility name.
Type (Type= 'ENTITY (Product_version)' )
The facility type.
Located_at (Type= 'ENTITY (Location)' )
The location of the facility.
Reference parameters
The following reference parameters are defined for this template:
facility(Type='ENTITY (Product_as_individual)')
Allow the Product_as_individual entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual entity can be referenced in a template path by:
%^target = $facility.facility%
where target is the parameter to which the Product_as_individual is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique Facility
Each instance of the entity (Product_as_individual) within the data set shall be uniquely identified by a combination of the following parameters on this template (facility) namely: ID, ID_source_organization, Name, Type, Located_at.
The instance is referenced by the following template parameter: facility.
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_product_as_realized(
    id=@ID,
    id_class_name='Facility_identification_code',
    id_ecl_id='urn:plcs:rdl:uk_defence',
    id_owner=@ID_source_organization,
    id_owner_class_name='Organization_identification_code',
    id_owner_ecl_id='urn:plcs:rdl:std',
    vn_id='/NULL',
    vn_id_class_name='Product_as_individual_identification_code',
    vn_id_ecl_id='urn:plcs:rdl:std',
    vn_id_owner='/NULL',
    vn_id_owner_class_name='Organization_name',
    vn_id_owner_ecl_id='urn:plcs:rdl:std',
    life_cycle_stage='Support_stage',
    life_cycle_stage_ecl_id='urn:plcs:rdl:std',
    domain='Through_life_support_standard',
    domain_ecl_id='urn:plcs:rdl:uk_defence',
    product_design_version=@Type)/
%^facility = $representing_product_as_realized.pai%
/identifier(
    ID=@Name,
    source_organization=@Name_source_organization,
    type='Facility_name')/
Location_assignment
Location_assignment.entity_for_location -> ^facility
Location_assignment.location_for_assignment -> @Located_at
Location_assignment.description = '/IGNORE'
Location_assignment.role = '/IGNORE'
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Location_assignment.description '/IGNORE'
Location_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(ID='F01', ID_source_organization='UK_Defence', Name='My Facility', Name_source_organization='UK_Defence', Type='@154', Located_at='@154')/
(an illustration of the consolidated facility template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by facility template

Figure 4 —  Entities instantiated by facility 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(ID='F01', ID_source_organization='UK_Defence', Name='My Facility', Name_source_organization='UK_Defence', Type='@154', Located_at='@154')/


Figure 5 —  Instantiation of facility template

Figure 5 —  Instantiation of facility template

Characterizations
The following section details how the facility 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 "facility".


Figure 6 —  Characterizations for facility

Figure 6 —  Characterizations for facility

The following characterizations may apply:
Characterization location_end_date

NOTE   this characterization is optional.

The date when the facility ceased to be at the location can be represented by assigning a date (using the relationship Date_or_date_time_assignment) to the Product_as_individual using the assigning_time template with the Date_time classified as a type of "Date actual end" (urn:plcs:rdl:std:Date actual end).

NOTE    The assignment of dates is described the capability C036: assigning_date_time.

/Location end date(date_class_name='Date_actual_location_end', date_ecl_id='urn:plcs:rdl:uk_defence', year='2008', month='01', day_in_month_number='30', hour='17', minute='0', second='0', sense='.EXACT.', hour_offset='0', minute_offset='0', items='Location')/
Characterization location_start_date

NOTE   this characterization is optional.

The date when the facility was placed at the location can be represented by assigning a date (using the relationship Date_or_date_time_assignment) to the Product_as_individual using the assigning_time template with the Date_time classified as a type of "Date actual start" (urn:plcs:rdl:std:Date actual start).

NOTE    The assignment of dates is described the capability C036: assigning_date_time.

/Location end date(date_class_name='Date_actual_location_start', date_ecl_id='urn:plcs:rdl:uk_defence', year='2008', month='01', day_in_month_number='03', hour='17', minute='0', second='0', sense='.EXACT.', hour_offset='0', minute_offset='0', items='Location')/
Characterization Owner

NOTE   this characterization is optional.

The owner of the facility may be represented by assigning Organization using the UK_Defence.organization template and the Organization_or_person_in_organization_assignment entity.

/owner(id='K0999', source_organization='BAE SYSTEMS', ID_type='Identification_code', name='BAE SYSTEMS')/
Characterization Capacity

NOTE   this characterization is optional.

A description of the capacity or capability of the facility may be reresented by assigning a Document using the Document_assignment in the assigning_descriptor template.

NOTE    The assignment of Document is described in the capability C095: assigning_descriptor.

/capacity(descr='Processing facility.', class_name='Capability', ecl_id='urn:plcs:rdl:uk_defence', is_assigned_to='@1')/
Characterization Description

NOTE   this characterization is optional.

A description of the facility may be reresented by assigning a Document using Document_assignment as detailed in the assigning_descriptor template.

NOTE    The assignment of Document is described in the capability C095: assigning_descriptor.

/description(descr='The processing facility in Bath.', class_name='Description', ecl_id='urn:plcs:rdl:std', is_assigned_to='@1')/
Characterization Base location

NOTE   this characterization is optional.

A relationship to the base location of the facility may be established using Location_assignment. The target of that realtionship (if instantiated) would be a Location template.

© UK MOD 2010 — All rights reserved