Template:— representing_organizational_location (rep_org_locn)
Capability:representing_location
Date: 2005/08/15 08:20:35 :
Revision: 1.11

This section specifies the template representing_organizational_location.

NOTE  The template has been defined in the context of the capability representing_location which provides an overall description of the relevant parts of the ISO 10303-239 information model and a description 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 the representation of an organization based location. It instantiates the Organization_based_location_representation, Organizational_location_identification, Organization instances within this template.
Model diagrams
The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "representing_organizational_location". The text highlighted in blue shows the template parameters.


Figure 1 —  Template Configuration for Assigning Organization Location

Figure 1 —  Template Configuration for Assigning Organization Location

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure  2 below.


Figure 2 —  Template Usage

Figure 2 —  Template Usage

Input parameters
The following input parameters are defined for this template:
org_name (Default=University of Life,Type='STRING')
Name or id of the organization in which the location identifier is meaningful.
org_name_class (Default=urn:plcs:rdl:std,Type='CLASS', Optional)
The name of the class used to classify the identifier of the organization and so provide the type of identifier used.
The following classes and their sub-classes can be used:
classifications: "Organization_identification_code" (urn:plcs:rdl:std:Organization_identification_code), "Organization_name" (urn:plcs:rdl:std:Organization_name)
org_name_ecl_id (Default=urn:plcs:rdl:std,Type='URN', Optional)
The id of the External_class_library storing the st_date_class_name class
loc_val (Default=e.g. Room 101 in the administration building of the University.,Type='STRING')
The location value (location identifier) being assigned.
loc_id_type (Default=Organizational_location_identification_code,Type='CLASS')
The name of the class used to classify the identifier representing the loc_val.
The following classes and their sub-classes can be used:
classifications: "Organizational_location_identification_code" (urn:plcs:rdl:std:Organizational_location_identification_code)
loc_id_type_ecl_id (Default=urn:plcs:rdl:std,Type='URN', Optional)
The id of the External_class_library used to store the classification name assigned to the loc_val parameter.
Reference parameters
The following reference parameters are defined for this template:
organization(Type='ENTITY (Organization)')
Allow the Organization entity instantiated in this path to be referenced when this template is used.
Note: The Organization entity can be referenced in a template path by:
%^target = $representing_organizational_location.organization%
where target is the parameter to which the Organization is bound.
For example, to create additional identifiers for an instance of Organization . E.g.
          -- The template assigning_organization_location has an external reference
                     -- organization. Bind this to the local external reference
                     -- Organization. It can now be the target for assignments 
                     %^organization = $assigning_org_location.Organization%
                     -- assign '123456789' to the organization in the role of "DUNS_code"
                     /assigning_identification_with_no_organization(items=^organization, 
                     id='123456789', 
                     id_class_name='DUNS_code',
                     id_ecl_id='urn:plcs:rdl:std')/    
org_loc_id(Type='ENTITY (Organizational_location_identification)')
Allow the Organizational_location_identification entity instantiated in this path to be referenced when this template is used.
Note: The Organizational_location_identification entity can be referenced in a template path by:
%^target = $representing_organizational_location.org_loc_id%
where target is the parameter to which the Organizational_location_identification is bound.
For example, to create additional identifiers for an instance of Organizational_location_identification which has been defined for the Organization_based_location_representation entity. E.g.
          -- The template assigning_organization_location has an external reference
                     -- org_loc_id. Bind this to the local external reference
                     -- Organizational_location_identification. It can now be the target for assignments 
                     %^org_loc_id = $assigning_organization_location.Organizational_location_identification%
                     -- assign 'DRDL_QGJD' to the location in the role of "Location_identification_code"
                     /assigning_identification_with_no_organization(items=^org_loc_id, 
                     id='DRDL_QGJD', 
                     id_class_name='Location_identification_code',
                     id_ecl_id='urn:plcs:rdl:std')/    
org_loc_rep(Type='ENTITY (Organization_based_location_representation)')
Allow the Organization_based_location_representation entity instantiated in this path to be referenced when this template is used.
Note: The Organization_based_location_representation entity can be referenced in a template path by:
%^target = $representing_organizational_location.org_loc_rep%
where target is the parameter to which the Organization_based_location_representation is bound.
The reference parameter for Organization_based_location_representation.
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.
-- Create Organization
%^organization = Organization%
Organization.name = '/IGNORE'
Organization.id = '/IGNORE'

-- assign an identifier and classify it with input params'.
-- (Note not specifying class to enable id or name allotment)
/assigning_identification_with_no_organization(
    items=Organization,
    id=@org_name,
    id_class_name=@org_name_class,
    id_ecl_id=@org_name_ecl_id)/

-- Create Organizational_location_identification
%^org_loc_id = Organizational_location_identification%
Organizational_location_identification.identification_type = '/IGNORE'
Organizational_location_identification.location_value = '/IGNORE'

-- assign an identifier and classify it with input params'.
-- (Note not specifying class to enable id or name allotment)
/assigning_identification_with_no_organization(
    items=Organizational_location_identification,
    id=@loc_val,
    id_class_name=@loc_id_type,
    id_ecl_id=@loc_id_type_ecl_id)/

-- Organization_based_location_representation
%^org_loc_rep = Organization_based_location_representation%
Organization_based_location_representation.organization_for_location -> Organization

-- Create links to organization location identification
Organization_based_location_representation.location_identifications -> Organizational_location_identification

-- end.
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Organization.name '/IGNORE'
Organization.id '/IGNORE'
Organizational_location_identification.identification_type '/IGNORE'
Organizational_location_identification.location_value '/IGNORE'
Instance diagrams
The instance diagram in Figure  3 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/representing_organizational_location(org_name_ecl_id='urn:plcs:rdl:std', org_name='University of Life', org_name_class='Organiation_name', loc_val='Room 99 in Building 55 of University', loc_id_type_ecl_id='urn:plcs:rdl:std', loc_id_type='Organizational_location_identification_code')/
(an illustration of the consolidated representing_organizational_location template is shown in Figure 4 below.)
Note the instantiation uses two instances of another template, namely assigning_identification_with_no_organization.


Figure 3 —  Expansion of the instantiation template above

Figure 3 —  Expansion of the instantiation template above

The instance diagram in Figure 4 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:
/representing_organizational_location(org_name_ecl_id='urn:plcs:rdl:std', org_name='University of Life', org_name_class='Organiation_name', loc_val='Room 99 in Building 55 of University', loc_id_type_ecl_id='urn:plcs:rdl:std', loc_id_type='Organizational_location_identification_code')/


Figure 4 —  Example instantiation of the template

Figure 4 —  Example instantiation of the template

Characterizations
The following section details how the representing_organizational_location 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 following characterizations may apply:
Characterization Assigning date

NOTE   this characterization is optional.

Where the representation is defined in the context of an alternative location representation, it is recommended that dates be associated with the main Location for which this is an alternative. However, where specifically required dates can be associated with the Organization_based_location_representation instantiated by the template as shown below.



Figure 5 —  Template Configuration with Optional Calendar Date Assignment.

Figure 5 —  Template Configuration with Optional Calendar Date Assignment.

Note this requires the use of the reference parameter $representing_organizational_location.org_loc_rep to identify the Organization_based_location_representation instantiated by the template representing_organizational_location.

/assigning_calendar_date(items='$representing_organizational_location.org_loc_rep', date_class_name='Date_actual_observation', date_ecl_id='urn:plcs:rdl:std', year='2005', month='05', day='04')/
Characterization Assigning identifiers with no organization

NOTE   this characterization is optional.

© OASIS 2010 — All rights reserved