Template:— MoDAvDEXmessage_asset_fault_extension (MoDAvmsg_fext)
Context:— MoDAvDEX
Date: 2008/02/03 07:53:26
Revision: 1.8

This section specifies the template MoDAvDEXmessage_asset_fault_extension.

NOTE  The template has been defined in the context of MoDAvDEX. 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 a message reporting a deferral of a maintenance activity to address a fault.

Business perspective

Fault extension messages represent a record of a deferral of a maintenance activity to address a fault. The messages are triggered when a work order for maintenance is deferred.

Business object definition

The information necessary to record a deferred maintenance activity on a reportable item can be summarized by the UML class diagram shown in Figure 1.

NOTE    Descriptions of the information represented by the UML classes is provided in: Aviation Maintenance DEX: Business Information Requirements.



Figure 1 —  UML model representing scheduled maintenance

Figure 1 —  UML model representing scheduled maintenance

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

Figure 2 shows the templates required to represent a deferred scheduled maintenance activity message. The templates shown in yellow in Figure 2 are standard OASIS template. Those shown in light green are business templates developed specifically for the MoDAvDEX context.

Further details of how to represent scheduled maintenance using ISO 10303 239 PLCS is provided in Aviation Maintenance DEX: Representing deferred activities - PLCS representation.

The following mandatory templates are shown in Figure 2 and used to represent different aspects of the scheduled maintenance activity.

Template: #0 MoDAvDEX.MoDAvDEXmessage
The template: #0 MoDAvDEX.MoDAvDEXmessage (Figure 2) is used to represent the message meta data.
Template: #1 MoDAvDEX.work_order
The template: #1 MoDAvDEX.work_order (Figure 2) is used to represent the maintenance work order and planned activity that has been deferred.
Template: #2 MoDAvDEX.referencing_maintenance_task
The template: #2 MoDAvDEX.referencing_maintenance_task (Figure 2) is used to identify the standard maintenance task that has been deferred.
Template: #4 MoDAvDEX.life_deferment
The template: #4 MoDAvDEX.life_deferment (Figure 2) is used to represent the deferred life of the reportable item. The life property values that will will trigger the deferred activity.
Template: #6 assigning_asserted_state
The template: #6 assigning_asserted_state (Figure 2) is used to represent the deferred state of the Directed_activity instantiated by the MoDAvDEX.work_order.
Template: #8 MoDAvDEX.fault
The template: #8 MoDAvDEX.fault (Figure 2) is used to represent the deferred fault that whose rectification has been deferred.
Template: #9 MoDAvDEX.time_deferment
The template: #9 MoDAvDEX.time_deferment (Figure 2) is used to represents the date / time when the deferred maintenance activity should be undertaken.


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

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

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

Figure 3 —  The graphical representation of the MoDAvDEXmessage_asset_fault_extension template

Input parameters
The following input parameters are defined for this template:
msg_identifier (Type='STRING')
The identifier of the message.
sent_year (Type= 'TYPE (year_number)' )
Calendar_date year_component of the date that the message was sent.
sent_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component of the date that the message was sent.
sent_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component of the date that the message was sent.
sent_hour (Type= 'TYPE (hour_in_day)' )
Local_time hour_component of the date and time that the message was sent.
sent_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time minute_component of the date and time that the message was sent. This parameter is optional. If not given, it will remain unset.
sent_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time second_component of the date and time that the message was sent. This parameter is optional. If not given, it will remain unset.
sender_organization (Type='STRING')
The name or identifier of the sending organization.
receiver_organization (Type='STRING')
The name or identifier of the receiving organization.
contract_identifier (Type='STRING')
The name or identifier of the contract.
extract_year (Type= 'TYPE (year_number)' )
Calendar_date year_component of the date that the information in the message was extracted from the sending system.
extract_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component of the date that the information in the message was extracted from the sending system.
extract_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component of the date that the information in the message was extracted from the sending system.
extract_hour (Type= 'TYPE (hour_in_day)' )
Local_time hour_component of the date that the information in the message was extracted from the sending system.
extract_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time minute_component of the date that the information in the message was extracted from the sending system. This parameter is optional. If not given, it will remain unset.
extract_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time day_component of the date and time the message is extracted. This parameter is optional. If not given, it will remain unset.
security_class (Type='CLASS')
The name of the class being used to classify the security level. (Security_classification_assignment)
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_Security_classification]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
wo_id (Default=/NULL,Type='STRING')
The identifier of the work_order.
wo_year (Type= 'TYPE (year_number)' )
Calendar_date year_component of date the work order is issued.
wo_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component of date the work order is issued.
wo_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component of date the work order is issued.
wo_hour (Type= 'TYPE (hour_in_day)' )
Local_time hour_component of the date and time the work order is issued.
wo_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time month_component of the date and time the work order is issued. This parameter is optional. If not given, it will remain unset.
wo_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time second_component of the date and time the work order is issued. This parameter is optional. If not given, it will remain unset.
wo_type (Type='STRING')
The type of work order.
status (Type='STRING', Optional)
The status of the work order
task_id (Type='STRING')
The task identifier.
task_version_id (Default=/NULL,Type='STRING', Optional)
The task version identifier.
rep_item_serial_number (Default=/NULL,Type='STRING', Optional)
The serial_number of the reportable item that is input to the activity.
rep_item_part_number (Default=/NULL,Type='STRING', Optional)
The part_number of the reportable item that is input to the activity.
rep_item_supplier (Default=/NULL,Type='STRING', Optional)
The supplier of the reportable item that is input to the activity.
rep_item_NSN (Default=/NULL,Type='STRING', Optional)
The NSN of the reportable item that is input to the activity.
property_name (Type='CLASS')
The class name corresponding to the property name.
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_Product_property]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
property_value (Type= 'TYPE (any_number_value)' )
The value of the property. The data type must also be indicated in this parameter, e.g. "ANY_NUMBER_VALUE(5)".
property_unit (Type='CLASS')
The class name of the unit in which the value is expressed.
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_Unit]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
unit_ecl_id (Default=urn:plcs:rdl:LITS,Type='URN', Optional)
The identifier of the External_class_library storing the definition of the class referenced by the parameter @unit_class_name.
si_unit (Type='BOOLEAN')
Value should be set to true if the unit is a SI base unit defined by ISO, i.e. kilogram (kg) for Mass, second (s) for Time, metre (m) for Displacement, ampere (A) for Electrical current, kelvin (K) for Temperature, mole (mol) for Amount of substance, and candela (cd) for Luminous intensity. If this is not the case it should be set to false.
Note that the representation of true and false depends on exchange format. In Part 11 (a STEP file) true is represented by the string ".T.", and false by ".F.", while in Part 28 (XML) they are represented by text strings "true" and "false".
property_year (Type= 'TYPE (year_number)' )
The year component of the date the property value was measured.
property_month (Type= 'TYPE (month_in_year_number)' )
The month component of the date the property value was measured.
property_day (Type= 'TYPE (day_in_month_number)' )
The day component of the date the property value was measured.
property_hour (Type= 'TYPE (hour_in_day)' )
The hour component of the date the property value was measured.
property_minute (Type= 'TYPE (minute_in_hour)' , Optional)
The minute component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
property_second (Type= 'TYPE (second_in_minute)' , Optional)
The second component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
deferred_value (Type= 'TYPE (any_number_value)' )
The value of the property. The data type must also be indicated in this parameter, e.g. "ANY_NUMBER_VALUE(5)".
property_value_type (Type='CLASS')
meter_reading - the value measured on the meter; cumulative - the cumulative value taking into account the changing of meters; sortie - the value of sortie related data not use for calculating life. E.g fuel consumed.
The following classes and their sub-classes can be used:
classifications: [meter_reading_value]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
[cumulative_value]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
[sortie_value]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
property_org_id (Type='STRING')
The name or identifier of the organization declaring the property.
deferred_year (Type= 'TYPE (year_number)' , Optional)
The year component of the date the property value was measured.
deferred_month (Type= 'TYPE (month_in_year_number)' , Optional)
The month component of the date the property value was measured.
deferred_day (Type= 'TYPE (day_in_month_number)' , Optional)
The day component of the date the property value was measured.
deferred_hour (Type= 'TYPE (hour_in_day)' , Optional)
The hour component of the date the property value was measured.
deferred_minute (Type= 'TYPE (minute_in_hour)' , Optional)
The minute component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
deferred_second (Type= 'TYPE (second_in_minute)' , Optional)
The second component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
fault_code (Type='CLASS')
The class name of the External_class corresponding to the fault code.
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_fault_code]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
Reference parameters
The following reference parameters are defined for this template:
message(Type='ENTITY (Message)')
Allow the Message entity instantiated in this path to be referenced when this template is used.
Note: The Message entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_asset_fault_extension.message%
where target is the parameter to which the Message is bound.
rep_item_pai(Type='ENTITY (Product_as_individual)')
Allow the Product_as_individual entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_asset_fault_extension.rep_item_pai%
where target is the parameter to which the Product_as_individual is bound.
rep_item_par(Type='ENTITY (Product_as_realized)')
Allow the Product_as_realized entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_realized entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_asset_fault_extension.rep_item_par%
where target is the parameter to which the Product_as_realized is bound.
rep_item_view(Type='ENTITY (Product_as_individual_view)')
Allow the Product_as_individual_view entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual_view entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_asset_fault_extension.rep_item_view%
where target is the parameter to which the Product_as_individual_view is bound.
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 = $MoDAvDEXmessage_asset_fault_extension.act_method%
where target is the parameter to which the Activity_method is bound.
task_method_version(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 = $MoDAvDEXmessage_asset_fault_extension.task_method_version%
where target is the parameter to which the Task_method_version is bound.
work_order(Type='ENTITY (Work_order)')
Allow the Work_order entity instantiated in this path to be referenced when this template is used.
Note: The Work_order entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_asset_fault_extension.work_order%
where target is the parameter to which the Work_order is bound.
dir_act(Type='ENTITY (Directed_activity)')
Allow the Directed_activity entity instantiated in this path to be referenced when this template is used.
Note: The Directed_activity entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_asset_fault_extension.dir_act%
where target is the parameter to which the Directed_activity is bound.
appl_act(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 = $MoDAvDEXmessage_asset_fault_extension.appl_act%
where target is the parameter to which the Applied_activity_assignment is bound.
fault_state(Type='ENTITY (State_observed)')
Allow the State_observed entity instantiated in this path to be referenced when this template is used.
Note: The State_observed entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_asset_fault_extension.fault_state%
where target is the parameter to which the State_observed is bound.
deferred_state(Type='ENTITY (State_observed)')
Allow the State_observed entity instantiated in this path to be referenced when this template is used.
Note: The State_observed entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_asset_fault_extension.deferred_state%
where target is the parameter to which the State_observed 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.
/reportable_item(
    serial_number=@rep_item_serial_number,
    part_number=@rep_item_part_number,
    supplier=@rep_item_supplier,
    NSN=@rep_item_NSN)/
%^rep_item_pai = $reportable_item.pai%
%^rep_item_par = $reportable_item.par%
%^rep_item_view = $reportable_item.view%
/referencing_maintenance_task(
    task_id=@task_id,
    task_version_id=@task_version_id)/
%^act_method = $referencing_maintenance_task.act_method%
%^task_method_version = $referencing_maintenance_task.task_method_version%
/work_order(
    wo_id=@wo_id,
    wo_year=@wo_year,
    wo_month=@wo_month,
    wo_day=@wo_day,
    wo_hour=@wo_hour,
    wo_minute=@wo_minute,
    wo_second=@wo_second,
    wo_type=@wo_type,
    status=@status,
    request='',
    input=^rep_item_par,
    chosen_method=^act_method)/
%^work_order = $work_order.work_order%
%^dir_act = $work_order.dir_act%
%^appl_act = $work_order.appl_act%
/fault(
    fault_code=@fault_code,
    raised_on=^dir_act,
    assigned_to=^rep_item_par)/
%^fault_state = $fault.fault_state%
/MoDAvDEXmessage(
    msg_identifier=@msg_identifier,
    sent_year=@sent_year,
    sent_month=@sent_month,
    sent_day=@sent_day,
    sent_hour=@sent_hour,
    sent_minute=@sent_minute,
    sent_second=@sent_second,
    sender_organization=@sender_organization,
    receiver_organization=@receiver_organization,
    contract_identifier=@contract_identifier,
    extract_year=@extract_year,
    extract_month=@extract_month,
    extract_day=@extract_day,
    extract_hour=@extract_hour,
    extract_minute=@extract_minute,
    extract_second=@extract_second,
    security_class=@security_class,
    content=^work_order)/
%^message = $MoDAvDEXmessage.message%
/assigning_asserted_state(
    state_class_name='Deferred_activity',
    state_ecl_id='urn:plcs:rdl:std',
    assigned_to=^dir_act)/
%^deferred_state = $assigning_asserted_state.state_obs%
/life_deferment(
    property_name=@property_name,
    property_value=@property_value,
    property_unit=@property_unit,
    unit_ecl_id=@unit_ecl_id,
    si_unit=@si_unit,
    property_year=@property_year,
    property_month=@property_month,
    property_day=@property_day,
    property_hour=@property_hour,
    property_minute=@property_minute,
    property_second=@property_second,
    property_value_type=@property_value_type,
    property_org_id=@property_org_id,
    deferred_value=@deferred_value,
    par=^rep_item_par,
    appl_act=^appl_act)/
Characterizations
The following section details how the MoDAvDEXmessage_asset_fault_extension 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 time

NOTE   this characterization is optional.

The time and date when the deferred linkend="work_order:arm:Work_order_arm.Directed_activity"/> is planned to start can be represented by assigning a date (using the relationship Date_or_date_time_assignment) to the Directed_activity using the assigning_time template with the Date_time being classified as a type of "Date actual release" (urn:plcs:rdl:std:Date actual release).

NOTE    The assignment of dates and times is described the capability C036: assigning_date_time.

Characterization Usage limitation

NOTE   this characterization is optional.

When a maintenance activity is deferred, there is often a limitation placed on the usage of the reportable item. This is represented by the template #7 MoDAvDEX.usage_limitation. This template is instantiated with the following parameters:

Template #7 (Figure 2): usage_limitation
Description
Parameter name: Parameter value: Parameter description:
organization ?organization? The name or id of organization setting the limitation.
deferred_state State_observed The deferred state (State_observed) that is the reason for the limitation
approval_status ?approval_status? The approval status of the limitation
description ?description? A description of the limitation
par Product_as_realized The reportable item (Product_as_realized)

© UK MOD 2010 — All rights reserved