Template:— representing_typical_activity (rep_typ_act) Date: 2008/01/18 08:58:19
Revision: 1.15

This section specifies the template representing_typical_activity.

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 a typical activity that something or someone may undertake. A typical activity defines the approach to or method used for undertaking an activity.

For a typical activity that represents a structured set of processes, then the typical activity will be related to tasks which define the structured set of processes. For further details see: C015: representing_task (NB Capabilities are not documented in this release of the PLCS standard) . If the activities or tasks are to be scheduled, then the schedule is represented by a Scheme. For further details see: C062: representing_scheme (NB Capabilities are not documented in this release of the PLCS standard) .

The following templates are used to represent activities planned or undertaken in accordance with the typical activity. These activities are related back to the typical activity.

Model diagrams
The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "representing_typical_activity". The text highlighted in blue shows the template parameters.
Grey areas and templates with dashed lines are not included in the template, but may be used to further characterize the template.


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

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

Figure 2 —  The graphical representation of the representing_typical_activity template

Input parameters
The following input parameters are defined for this template:
id (Type='STRING')
The identifier of the typical activity.
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 typical activity. 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)
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.
id_owner (Type='STRING')
The name or identifier of the organization owning the identifier of the typical activity.
id_owner_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)
id_owner_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The identifier of the External_class_library storing the @id_owner_class_name class
type (Default=Typical_activity,Type='CLASS')
The name of the class being used to classify the typical activity.
The following classes and their sub-classes can be used:
classifications: "Typical_activity" (urn:plcs:rdl:std:Typical_activity)
type_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 @type class.
Reference parameters
The following reference parameters are defined for this template:
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 = $representing_typical_activity.act_method%
where target is the parameter to which the Activity_method is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique typical activity
Each instance of the entity (Activity_method) within the data set shall be uniquely identified by a combination of the following parameters on this template (representing_typical_activity) namely: id, id_class_name, id_ecl_id, id_owner, id_owner_class_name, id_owner_ecl_id.
The instance is referenced by the following template parameter: act_method.
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.
Activity_method
Activity_method.name = '/IGNORE'
Activity_method.purpose = '/IGNORE'
Activity_method.description = '/IGNORE'
Activity_method.consequence = '/IGNORE'
%^act_method = Activity_method%
/assigning_identification(
    id=@id,
    id_class_name=@id_class_name,
    id_ecl_id=@id_ecl_id,
    org_id=@id_owner,
    org_id_class_name=@id_owner_class_name,
    org_id_ecl_id=@id_owner_ecl_id,
    items= Activity_method)/
/assigning_reference_data(
    class_name=@type,
    ecl_id=@type_ecl_id,
    items= Activity_method)/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Activity_method.name '/IGNORE'
Activity_method.purpose '/IGNORE'
Activity_method.description '/IGNORE'
Activity_method.consequence '/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_typical_activity(id='City_delivery_by_bike', id_class_name='Activity_method_identification_code', id_ecl_id='urn:plcs:rdl:std', id_owner='Express Delivery Inc', id_owner_class_name='Organization_name', id_owner_ecl_id='urn:plcs:rdl:std', type='Typical_activity', type_ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated representing_typical_activity template is shown in Figure 4 below.)


Figure 3 —  Entities instantiated by representing_typical_activity template

Figure 3 —  Entities instantiated by representing_typical_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:
/representing_typical_activity(id='City_delivery_by_bike', id_class_name='Activity_method_identification_code', id_ecl_id='urn:plcs:rdl:std', id_owner='Express Delivery Inc', id_owner_class_name='Organization_name', id_owner_ecl_id='urn:plcs:rdl:std', type='Typical_activity', type_ecl_id='urn:plcs:rdl:std')/


Figure 4 —  Instantiated representing_typical_activity template

Figure 4 —  Instantiated representing_typical_activity template

Characterizations
The following section details how the representing_typical_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 EXPRESS-G diagram in Figure 5 shows the possible characterizations of the template "representing_typical_activity".


Figure 5 —  Characterizations for representing_typical_activity template

Figure 5 —  Characterizations for representing_typical_activity template

The following characterizations may apply:
Characterization Specification of the typical activity

NOTE   this characterization is mandatory.

A typical activity must be specified in some way. There are several alternative routes to do this,

At least one of these alternatives must be used. See Figure 1 for an Express-G overview

A textual definition is represented by assigning a descriptor to the typical activity using the assigning_descriptor template.

A document describing the typical activity is assigned using template assigning_document with the Document_assignment classified as "Definition assignment" (urn:plcs:rdl:std:Definition assignment).

A structured set of processes or steps of a typical activity is represented using Activity_method_realization to relate e.g. a Task_method or Scheme to the Activity_method.

NOTE    These alternatives are not mutually exclusive, they can be used at the same time.

Characterization Assigning products

NOTE   this characterization is optional.

A product or a group of products can be assigned to the typical activity, classified as e.g. "activity input" and "product usage". See Figure 1 for an Express-G overview.

For a typical activity to be performed on a product or group of products, an Applied_activity_method_assignment, classified as "Activity input" (urn:plcs:rdl:std:Activity input), is used to relate the product to the activity as an "activity input".

This is done using template assigning_activity with the input parameter role_class_name given the value "Activity input" (urn:plcs:rdl:std:Activity input).

For a typical activity to be performed by a product, an Applied_activity_method_assignment, classified as "Product usage" (urn:plcs:rdl:std:Product usage), is used to relate the product to the activity as the product to be used ("product_usage").

This is done using template assigning_activity with the input parameter role_class_name given the value "Product usage" (urn:plcs:rdl:std:Product usage).

Characterization Assigning approval

NOTE   this characterization is optional.

A typical activity may be approved, e.g. approved for use. See Figure 1 for an Express-G overview.

An approval of the typical activity is represented by assigning a Approval to the Activity_method using the assigning_approval template.

NOTE    The assignment of approvals is described the capability C019: assigning_approvals (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning person or organization

NOTE   this characterization is optional.

A person or organization may be assigned to a typical activity, classified as e.g. "creator" or "owner" of the activity. See Figure 1 for an Express-G overview.

NOTE    This characterization is not intended to assign persons or organizations as a resource to an activity. To assign types of persons or organizations as a resource to an activity, see characterization "assigning resources".

An organization is associated to a typical activity by using the template assigning_organization. The assignment of the organization (Organization_or_person_in_organization_assignment) must be classified, e.g. as "Owner_of".

A person in an organization is associated to a typical activity by using the template assigning_person_in_organization. The assignment of the person (Organization_or_person_in_organization_assignment) must be classified, e.g. as "Creator".

Characterization Assigning required resources

NOTE   this characterization is optional.

Required resources, such as required type of person, required location, etc, may be assigned to a typical activity. See Figure 1 for an Express-G overview.

An required resource is associated to a typical activity by using Required_resource_assignment, classified appropriately.

Characterization Assigning properties

NOTE   this characterization is optional.

Properties, e.g. estimated duration, can be assigned to a typical activity. See Figure 1 for an Express-G overview.

A property is represented by Activity_property assigned to the Activity_method, using template assigning_process_property.

NOTE    The assignment of process properties are described further in capability C077: assigning_process_properties (NB Capabilities are not documented in this release of the PLCS standard) .



Figure 6 —  A property assigned to a typical activity

Figure 6 —  A property assigned to a typical activity

© OASIS 2010 — All rights reserved