Template:— assigning_approving_organization (asg_apr_org)
Capability:assigning_approvals
[warning:]The use of this template is deprecated. (2008-01-09)
Date: 2008/01/14 10:11:44
Revision: 1.14
Deprecation: Template assigning_approving_organization

The use of template,assigning_approving_organization, has been deprecated since 2008-01-09.

The assigning_approval template now uses the representing_person_in_organization and representing_organization templates

This section specifies the template assigning_approving_organization.

NOTE  The template has been defined in the context of the capability assigning_approvals 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 how to assign an organization (not a person in an organization) to an approval of something.

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


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

Figure 1 —  EXPRESS-G representation of the Information model for assigning_approving_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 assigning_approving_organization template

Figure 2 —   The graphical representation of assigning_approving_organization template

Input parameters
The following input parameters are defined for this template:
org_id (Type='STRING')
The name or identifier of the organization doing the approval.
org_id_class_name (Type='CLASS')
The name of the class being used to classify the identification (Identification_assignment) of the organization of the approval. 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.
authorized_approval (Type= 'ENTITY (Approval)' )
The approval to which the person is assigned
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 = $assigning_approving_organization.organization%
where target is the parameter to which the Organization is bound.
app_pers_org(Type='ENTITY (Approving_person_organization)')
Allow the Approving_person_organization entity instantiated in this path to be referenced when this template is used.
Note: The Approving_person_organization entity can be referenced in a template path by:
%^target = $assigning_approving_organization.app_pers_org%
where target is the parameter to which the Approving_person_organization 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.
-- Instantiate an Approving_person_organization
Approving_person_organization

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

-- Set the Approving_person_organization attributes
Approving_person_organization.role = '/IGNORE'

-- Assign the Approving_person_organization to the
-- Approval entity passed into the template through
-- the @authorized_approval input parameter
Approving_person_organization.authorized_approval -> @authorized_approval

-- Instantiate Organization and point at it
Approving_person_organization.person_organization -> Organization

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

-- Identify the Organization
/assigning_identification_with_no_organization(
    items=^organization,
    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
Approving_person_organization.role '/IGNORE'
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:
/assigning_approving_organization(org_id='BikeRent Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', items='#1')/
(an illustration of the consolidated assigning_approving_organization template is shown in Figure 4 below.)
Note that the templates assigning_time and assigning_reference_data are instantiated in the diagram. Namely:
@3 /assigning_time(class_name='Date_actual', ecl_id='urn:plcs:rdl:std', year='2005', month='10', day='5', hour='0', minute='0', second='0', sense='.EXACT', hour_offset='0', minute_offset='0')/
and:
@5 /assigning_reference_data(class_name='Quality_assurance', ecl_id='urn:plcs:rdl:sample', items='#5')/


Figure 3 —  Entities instantiated by assigning_approving_organization template

Figure 3 —  Entities instantiated by assigning_approving_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:
/assigning_approving_organization(org_id='BikeRent Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', items='#1')/


Figure 4 —  Instantiation of assigning_approving_organization template

Figure 4 —  Instantiation of assigning_approving_organization template

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

NOTE   this characterization is optional.

The date on which an organization gave an approval is represented by using the assigning_time template to assign a date and time to the Approving_person_organization. If this represents the planned date of approval, then the assigning_time template classifies the date and time as "Date planned" (urn:plcs:rdl:std:Date planned). If the date and time is the actual date, then the assigning_time template classifies the date and time as "Date actual" (urn:plcs:rdl:std:Date actual). This is illustrated in Figure 3, template @3.

Characterization Assigning classifications

NOTE   this characterization is optional.

Several entities may be classified to provide further semantics to the data.

The role of a person in an organization is represented using the template assigning_reference_data to assign a class to an Person_in_organization. This is illustrated in Figure 3, template @3.

The reason or role for the assignment of a person to an approval is represented by using the template assigning_reference_data to assign a class to Approving_person_organization. This is illustrated in Figure 3, template @5.

The type of organization may be represented by using the template assigning_reference_data to assign a class to Organization. This is illustrated in Figure 1.

Characterization Assigning address

NOTE   this characterization is optional.

An address may be assigned to a person in organization, e.g. to provide contact information.

The address of a person is represented using the template assigning_address to assign an address to a Person_in_organization. This is illustrated in Figure 1.

© OASIS 2010 — All rights reserved