Template:— transportation (transtn)
Context:— UK_Defence

Date: 2009/04/17 12:28:27
Revision: 1.4

Cover Contents Description Bus. perspective Bus. obj.Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues in situ

This section specifies the template transportation.

NOTE The template has been defined in the context of UK_Defence. 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 the record of a transportation of consignments of inventory items.

Business perspective

This information object represents the record of a transportation of consignments of inventory items.

Business object definition

Figure 1 — Graphical Representation for Business Object Transportation

Transportation:

Attribute name	Attribute description	Attribute type	Optionality
Distance	This is the recorded distance travelled.	Intrinsic	Optional
From Location	This is the reference to the location from which the transportation started.	Relationship to Location	Mandatory
Mode of transport	This is the category (mode) of transport that can be used for transporting the related item. EXAMPLE: "Road", "Air", "Sea", "Rail"	intrinsic	Mandatory
To Location	This is the reference to the location at which the transportation ends.	Relationship to Location	Mandatory

Table 1 — Transportation attribute details:

Model diagrams

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

Figure 2 — An EXPRESS-G representation of the Information model for transportation

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

Figure 3 — The graphical representation of the transportation template

Input parameters

The following input parameters are defined for this template:

distance_value (Type= 'TYPE (any_number_value)' )

The value of the recorded distance travelled.

distance_unit (Type='CLASS')

The class name corresponding to the unit of measure for the recorded distance travelled.

The following classes and their sub-classes can be used:

classifications: "Unit" (urn:plcs:rdl:std:Unit)

from_location (Type= 'ENTITY (Location)' )

This is the reference to the location from which the transportation started.

mode_of_transport (Type='CLASS')

This is the category (mode) of transport that can be used for transporting the related item.

The following classes and their sub-classes can be used:

classifications: [Mode_of_transport]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml

to_location (Type= 'ENTITY (Location)' )

This is the reference to the location from which the transportation started.

Acceptance_criteria (Type='STRING')

This is the acceptance criteria for the actual activity.

Planned_activity_ID (Type='STRING')

The identifier of the planned activity.

Planned_activity_ID_source_org (Type='STRING')

The identifier of the organization that is the source of the identifier of the planned activity.

Planned_activity_name (Type='STRING')

The name of the planned activity.

Planned_activity_name_source_org (Type='STRING')

The identifier of the organization that is the source of the name.

Planned_start_year (Type= 'TYPE (year_number)' )

The year component of the date and time the activity is planned to start.

Planned_start_month (Type= 'TYPE (month_in_year_number)' )

The month component of the date and time the activity is planned to start.

Planned_start_day (Type= 'TYPE (day_in_month_number)' )

The day component of the date and time the activity is planned to start.

Planned_start_hour (Type= 'TYPE (hour_in_day)' )

The hour component of the date and time the activity is planned to start.

Planned_start_minute (Type= 'TYPE (minute_in_hour)' , Optional)

The minute component of the date and time the activity is planned to start. This parameter is optional. If not given, it will remain unset.

Planned_start_second (Type= 'TYPE (second_in_minute)' , Optional)

The second component of the date and time the activity activity is planned to start. This parameter is optional. If not given, it will remain unset.

Related_task_planned (Type= 'SELECT (message_content_item)' )

The task that defines the planned activity.

Actual_activity_ID (Type='STRING')

The identifier of the actual activity.

Actual_activity_ID_source_org (Type='STRING')

The identifier of the organization that is the source of the identifier.

Actual_activity_name (Type='STRING')

The name of the actual activity.

Actual_activity_name_source_org (Type='STRING')

The identifier of the organization that is the source of the name.

Actual_start_year (Type= 'TYPE (year_number)' )

The year component of the date and time the activity was started.

Actual_start_month (Type= 'TYPE (month_in_year_number)' )

The month component of the date and time the activity was started.

Actual_start_day (Type= 'TYPE (day_in_month_number)' )

The day component of the date and time the activity was started.

Actual_start_hour (Type= 'TYPE (hour_in_day)' )

The hour component of the date and time the activity was started.

Actual_start_minute (Type= 'TYPE (minute_in_hour)' , Optional)

The minute component of the date and time the activity was started. This parameter is optional. If not given, it will remain unset.

Actual_start_second (Type= 'TYPE (second_in_minute)' , Optional)

The second component of the date and time the activity was completed. This parameter is optional. If not given, it will remain unset.

Related_task_actual (Type= 'SELECT (message_content_item)' )

The task that defines the actual activity.

Subject (Type= 'SELECT (activity_item)' )

The object on which the activity is performed.

Reference parameters

The following reference parameters are defined for this template:

transportation(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 = $transportation.transportation%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Transportation

Each instance of the entity (Activity_actual) within the data set shall be uniquely identified by a combination of the following parameters on this template (transportation) namely: Planned_activity_ID, Actual_activity_ID.
The instance is referenced by the following template parameter: transportation.

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(
    Acceptance_criteria=@Acceptance_criteria,
    Planned_activity_ID=@Planned_activity_ID,
    Planned_activity_ID_source_org=@Planned_activity_ID_source_org,
    Planned_activity_name=@Planned_activity_name,
    Planned_activity_name_source_org=@Planned_activity_name_source_org,
    Planned_start_year=@Planned_start_year,
    Planned_start_month=@Planned_start_month,
    Planned_start_day=@Planned_start_day,
    Planned_start_hour=@Planned_start_hour,
    Planned_start_minute=@Planned_start_minute,
    Planned_start_second=@Planned_start_second,
    Related_task_planned=@Related_task_planned,
    Actual_activity_ID=@Actual_activity_ID,
    Actual_activity_ID_source_org=@Actual_activity_ID_source_org,
    Actual_activity_name=@Actual_activity_name,
    Actual_activity_name_source_org=@Actual_activity_name_source_org,
    Actual_start_year=@Actual_start_year,
    Actual_start_month=@Actual_start_month,
    Actual_start_day=@Actual_start_day,
    Actual_start_hour=@Actual_start_hour,
    Actual_start_minute=@Actual_start_minute,
    Actual_start_second=@Actual_start_second,
    Related_task_actual=@Related_task_actual,
    Subject=@Subject)/

-- Assign reference parameters
%^transportation = $activity.activity_actual%

-- Assigning_process_property
/assigning_process_property(
    property_class_name='Distance',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^transportation)/
%^dist_prop = $assigning_process_property.property%

-- value and unit
/process_property_numeric(
    value=@distance_value,
    unit=@distance_unit,
    unit_ecl_id='urn:plcs:rdl:uk_defence',
    si_unit='false',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:std',
    property=^dist_prop)/

-- From Location
/assigning_activity(
    role_class_name='From_location',
    role_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_activity=^transportation,
    items=@from_location)/

-- mode_of_transport
/assigning_reference_data(
    items=^transportation,
    class_name=@mode_of_transport,
    ecl_id='urn:plcs:rdl:uk_defence')/

-- To Location
/assigning_activity(
    role_class_name='To_location',
    role_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_activity=^transportation,
    items=@to_location)/

Instance diagrams

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

/transportation(Acceptance_criteria='Signed off by recipient location', Planned_activity_ID='T123', Planned_activity_ID_source_org='UK_Defence', Planned_activity_name='Transportation_identifier', Planned_activity_name_source_org='UK_Defence', Planned_start_year='2008', Planned_start_month='10', Planned_start_day='1', Planned_start_hour='', Planned_start_minute='', Planned_start_second='', Related_task_planned='', Actual_activity_ID='T123', Actual_activity_ID_source_org='UK_Defence', Actual_activity_name='Transportation_identifier', Actual_activity_name_source_org='UK_Defence', Actual_start_year='2008', Actual_start_month='10', Actual_start_day='1', Actual_start_hour='', Actual_start_minute='', Actual_start_second='', Subject='@428', distance_value='ANY_NUMBER_VALUE(50.)', distance_unit='Mile', from_location='@306', mode_of_transportation='AIR', to_location='@345')/

(an illustration of the consolidated transportation template is shown in Figure 5 below.)

Figure 4 — Entities instantiated by transportation template

The instance diagram in Figure 5 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

Figure 5 — Instantiation of transportation template

Characterizations

No common characterizations of the template transportation have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.