Template:— supply_node_resource (sup_node_res)
Context:— UK_Defence		 Date: 2009/04/17 11:50:21
Revision: 1.3
CoverContentsDescriptionBus. perspectiveBus. obj.Model diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssuesin situ

This section specifies the template supply_node_resource.

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 definition of a resource that is located at the related supply node.

Business perspective

The supply node resource capability business object is used by those UK_Defence Data Exchange Specifications that require information that defines a resource that is located at the related supply node.

Business object definition


Figure 1 —  Graphical Representation for Business Object Supply Node Resource

Figure 1 —  Graphical Representation for Business Object Supply Node Resource

Supply Node Resource:

The definition of an Supply Node Resource object is: Data about the definition of a resource that is located at the related supply node.

Attribute name

Attribute description

Attribute type

Optionality
ID This is the Identifier of the supply node resource. Identifier Mandatory
Related Supply Node This is the reference to the supply node for which the resource is defined. Relationship to Supply Node Mandatory
Resource This is the reference to the resource that is located at the related supply node. Relationship to Item of Supply, Facility, Facility Type, Utility, Utility Type, Person Type, Person with Skill, Person or Organization with Qualification. Mandatory
Valid from This is the date from which the supply node resource was valid. Intrinsic Optional
Valid to This is the date to which the supply node resource was valid. Intrinsic Optional

Table 1 — Supply Node Resource attribute details

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


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

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

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

Figure 3 —  The graphical representation of the supply_node_resource template

Input parameters
The following input parameters are defined for this template:
ID (Type='STRING')
This is the identifier of the supply node resource.
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.
related_supply_node (Type= 'ENTITY (Organization)' )
This is the reference to the supply node for which the resource is defined.
resource (Type= 'SELECT (organization_or_person_in_organization_item)' )
This is the reference to the resource that is located at the related supply node.
valid_from (Type= 'ENTITY (Date_time)' , Optional)
This is the date from which the supply node resource was valid.
valid_to (Type= 'ENTITY (Date_time)' , Optional)
This is the date to which the supply node resource was valid.
Reference parameters
The following reference parameters are defined for this template:
sup_node_res(Type='ENTITY (Organization_or_person_in_organization_assignment)')
Allow the Organization_or_person_in_organization_assignment entity instantiated in this path to be referenced when this template is used.
Note: The Organization_or_person_in_organization_assignment entity can be referenced in a template path by:
%^target = $supply_node_resource.sup_node_res%
where target is the parameter to which the Organization_or_person_in_organization_assignment is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Supply_node_resource
Each instance of the entity (Organization_or_person_in_organization_assignment) within the data set shall be uniquely identified by a combination of the following parameters on this template (supply_node_resource) namely: ID, related_supply_node, resource.
The instance is referenced by the following template parameter: sup_node_res.
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.
-- Resource
Organization_or_person_in_organization_assignment

-- Set the Organization_or_person_in_organization_assignment attribute role to be ignored
Organization_or_person_in_organization_assignment.role = '/IGNORE'

-- Assign the Organization_or_person_in_organization_assignment
Organization_or_person_in_organization_assignment.items -> @resource

-- Create the Detected_by parameter
Organization_or_person_in_organization_assignment.assigned_entity -> @related_supply_node
%^sup_node_res = Organization_or_person_in_organization_assignment%

-- ID
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='Supply_node_resource_identifier',
    items=^sup_node_res)/

-- [optional Value from]
Date_or_date_time_assignment
Date_or_date_time_assignment.items -> ^sup_node_res
Date_or_date_time_assignment.assigned_date -> @valid_from
%^valid_from_date = Date_or_date_time_assignment%
/assigning_reference_data(
    items=^valid_from_date,
    class_name='Date_supply_node_resource_started',
    ecl_id='urn:plcs:rdl:uk_defence')/

-- [optional Value to]
Date_or_date_time_assignment
Date_or_date_time_assignment.items -> ^sup_node_res
Date_or_date_time_assignment.assigned_date -> @valid_to
%^valid_to_date = Date_or_date_time_assignment%
/assigning_reference_data(
    items=^valid_to_date,
    class_name='Date_supply_node_resource_ended',
    ecl_id='urn:plcs:rdl:uk_defence')/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Organization_or_person_in_organization_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:
/supply_node_resource(ID='SNR123', source_organization='UK_Defence', related_supply_node='@30', resource='@89', valid_from='@78', valid_to='@83')/
(an illustration of the consolidated supply_node_resource template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by supply_node_resource template

Figure 4 —  Entities instantiated by supply_node_resource 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:
/supply_node_resource(ID='SNR123', source_organization='UK_Defence', related_supply_node='@30', resource='@89', valid_from='@78', valid_to='@83')/


Figure 5 —  Instantiation of supply_node_resource template

Figure 5 —  Instantiation of supply_node_resource template

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