Template:— fault (flt)
Context:— UK_Defence
Date: 2009/04/17 11:48:54
Revision: 1.2

This section specifies the template fault.

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 an anomaly that is a divergence of the product from its design specification.

Business perspective

This template describes how to represent the UK_Defence concept of a fault in terms of PLCS model elements (templates, entities, and reference data).

Business object definition

The definition of the fault object is: This object represents the information about a fault, detailing specific details about the type and any associated related change, mission, products and repairs.



Figure 1 —  Graphical Representation for Business Object fault.

Figure 1 —  Graphical Representation for Business Object fault.

Attribute name

Attribute description

Attribute type

Optionality

No additional attributes other than those inherited from anomaly.

Table 1 — Fault attribute details

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


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

Figure 2 —  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  3 below.


Figure 3 —  The graphical representation of the fault template

Figure 3 —  The graphical representation of the fault template

Input parameters
The following input parameters are defined for this template:
Related_product (Type= 'ENTITY (Product)' )
This is the reference to the product on which the fault occurred.
New_fault (Default=Anomalous_state_of_unknown_novelty,Type='STRING')
This is an indicator as to whether the fault is a new type of fault.
ID (Type='STRING')
This is the identifier of the fault.
ID_source_organization (Default=UK_Defence,Type='STRING')
The organization that created the associated identifier. Additionally a Person or Information System could be defined when either of these are the source; see Identifier template characterizations
Name (Type='STRING')
This is the name given to the fault.
Name_source_organization (Default=UK_Defence,Type='STRING')
The organization that created the associated name.
Detection_method (Default=/OPTIONAL,Type='STRING', Optional)
The method used to detect the fault.
Isolation_method (Default=/OPTIONAL,Type='STRING', Optional)
The method used to isolate the fault.
Suspected_cause (Default=/OPTIONAL,Type='STRING', Optional)
The suspected cause of the fault.
Title (Default=/OPTIONAL,Type='STRING', Optional)
The title given to the fault.
Detection_method_category (Default=Anomaly_with_defined_detection_method,Type='CLASS', Optional)
The category of the method by which the fault was detected
The following classes and their sub-classes can be used:
classifications: [Anomaly_with_defined_detection_method]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
Isolation_method_category (Default=Anomaly_with_defined_isolation_method,Type='CLASS', Optional)
The category of the method by which the fault was isolated.
The following classes and their sub-classes can be used:
classifications: [Anomaly_with_defined_isolation_method]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
Operable_until_repaired (Default=Anomaly_with_defined_operability_consequences,Type='CLASS', Optional)
A "flag" that is used to indicate whether the product to which the fault is related can continue to be operted until the fault is repaired.
The following classes and their sub-classes can be used:
classifications: [Anomaly_with_defined_operability_consequences]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
Severity (Default=Anomaly_with_defined_severity,Type='CLASS', Optional)
The category of severity of the fault.
The following classes and their sub-classes can be used:
classifications: [Anomaly_with_defined_severity]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
Priority (Default=Anomaly_with_defined_rectification_priority,Type='CLASS', Optional)
The priority of rectifying the fault.
The following classes and their sub-classes can be used:
classifications: [Anomaly_with_defined_rectification_priority]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
Repair_in_situ (Default=Anomaly_with_defined_in_situ_reparability,Type='CLASS', Optional)
An indicator of whether the fault can be rectified with the related product in situ (in its normal operating location).
The following classes and their sub-classes can be used:
classifications: [Anomaly_with_defined_in_situ_reparability]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
Detected_by (Type= 'SELECT (organization_or_person_in_organization_select)' )
This is the reference to the person / organization / system that detected the fault.
Detection_location (Type= 'SELECT (state_of_item)' , Optional)
The reference to the geographic location of the related product when the fault was detected.
Detection_zone (Type= 'SELECT (state_of_item)' , Optional)
The reference to the zone of the product in which the fault was detected.
Built_in_test_data (Type= 'ENTITY (Document)' , Optional)
The reference to the BITE code and / or data that is associated with the fault
Rectify_by (Type= 'ENTITY (Activity)' , Optional)
The reference to the related activity that will / has rectified the fault.
Related_activity (Type= 'ENTITY (Activity)' , Optional)
The reference to the activity that was being performed when the fault was detected.
Related_mission (Type= 'ENTITY (Activity_actual)' , Optional)
The reference to the mission (and hence the related theatre and scenario) in which the fault occurred.
Related_change (Type= 'ENTITY (Activity_actual)' , Optional)
The reference to a change that may be associated with the fault.
Repair_hasten (Type= 'ENTITY (Date_time)' , Optional)
The date and time when the repair was hastened.
When_detected (Type= 'ENTITY (Date_time)' , Optional)
The date and time when the fault was detected.
Reference parameters
The following reference parameters are defined for this template:
fault(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%
where target is the parameter to which the State_definition is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique fault
Each instance of the entity (State_definition) within the data set shall be uniquely identified by a combination of the following parameters on this template (fault) namely: ID, Name, Related_product.
The instance is referenced by the following template parameter: fault.
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.
-- fault
/anomaly(
    Related_product=@Related_product,
    New_anomaly=@New_fault,
    ID=@ID,
    ID_source_organization=@ID_source_organization,
    Name=@Name,
    Name_source_organization=@Name_source_organization,
    Detection_method=@Detection_method,
    Isolation_method=@Isolation_method,
    Suspected_cause=@Suspected_cause,
    Title=@Title,
    Detection_method_category=@Detection_method_category,
    Isolation_method_category=@Isolation_method_category,
    Operable_until_repaired=@Operable_until_repaired,
    Severity=@Severity,
    Priority=@Priority,
    Repair_in_situ=@Repair_in_situ,
    Detected_by=@Detected_by,
    Detection_location=@Detection_location,
    Detection_zone=@Detection_zone,
    Built_in_test_data=@Built_in_test_data,
    Rectify_by=@Rectify_by,
    Related_activity=@Related_activity,
    Related_mission=@Related_mission,
    Related_change=@Related_change,
    Repair_hasten=@Repair_hasten,
    When_detected=@When_detected)/
%^fault = $anomaly.anomaly%
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/fault(New_fault='Previously_encountered_anomalous_state', ID='F123', ID_source_organization='UK_Defence', Name='Worn cotter pin', Name_source_organization='UK_Defence', Detection_method='/OPTIONAL', Isolation_method='/OPTIONAL', Suspected_cause='/OPTIONAL', Title='/OPTIONAL', Detection_method_category='State_observed', Isolation_method_category='State_observed', Operable_until_repaired='State_observed', Severity='State_observed', Priority='State_observed', Repair_in_situ='State_observed', Related_Product='@169', Detected_by='@244')/
(an illustration of the consolidated fault template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by fault template

Figure 4 —  Entities instantiated by fault 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:
/fault(New_fault='Previously_encountered_anomalous_state', ID='F123', ID_source_organization='UK_Defence', Name='Worn cotter pin', Name_source_organization='UK_Defence', Detection_method='/OPTIONAL', Isolation_method='/OPTIONAL', Suspected_cause='/OPTIONAL', Title='/OPTIONAL', Detection_method_category='State_observed', Isolation_method_category='State_observed', Operable_until_repaired='State_observed', Severity='State_observed', Priority='State_observed', Repair_in_situ='State_observed', Related_Product='@169', Detected_by='@244')/


Figure 5 —  Instantiation of fault template

Figure 5 —  Instantiation of fault template

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

© UK MOD 2010 — All rights reserved