representing_organization

Template:— representing_organization (rep_org)

Date: 2008/02/15 15:26:06
Revision: 1.17

Cover Contents Description Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues

This section specifies the template representing_organization.

NOTE An explanation of a template and the associated instantiation path is provided in the Template overview section.

Description

This template describes an organization independent of other entities in order to be referenced from other templates.

Model diagrams

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

Figure 1 — An EXPRESS-G representation of the Information model for representing_organization

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

Figure 2 — The graphical representation of the representing_organization template

Input parameters

The following input parameters are defined for this template:

org_id (Type='STRING')

The identifier or name of the organization.

org_id_class_name (Type='CLASS')

The name of the class being used to classify the identification (Identification_assignment) of the organization. This provides the role or reason for the identification. For example CAGE code.

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_id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the class referenced by the parameter @org_id_class_name class.

Reference parameters

The following reference parameters are defined for this template:

org(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_organization.org%

where target is the parameter to which the Organization is bound.

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Unique organization

There shall be at most one instance of the entity (Organization) within the data set uniquely identified by a combination of the following parameters on this template (representing_organization) namely: org_id, org_id_class_name, org_id_ecl_id.
The instance is referenced by the following template parameter: org.

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 Reading Capability Templates help section.

-- Bind the Organization to the parameter ^org.
-- The parameter is a reference parameter so the Organization
-- entity can be referred to when this template is used.
%^org = Organization%

-- Identify the Organization
/assigning_identification_with_no_organization(
    items=^org,
    id=@org_id,
    id_class_name=@org_id_class_name,
    id_ecl_id=@org_id_ecl_id)/

-- Set the Organization attributes
Organization.name = '/IGNORE'
Organization.id = '/IGNORE'

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Organization.name	'/IGNORE'	—
Organization.id	'/IGNORE'	—

Instance diagrams

The instance diagram in Figure 3 shows an example of the EXPRESS entities and templates that are instantiated by the template:

@9 /representing_organization(org_id='Bike Hire Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std')/

(an illustration of the consolidated representing_organization template is shown in Figure 4 below.)

Note that the template assigning_identification_with_no_organization is used in the diagram:

@2 /assigning_identification_with_no_organization(id='Bike Hire Limited', id_class_name='Organization_name', id_ecl_id='urn:plcs:rdl:std', items='#1')/

Figure 3 — Entities instantiated by representing_organization template

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:

@9 /representing_organization(org_id='Bike Hire Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std')/

Figure 4 — Instantiation of representing_organization template

Characterizations

The following section details how the representing_organization 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 5 shows the possible characterizations of the template "representing_organization".

Figure 5 — Characterizations of represented organizations

The following characterizations may apply:

Characterization Assigning identification

NOTE this characterization is optional.

Organization may have optional identifiers.

The Organization may have two identifiers (id and name) instead of either or. This may be represented by using the template assigning_identification_with_no_organization to assign a name or identifier to an Organization.

Characterization Assigning address

NOTE this characterization is optional.

An address may be assigned to an organization, e.g. to provide contact information.

The address of an organization is represented using the template assigning_address to assign an address to an Organization. This is illustrated in Figure 5