Template:— MoDAvDEXmessage_symptom (MoDAvmsg_sym)
Context:— MoDAvDEX
Date: 2008/02/03 21:24:01
Revision: 1.10

This section specifies the template MoDAvDEXmessage_symptom.

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

Business perspective

Symptom messages represent a record of a symptom that has been identified and reported against a reportable item.

Business object definition

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

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



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

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

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

Figure 2 shows the templates required to represent a message recording a symptom. The templates shown in yellow 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 symptom using ISO 10303 239 PLCS is provided in Aviation Maintenance DEX: Representing state of a reportable item - PLCS representation - Symptom.

The following mandatory templates are shown in Figure 2 and used to represent different aspects of the sortie feedback.

Template: #1 MoDAvDEX.MoDAvDEXmessage
The template: #1 MoDAvDEX.MoDAvDEXmessage (Figure 2) is used to represent the message meta data.
Template: #2 MoDAvDEX.reportable_item_usage
the template: #2 MoDAvDEX.reportable_item_usage (Figure 2) is used to represent the sortie that was flown.
Template: #3 MoDAvDEX.reportable_item
the template: #3 MoDAvDEX.reportable_item (Figure 2) is used to represent the reportable item (normally an aircraft) that has flown the sortie.
Template: #4 MoDAvDEX.symptom
the template: #4 MoDAvDEX.symptom (Figure 2) is used to represent the symptom on the reportable item.
Template: #5 assigning_organization
the template: #5 assigning_organization (Figure 2) is used to represent the organization that identified the symptom.
Template: #6 assigning_reference_data
the template: #6assigning_reference_data (Figure 2) is used to represent the perceived effect on flight safety.
Template: #7 assigning_reference_data
the template: #7assigning_reference_data (Figure 2) is used to represent the system on which the code was observed.
Template: #8 assigning_reference_data
the template: #6assigning_reference_data (Figure 2) is used to represent when/how code indicating how the symptom was discovered,
Template: #9 assigning_reference_data
the template: #9assigning_reference_data (Figure 2) is used to represent effect on operation the recorded symptom had on the phase of operation.


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

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

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

Figure 3 —  The graphical representation of the MoDAvDEXmessage_symptom 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
end_serial_number (Default=/NULL,Type='STRING', Optional)
The serial_number of the reportable item that undertook the activity.
end_part_number (Default=/NULL,Type='STRING', Optional)
The part_number of the reportable item that undertook the activity.
end_supplier (Default=/NULL,Type='STRING', Optional)
The supplier of the reportable item that undertook the activity.
end_NSN (Default=/NULL,Type='STRING', Optional)
The NSN of the reportable item that undertook the activity.
sortie_identification (Default=/NULL,Type='STRING')
The identifier of the activity.
start_time_year (Type= 'TYPE (year_number)' )
Calendar_date year_component of the date the activity was started.
start_time_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component of the date the activity was started.
start_time_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component of the date the activity was started.
start_time_hour (Type= 'TYPE (hour_in_day)' )
Local_time hour_component of the date and time the date the activity was started.
start_time_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time minute_component of the date and time the activity started. This parameter is optional. If not given, it will remain unset.
start_time_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time second_component of the date and time the activity was started. This parameter is optional. If not given, it will remain unset.
profile_code (Type='CLASS', Optional)
The identification of the type of sortie activity.
The following classes and their sub-classes can be used:
classifications: "Product_usage_activity_method" (urn:plcs:rdl:std:Product_usage_activity_method)
symptom_id (Type='STRING')
An identification for the symptom.
raising_organization (Type='STRING')
The organization raising the symptom
symptom_description (Type='STRING')
A textual description of the symptom
symptom_year (Type= 'TYPE (year_number)' )
Calendar_date year_component. The year the symptom was identified.
symptom_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component. The month the symptom was identified.
symptom_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component. The day the symptom was identified.
symptom_hour (Type= 'TYPE (hour_in_day)' )
Local_time hour_component of the date and time. The hour the symptom was identified.
symptom_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time minute_component of the date and time. The minute the symptom was identified. This parameter is optional. If not given, it will remain unset.
symptom_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time second_component of the date and time. The second the symptom was identified. This parameter is optional. If not given, it will remain unset.
request_year (Type= 'TYPE (year_number)' )
Calendar_date year_component. The year a request to address the symptom was raised .
request_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component. The month a request to address the symptom was raised .
request_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component. The day a request to address the symptom was raised .
request_hour (Type= 'TYPE (hour_in_day)' )
Local_time hour_component of the date and time. The hour a request to address the symptom was raised .
request_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time minute_component of the date and time. The minute a request to address the symptom was raised . This parameter is optional. If not given, it will remain unset.
request_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time second_component of the date and time. The second a request to address the symptom was raised . This parameter is optional. If not given, it will remain unset.
obs_org (Type='STRING', Optional)
The organization that identified the symptom.
flight_safety_hazard (Type='CLASS', Optional)
A code for the perceived effect that the symptom had on flight safety.
The following classes and their sub-classes can be used:
classifications: "Observation" (urn:plcs:rdl:std:Observation)
system_code (Type='CLASS', Optional)
A code for the system on which the symptom was manifested.
The following classes and their sub-classes can be used:
classifications: "Observation" (urn:plcs:rdl:std:Observation)
when_how_code (Type='CLASS', Optional)
Code representing "When/How" the symptom was discovered
The following classes and their sub-classes can be used:
classifications: "Observation" (urn:plcs:rdl:std:Observation)
effect_on_usage (Type='CLASS', Optional)
The Effect on Operation the recorded Symptom had on the Phase of operation (e.g. sortie).
The following classes and their sub-classes can be used:
classifications: "Observation" (urn:plcs:rdl:std:Observation)
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_symptom.message%
where target is the parameter to which the Message is bound.
act_act(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 = $MoDAvDEXmessage_symptom.act_act%
where target is the parameter to which the Activity_actual is bound.
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_symptom.par%
where target is the parameter to which the Product_as_realized is bound.
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_symptom.view%
where target is the parameter to which the Product_as_individual_view is bound.
observation(Type='ENTITY (Observation)')
Allow the Observation entity instantiated in this path to be referenced when this template is used.
Note: The Observation entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_symptom.observation%
where target is the parameter to which the Observation is bound.
work_req(Type='ENTITY (Work_request)')
Allow the Work_request entity instantiated in this path to be referenced when this template is used.
Note: The Work_request entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_symptom.work_req%
where target is the parameter to which the Work_request 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.
-- Instantiate the reportable item
/reportable_item(
    serial_number=@end_serial_number,
    part_number=@end_part_number,
    supplier=@end_supplier,
    NSN=@end_NSN)/
%^par = $reportable_item.par%
%^view = $reportable_item.view%
/reportable_item_usage(
    usage_identification=@sortie_identification,
    usage_identification_code='Activity_identification_code',
    start_time_year=@start_time_year,
    start_time_month=@start_time_month,
    start_time_day=@start_time_day,
    start_time_hour=@start_time_hour,
    start_time_minute=@start_time_minute,
    start_time_second=@start_time_second,
    usage_code=@profile_code,
    rep_item=^par)/
%^act_act = $reportable_item_usage.act_act%
/symptom(
    symptom_id=@symptom_id,
    raising_organization=@raising_organization,
    symptom_description=@symptom_description,
    symptom_year=@symptom_year,
    symptom_month=@symptom_month,
    symptom_day=@symptom_day,
    symptom_hour=@symptom_hour,
    symptom_minute=@symptom_minute,
    symptom_second=@symptom_second,
    request_year=@request_year,
    request_month=@request_month,
    request_day=@request_day,
    request_hour=@request_hour,
    request_minute=@request_minute,
    request_second=@request_second,
    observed_during=^act_act,
    applies_to=^par)/
%^observation = $symptom.observation%
%^work_req = $symptom.work_req%
/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=^observation)/
%^message = $MoDAvDEXmessage.message%
/assigning_organization(
    org_id=@raising_organization,
    org_id_class_name='Organization_identification_code',
    org_id_ecl_id='urn:plcs:rdl:std',
    org_assgn_class_name='Requestor_of',
    org_assgn_ecl_id='urn:plcs:rdl:std',
    items=^observation)/
/assigning_reference_data(
    class_name=@flight_safety_hazard,
    ecl_id='urn:plcs:rdl:LITS',
    items=^observation)/
/assigning_reference_data(
    class_name=@when_how_code,
    ecl_id='urn:plcs:rdl:LITS',
    items=^observation)/
/assigning_reference_data(
    class_name=@system_code,
    ecl_id='urn:plcs:rdl:LITS',
    items=^observation)/
/assigning_reference_data(
    class_name=@effect_on_usage,
    ecl_id='urn:plcs:rdl:LITS',
    items=^observation)/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:


Figure 4 —  Entities instantiated by MoDAvDEXmessage_symptom template

Figure 4 —  Entities instantiated by MoDAvDEXmessage_symptom template

The instance model in STEP ASCII exchange file format (ISO 10303 Part 21 syntax) is provided in the file MoDAvDEXmessage_symptom_inst.p21. The instance model in STEP ASCII exchange file format (ISO 10303 Part 28 syntax) provided in the file MoDAvDEXmessage_symptom_inst.xml.
Characterizations
No common characterizations of the template MoDAvDEXmessage_symptom 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