Template:— fault (fault)
Context:— MoDAvDEX

Date: 2008/02/03 07:53:25
Revision: 1.5

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

This section specifies the template fault.

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

Business perspective

A symptom is raised on a reportable item. This results in a work order to investigate, which may result in a fault being identified against the reportable item. The fault is then addressed under the same work order. The process involved is summarized in Aviation Maintenance DEX: Representing state of a reportable item and shown in Figure 1

Figure 1 — UML class diagram representing the state of an asset

Business object definition

The information necessary to record a fault against a Reportable item can be summarized by the UML class diagram shown in Figure 2. For further information about using ISO 10303-239 PLCS to represent a fault state, see Aviation Maintenance DEX: Representing state of a reportable item.

Figure 2 — UML class diagram representing different states of an asset

Model diagrams

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

Figure 4 shows the templates required to represent a fault. The templates shown in yellow in Figure 4 are standard OASIS template. Those shown in light green are business templates developed specifically for the MoDAvDEX context.

Further details of how to represent a fault using ISO 10303 239 PLCS is provided in Aviation Maintenance DEX: Representing state of a reportable item - PLCS representation - Faults and States.

The following mandatory templates are shown in Figure 4 and used to represent different aspects of the fault. Figure 4 also shows a number of optional templates which are described in the Characterizations section.

Template: #1 MoDAvDEX.work_order: The template: #1 MoDAvDEX.work_order (Figure 4) is used to represent the maintenance work order.
Template: #2 MoDAvDEX.reportable_item: The template: #2 MoDAvDEX.reportable_item (Figure 4) is used to represent the reportable item.
Template: #3 assigning_activity: The template #3 assigning_activity relates the work order to the fault.
Template: #4 assigning_asserted_state: The template: #4 assigning_asserted_state (Figure 4) is used to represent the fault.

Figure 3 — An EXPRESS-G representation of the Information model for fault

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

Figure 4 — The graphical representation of the fault template

Input parameters

The following input parameters are defined for this template:

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]

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

raised_on (Type= 'ENTITY (Directed_activity)' )

The Directed_activity that was raised to address the fault.

assigned_to (Type= 'ENTITY (Product_as_realized)' )

The reportable item exhibiting the fault

Reference parameters

The following reference parameters are defined for this template:

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 = $fault.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 = $fault.fault_state%

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

fault_def(Type='ENTITY (State_definition)')

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

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

%^target = $fault.fault_def%

where target is the parameter to which the State_definition 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.

/assigning_asserted_state(
    state_class_name=@fault_code,
    state_ecl_id='urn:plcs:rdl:LITS',
    assigned_to=@assigned_to)/
%^fault_state = $assigning_asserted_state.state_obs%
%^fault_def = $assigning_asserted_state.state_def%
/assigning_activity(
    role_class_name='Activity_input',
    role_ecl_id='urn:plcs:rdl:std',
    assigned_activity=@raised_on,
    items=^fault_state)/
%^appl_act = $assigning_activity.appl_act%

Characterizations

The following section details how the fault 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 Fault description

NOTE this characterization is optional.

If additional textual description of the fault is required, then it is represented by the template #5 assigning_descriptor.