Template:— maintenance_task (maint_task)
Context:— UK_Defence

Date: 2009/10/02 12:37:34
Revision: 1.3

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 maintenance_task.

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 UK_Defence concept of a maintenance task in terms of PLCS model elements (templates, entities, and reference data)

Business perspective

This information object represents a task that is required to be performed on a subject that is a type of product.

Business object definition

This information object represents a task that is required to be performed on a subject that is a type of product.

Figure 1 — Graphical Representation for Business Object Maintenance Task

The attributes of the Maintenance Task object are tabled below. (note - this object inherits attributes from UK_Defence.task in addition to those shown below)

Attribute name	Attribute description	Attribute type	Optionality
Depth of maintenance	This is the depth of maintenance that the task is classified as.	Relationship to Depth of maintenance	Optional
Related deployment environment	This is the reference to the deployment environment for which the task is defined. Currently, the mapping of this is an issue.	Relationship to Support Context	Mandatory
Related maintenance line	This is the reference to the maintenance lines at which the task may be performed.	Relationship to Line of Maintenance	Optional
Related support concept	This is the reference to the support concept for which the task is defined. Currently, the mapping of this is an issue.	Relationship to Support Concept	Mandatory
Required state	This is the state in which an occurrence of the product design needs to be, for the task to be able to be performed.	intrinsic	Optional
Subject	This is the reference to the product design for which the task is defined.	Relationship to Product Design	Mandatory

Table 1 — Maintenance Task attribute details

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

Task_acceptance_criteria (Type='STRING')

This is the acceptance criteria for the task

Task_category (Type='CLASS', Optional)

This is the category of the task.

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

classifications: [Task_category]

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

Task_ID (Type='STRING')

The task identifier.

Task_ID_source_organization (Type='STRING')

The identifier of the organization responsible for the task identifier.

Task_name (Type='STRING')

The name of the task.

Task_name_source_organization (Type='STRING')

The identifier of the organization responsible for the task name.

Task_version (Type='STRING')

The version of the task.

Task_version_source_organization (Type='STRING')

The identifier of the organization responsible for the task version.

Task_description (Type='STRING')

The description of the task.

Task_required_outcome (Type='STRING', Optional)

This is the description of the required outcome of the task

Task_duration_value (Type= 'TYPE (any_number_value)' )

The duration of the task expressed as a number of the time units represented in the parameter @Duration_unit.

Task_duration_unit (Type='CLASS')

The time units in which the duration is expressed.

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

classifications: "Conversion_based_unit" (urn:plcs:rdl:std:Conversion_based_unit), "Context_dependent_unit" (urn:plcs:rdl:std:Context_dependent_unit), "Time_unit" (urn:plcs:rdl:std:Time_unit)

Task_periodicity_type (Type='CLASS')

The indication of whether periodicity is measured as number of times used or as a number of time units.

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

classifications: [Task_periodicity_as_usage]

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

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

Task_periodicity_value (Type= 'TYPE (any_number_value)' )

The time or usage interval that determines when the Task should next be performed expressed as a number of the time units represented in the parameter @Periodicity_unit (if the @Periodicity_type parameter is set to [Task_periodicity_as_duration]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
); or, as a number of usages (if the @Periodicity_type parameter is set to [Task_periodicity_as_usage]

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

Task_periodicity_unit (Type='CLASS')

The time or duration units in which the time interval that determines when the Task should next be performed is expressed; or the class [Count]

Error RDL1: The class Count does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
when the periodicity is expressed as a number of usages.

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

classifications: "Conversion_based_unit" (urn:plcs:rdl:std:Conversion_based_unit), "Context_dependent_unit" (urn:plcs:rdl:std:Context_dependent_unit), "Time_unit" (urn:plcs:rdl:std:Time_unit)

Depth_of_maintenance (Type= 'ENTITY (Class)' )

The depth of maintenance to which the maintenance task is assigned.

Related_deployment_environment (Type= 'SELECT (activity_method_item)' )

The deployment environment to which the maintenance task is assigned.

Related_maintenance_line (Type= 'ENTITY (Class)' )

The maintenance line to which the maintenance task is assigned.

Related_support_concept (Type= 'SELECT (activity_method_item)' )

The support concept to which the maintenance task is assigned.

Required_state (Type='CLASS')

The state of the product design for the task to be performed. The classes need to be agreed by the exchange partners. These provided below are examples.

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

classifications: [serviceable_and_standby]

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

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

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

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

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

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

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

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

Subject (Type= 'ENTITY (Part)' )

This is the reference to the product design for which the task is defined.

Reference parameters

The following reference parameters are defined for this template:

maint_task(Type='ENTITY (Task_method_version)')

Allow the Task_method_version entity instantiated in this path to be referenced when this template is used.

Note: The Task_method_version entity can be referenced in a template path by:

%^target = $maintenance_task.maint_task%

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

The maintenance task.

maint_task_duration(Type='ENTITY (Activity_property)')

Allow the Activity_property entity instantiated in this path to be referenced when this template is used.

Note: The Activity_property entity can be referenced in a template path by:

%^target = $maintenance_task.maint_task_duration%

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

The duration of the maintenance task.

maint_task_periodicity(Type='ENTITY (Activity_property)')

Allow the Activity_property entity instantiated in this path to be referenced when this template is used.

Note: The Activity_property entity can be referenced in a template path by:

%^target = $maintenance_task.maint_task_periodicity%

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

The periodicity of the maintenance task.

depth_of_maint(Type='ENTITY (Activity_property)')

Allow the Activity_property entity instantiated in this path to be referenced when this template is used.

Note: The Activity_property entity can be referenced in a template path by:

%^target = $maintenance_task.depth_of_maint%

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

The depth of maintenance of the task.

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Unique maintenance task

Each instance of the entity (Task_method_version) within the data set shall be uniquely identified by a combination of the following parameters on this template (maintenance_task) namely: Task_ID, Task_ID_source_organization, Task_version, Task_version_source_organization, Subject.
The instance is referenced by the following template parameter: maint_task.

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.

-- Task
/task(
    Acceptance_criteria=@Task_acceptance_criteria,
    Category=@Task_category,
    ID=@Task_ID,
    ID_source_organization=@Task_ID_source_organization,
    Version=@Task_version,
    Version_source_organization=@Task_version_source_organization,
    Name=@Task_name,
    Name_source_organization=@Task_name_source_organization,
    Description= @Task_description,
    Required_outcome=@Task_required_outcome,
    Duration_value=@Task_duration_value,
    Duration_unit=@Task_duration_unit,
    Periodicity_type=@Task_periodicity_type,
    Periodicity_value=@Task_periodicity_value,
    Periodicity_unit=@Task_periodicity_unit,
    Subject=@Subject)/

-- Assign reference parameters
%^maint_task = $task.task%
%^maint_task_duration = $task.duration%
%^maint_task_periodicity = $task.periodicity%

-- [ optional Depth_of_maintenance ]
Classification_assignment
Classification_assignment.items -> ^maint_task
Classification_assignment.assigned_class -> @Depth_of_maintenance

-- Related_deployment_environment
Task_method_assignment
Task_method_assignment.assigned_activity_method -> ^maint_task
Task_method_assignment.items -> @Related_deployment_environment

-- [ optional Related_maintenance_line]
Classification_assignment
Classification_assignment.items -> ^maint_task
Classification_assignment.assigned_class -> @Related_maintenance_line
Task_method_assignment
Task_method_assignment.assigned_activity_method -> ^maint_task
Task_method_assignment.items -> @Related_support_concept

-- [ optional Required_state ]
/assigning_reference_data(
    class_name=@Required_state,
    ecl_id='urn:plcs:rdl:uk_defence',
    items=^maint_task)/

Instance diagrams

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

/maintenance_task(Task_acceptance_criteria='Pump rotated', Task_category='Cat1', Task_ID='MN-900', Task_ID_source_organization='6421', Task_version='1', Task_version_source_organization='6421', Task_name='Rotate pump', Task_name_source_organization='6421', Task_description='In store rotate pump 19 1/4 turns', Task_required_outcome='Pump rotated', Task_duration_value='ANY NUMBER VALUE (20)', Task_duration_unit='Minute', Task_periodicity_type='Task_periodicity_as_duration', Task_periodicity_value='ANY NUMBER VALUE (2)', Task_periodicity_unit='year', Depth_of_maintenance='@503', Related_deployment_environment='@228', Related_maintenance_line='@437', Related_support_concept='@148', Required_state='serviceable_and_shutdown', Subject='@354')/

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

Figure 4 — Entities instantiated by maintenance_task 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 maintenance_task template

Characterizations

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