Template:— assigning_actual_activity (asg_actual_act)
Context:— NDLO
Date: 2007/09/28 12:44:03
Revision: 1.2

This section specifies the template assigning_actual_activity.

NOTE  The template has been defined in the context of NDLO. 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 an applied activity assignment with an actual activity as well as activity method assigned.

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


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

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

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

Figure 2 —  The graphical representation of the assigning_actual_activity template

Input parameters
The following input parameters are defined for this template:
code_id (Type='STRING')
The identifier of the Activity_actual.
code_id_class_name (Default=Activity_identification_code,Type='CLASS')
The name of the class being used to classify the identification (Identification_assignment) of the actual activity. This provides the role or reason for the identification.
The following classes and their sub-classes can be used:
classifications: "Activity_identification_code" (urn:plcs:rdl:std:Activity_identification_code)
code_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 @id_class_name class.
code_org_id (Type='STRING')
The name or identifier of the organization owning the id or name.
code_org_id_class_name (Default=Organization_name,Type='CLASS')
The name of the class being used to classify the identification of the organization. For example CAGE code, or organization name.
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)
code_org_id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The id of the External_class_library storing the @org_id_class_name class
name_id (Type='STRING')
The identifier of the activity method.
name_id_class_name (Default=Activity_method_identification_code,Type='CLASS')
The name of the class being used to classify the identification (Identification_assignment) of the activity method . This provides the role or reason for the identification.
The following classes and their sub-classes can be used:
classifications: "Activity_method_identification_code" (urn:plcs:rdl:std:Activity_method_identification_code)
name_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 @id_class_name class.
name_org_id (Type='STRING')
The name or identifier of the organization owning the id of the typical activity.
name_org_id_class_name (Default=Organization_name,Type='CLASS')
The name of the class being used to classify the identification of the organization. For example CAGE code, or organization name.
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)
name_org_id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The id of the External_class_library storing the @org_id_class_name class
purpose_class_name (Default=...,Type='CLASS')
The name of the class being used to classify the purpose of the activity method.
The following classes and their sub-classes can be used:
classifications: [...]
[warning:]Error RDL1: The class ... does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
purpose_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 class.
role_class_name (Type='CLASS')
The class name of the External_class corresponding to the role of the assignment, e.g. [Sea_trials_for_individual_ship]
[warning:]Error RDL1: The class Sea_trials_for_individual_ship does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
, or [Warranty_period_for_individual_ship]
[warning:]Error RDL1: The class Warranty_period_for_individual_ship does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
.
The following classes and their sub-classes can be used:
classifications: "Applied_activity_assignment" (urn:plcs:rdl:std:Applied_activity_assignment)
role_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 @role_class_name.
items (Type= 'SELECT (activity_item)' )
The activity, product, individual, task_method, etc that is being assigned to the activity.
Reference parameters
The following reference parameters are defined for this template:
act_act(Type='ENTITY (Activity_actual)')
Allow the Activity_actual entity instantiated in this path to be referenced when this template is used.
Note: The Activity_actual entity can be referenced in a template path by:
%^target = $assigning_actual_activity.act_act%
where target is the parameter to which the Activity_actual is bound.
Allows referencing of entity Activity_actual from outside the template, e.g. in order to characterize the Activity_actual further.
act_method(Type='ENTITY (Activity_method)')
Allow the Activity_method entity instantiated in this path to be referenced when this template is used.
Note: The Activity_method entity can be referenced in a template path by:
%^target = $assigning_actual_activity.act_method%
where target is the parameter to which the Activity_method is bound.
apl_act_asg(Type='ENTITY (Applied_activity_assignment)')
Allow the Applied_activity_assignment entity instantiated in this path to be referenced when this template is used.
Note: The Applied_activity_assignment entity can be referenced in a template path by:
%^target = $assigning_actual_activity.apl_act_asg%
where target is the parameter to which the Applied_activity_assignment 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 Activity_actual
Activity_actual
%^act_act = Activity_actual%
^act_act.id = '/IGNORE'
^act_act.name = '/IGNORE'
^act_act.description = '/IGNORE'

-- assign ID to activity_actual
/assigning_identification(
    id=@code_id,
    id_class_name=@code_id_class_name,
    id_ecl_id=@code_id_ecl_id,
    org_id=@code_org_id,
    org_id_class_name=@code_org_id_class_name,
    org_id_ecl_id=@code_org_id_ecl_id,
    items=^act_act)/
Activity_method
%^act_method = Activity_method%
^act_method.name = '/IGNORE'
^act_method.purpose = '/IGNORE'
^act_method.description = '/IGNORE'
^act_method.consequence = '/IGNORE'
/assigning_identification(
    id=@name_id,
    id_class_name=@name_id_class_name,
    id_ecl_id=@name_id_ecl_id,
    org_id=@name_org_id,
    org_id_class_name=@name_org_id_class_name,
    org_id_ecl_id=@name_org_id_ecl_id,
    items=^act_method)/
/assigning_reference_data(
    class_name=@purpose_class_name,
    ecl_id=@purpose_ecl_id,
    items=^act_method)/

-- Assign the Activity_actual to the Activity method
^act_act.chosen_method -> ^act_method

-- Instantiate an Applied_activity_assignment
Applied_activity_assignment
%^apl_act_asg = Applied_activity_assignment%

-- Set the Applied_activity_assignment attribute role to be ignored
^apl_act_asg.role = '/IGNORE'

-- Assign reference data for role of Applied_activity_assignment
/assigning_reference_data(
    items=^apl_act_asg,
    class_name=@role_class_name,
    ecl_id=@role_ecl_id)/

-- Assign the Applied_activity_assignment to the
-- to the instances passed into the template through the @items
-- input parameter (e.g. a Product_as_realized)
^apl_act_asg.items -> @items

-- Assign the Applied_activity_assignment to the Activity_actual
^apl_act_asg.assigned_activity -> ^act_act
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Activity_actual.id '/IGNORE' Activity.id
Activity_actual.name '/IGNORE' Activity.name
Activity_actual.description '/IGNORE' Activity.description
Activity_method.name '/IGNORE'
Activity_method.purpose '/IGNORE'
Activity_method.description '/IGNORE'
Activity_method.consequence '/IGNORE'
Applied_activity_assignment.role '/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_actual_activity(items='#1', class_name='...', ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated assigning_actual_activity template is shown in Figure 4 below.)


Figure 3 —  Entities instantiated by assigning_actual_activity template

Figure 3 —  Entities instantiated by assigning_actual_activity 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_actual_activity(items='#1', class_name='...', ecl_id='urn:plcs:rdl:std')/


Figure 4 —  Instantiation of assigning_actual_activity template

Figure 4 —  Instantiation of assigning_actual_activity template

Characterizations
The following section details how the assigning_actual_activity 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 identification

NOTE   this characterization is optional.

Activity actual may have an optional additional identifier.

The Activity_actual may have two identifiers (activity code and activity name). This may be represented by using the template assigning_identification to assign a name to a Activity_actual.

© OASIS 2010 — All rights reserved