Template:— assigning_concession (asg_conc) Date: 2008/02/29 07:33:06
Revision: 1.15

This section specifies the template assigning_concession.

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 a basic concession. A concession, at its simplest, is a specific type of Approval. This template effectively defines this through specifying the concession-class as the type of Approval. It uses and is dependant on the assigning_approval template. It allows sub-classes of concession to also be specified. It is assumed that, in most cases. the authorization is provided by a Person, rather than an Organization and that the Person authorizing the approval has the authority to do so. The Organization which contains the Person is represented. It does allow the authorization to be provided by an Organization.
Model diagrams
The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "assigning_concession". The text highlighted in blue shows the template parameters.


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

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

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

Figure 2 —  The graphical representation of the assigning_concession template

Input parameters
The following input parameters are defined for this template:
asn_role (Default=Concession,Type='CLASS')
the type of Approval_assignment
The following classes and their sub-classes can be used:
classifications: "Concession" (urn:plcs:rdl:std:Concession)
role_ecl_id (Default=urn:plcs:rdl:std,Type='URN', Optional)
The identifier of the External_class_library storing the definition of the class referenced by the parameter @asn_role.
status (Default=Not_yet_approved,Type='CLASS')
types of status allowed
The following classes and their sub-classes can be used:
classifications: "Approved" (urn:plcs:rdl:std:Approved), "Approved_with_concession" (urn:plcs:rdl:std:Approved_with_concession), "Rejected" (urn:plcs:rdl:std:Rejected), "Withdrawn" (urn:plcs:rdl:std:Withdrawn), "Not_yet_approved" (urn:plcs:rdl:std:Not_yet_approved)
status_ecl_id (Default=urn:plcs:rdl:std,Type='URN', Optional)
The identifier of the External_class_library storing the definition of the class referenced by the parameter @status.
date_cn (Type='CLASS')
The name of the class being used to classify the role date assignment, e.g. the start date.
The following classes and their sub-classes can be used:
classifications: "Date_actual" (urn:plcs:rdl:std:Date_actual)
date_ecl_id (Type='URN')
The id of the External_class_library in which the date class is defined.
year (Type='INTEGER')
Calendar_date year_component
month (Type='INTEGER')
Calendar_date month_component
day (Type='INTEGER')
Calendar_date day_component
items (Type= 'SELECT (approval_item)' )
The items to which the approval is assigned
person_org (Type= 'SELECT (organization_or_person_in_organization_select)' )
The person or organization responsible for the approval
Reference parameters
The following reference parameters are defined for this template:
approval(Type='ENTITY (Approval)')
Allow the Approval entity instantiated in this path to be referenced when this template is used.
Note: The Approval entity can be referenced in a template path by:
%^target = $assigning_concession.approval%
where target is the parameter to which the Approval 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 Reading Capability Templates help section.
-- Call Assigning_approval.
/assigning_approval(
    status=@status,
    status_ecl_id=@status_ecl_id,
    items=@items,
    person_org=@person_org)/

-- Get the approval instance from the template call
-- %^ref_approval_assgn=$assigning_approval.approval_assgn%
%^approval = $assigning_approval.approval%

-- Assign Ref data to Approval
/assigning_reference_data(
    items=^approval,
    class_name=@asn_role,
    ecl_id=@role_ecl_id)/

-- Assign the date of concession
/assigning_time(
    date_class_name=@date_cn,
    date_ecl_id=@date_ecl_id,
    year=@year,
    month=@month,
    day=@day,
    hour='0',
    minute='0',
    second='0',
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0',
    items=^approval)/
Instance diagrams
The instance diagram in Figure  3 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/assigning_concession(asn_role='Concession', role_ecl_id='urn:plcs:rdl:std', status='Approved', status_ecl_id='urn:plcs:rdl:std', date_cn='Date_actual_creation', date_ecl_id='urn:plcs:rdl:std', year='2005', month='10', day='7', items='#9', person_org='#69')/
(an illustration of the consolidated assigning_concession template is shown in Figure 4 below.)
Note that the templates assigning_approval, assigning_time, and assigning_reference_data are used in the diagram. Note that either template representing_organization or templates representing_person_in_organization and assigning_identification must be present to make the approval complete. In this diagram, the assignment of an approving organization was done as follows:
@69 /representing_organization(org_id='Bike Rent Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std')/


Figure 3 —  Entities instantiated by assigning_concession template

Figure 3 —  Entities instantiated by assigning_concession 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_concession(asn_role='Concession', role_ecl_id='urn:plcs:rdl:std', status='Approved', status_ecl_id='urn:plcs:rdl:std', date_cn='Date_actual_creation', date_ecl_id='urn:plcs:rdl:std', year='2005', month='10', day='7', items='#9', person_org='#69')/


Figure 4 —  Instantiation of assigning_concession template

Figure 4 —  Instantiation of assigning_concession template

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


Figure 5 —  Characterizations for assigning_concession

Figure 5 —  Characterizations for assigning_concession

The following characterizations may apply:
Characterization Assigning dates

NOTE   this characterization is optional.

Dates can be associated with the concession, in a given role, by using the template assigning_time.

These are applied to the ^approval reference parameter. See Figure 5 for the an abstract view of this.

One date is commonly assigned to the template assigning_concession, namely the actual sign off date on which the concession approval was authorized.

Characterization Assigning identifers

NOTE   this characterization is optional.

Identifiers can be associated with the concession by using the template assigning_identification.

These are applied to the ^approval reference parameter. See Figure 5 for the an abstract view of this.

Characterization Assigning names or descriptions

NOTE   this characterization is optional.

Names or descriptions can be associated with the concession by using the template assigning_descriptor.

These are applied to the ^approval reference parameter. See Figure 5 for the an abstract view of this.

Characterization Assigning documents

NOTE   this characterization is optional.

Documents describing the reason for a "Concession" (urn:plcs:rdl:std:Concession) can be attached to an Approval by using the template assigning_document.

These are applied to the ^approval reference parameter. See Figure 5 for the an abstract view of this.

Characterization Assigning conditions of usage

NOTE   this characterization is optional.

Conditions of the usage of an item caused by the "Concession" (urn:plcs:rdl:std:Concession) can be attached to an Approval by using the template assigning_condition.

These are applied to the ^approval reference parameter. See Figure 5 for the an abstract view of this.

Characterization Assigning justification

NOTE   this characterization is optional.

Justifications for the "Concession" (urn:plcs:rdl:std:Concession) can be attached to an Approval by using the template assigning_justification for the justification.

These are applied to the ^approval reference parameter. See Figure 5 for the an abstract view of this.

© OASIS 2008 — All rights reserved