Template:— MoDAvDEXmessage (MoDAvmsg)
Context:— MoDAvDEX
Date: 2008/02/15 17:42:04
Revision: 1.8

This section specifies the template MoDAvDEXmessage.

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 containing MoD Aviation Maintenance data.

Business perspective

All data files that are exchanged according to the Aviation Maintenance DEX contain a message header. This is meta data about the messages such as who sent it, when it was sent.

The following templates define the data exchange packages. Each uses this messages templates to provide message meta data.

Message: MoDAvDEXmessage_geographical_change
Template: MoDAvDEXmessage_geographical_change
Message: MoDAvDEXmessage_ownership_change
Template: MoDAvDEXmessage_ownership_change
Message: MoDAvDEXmessage_serviceability_change
Template: MoDAvDEXmessage_serviceability_change
Message: MoDAvDEXmessage_symptom
Template: MoDAvDEXmessage_asset_symptom
Message: MoDAvDEXmessage_scheduled_maintenance
Template: MoDAvDEXmessage_asset_maintenance
Message: MoDAvDEXmessage_scheduled_engineering_instruction
Template: MoDAvDEXmessage_scheduled_engineering_instruction
Message: MoDAvDEXmessage_unscheduled_maintenance
Template: MoDAvDEXmessage_asset_maintenance
Message: MoDAvDEXmessage_asset_lifing_extension
Template: MoDAvDEXmessage_asset_lifing_extension
Message: MoDAvDEXmessage_consumption_of_life
Template: MoDAvDEXmessage_consumption_of_life
Message: MoDAvDEXmessage_sortie_feedback
Template: MoDAvDEXmessage_sortie_feedback
Message: MoDAvDEXmessage_inventory_loss
Template: MoDAvDEXmessage_inventory_loss
Message: MoDAvDEXmessage_inventory_gain
Template: MoDAvDEXmessage_inventory_gain
Business object definition

The information necessary to represent the message header can be summarized by the UML class diagram shown in Figure 1. For further information about using ISO 10303-239 PLCS to represent a maintenance activity, see Aviation Maintenance DEX: Representing a message. For details of the UML classes shown in Figure 1 see Aviation Maintenance DEX: Business Information Requirements - Information



Figure 1 —  UML model representing a maintenance work order

Figure 1 —  UML model representing a maintenance work order

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

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.

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

Template: # representing_message
The template: # representing_message (Figure 2) is used to
Template: # assigning_organization
The template: # assigning_organization (Figure 2) is used to
Template: # assigning_contract
The template: # assigning_contract (Figure 2) is used to
Template: # assigning_time
The template: # assigning_time (Figure 2) is used to
Template: # assigning_security_classification
The template: # assigning_security_classification (Figure 2) is used to


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

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

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 template

Figure 3 —  The graphical representation of the MoDAvDEXmessage 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)' , Optional)
Calendar_date year_component of the date that the message was sent.
sent_month (Type= 'TYPE (month_in_year_number)' , Optional)
Calendar_date month_component of the date that the message was sent.
sent_day (Type= 'TYPE (day_in_month_number)' , Optional)
Calendar_date day_component of the date that the message was sent.
sent_hour (Type= 'TYPE (hour_in_day)' , Optional)
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
content (Type= 'SELECT (message_content_item)' )
The content of the message.
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.message%
where target is the parameter to which the Message 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.
/representing_message(
    rep_msg_id=@msg_identifier,
    rep_msg_id_class_name='Message_identification_code',
    rep_msg_id_ecl_id='urn:plcs:rdl:std',
    rep_msg_id_owner='LITS',
    rep_msg_id_owner_class_name='Organization_name',
    rep_msg_id_owner_ecl_id='urn:plcs:rdl:std',
    date_class_name='Date_actual_extraction',
    date_ecl_id='urn:plcs:rdl:std',
    year=@sent_year,
    month=@sent_month,
    day=@sent_day,
    hour=@sent_hour,
    minute=@sent_minute,
    second=@sent_second,
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0',
    ap239_id_class_name='ISO10303_ed1_tc1',
    ap239_id_ecl_id='urn:plcs:rdl:std',
    dex_id_class_name='AVDEX',
    dex_id_ecl_id='urn:plcs:rdl:std',
    content=@content)/
%^message = $representing_message.message%
/assigning_organization(
    org_id=@sender_organization,
    org_id_class_name='Organization_name',
    org_id_ecl_id='urn:plcs:rdl:std',
    org_assgn_class_name='Sender_of',
    org_assgn_ecl_id='urn:plcs:rdl:std',
    items=^message)/
/assigning_organization(
    org_id=@receiver_organization,
    org_id_class_name='Organization_name',
    org_id_ecl_id='urn:plcs:rdl:std',
    org_assgn_class_name='Receiver_of',
    org_assgn_ecl_id='urn:plcs:rdl:std',
    items=^message)/
/assigning_contract(
    cnt_id=@contract_identifier,
    cnt_id_class_name='Contract_identification_code',
    cnt_id_ecl_id='urn:plcs:rdl:std',
    cnt_org_id='LITS',
    cnt_org_id_class_name='Organization_name',
    cnt_org_id_ecl_id='urn:plcs:rdl:std',
    items=^message)/
/assigning_time(
    date_class_name='Date_message_sent',
    date_ecl_id='urn:plcs:rdl:std',
    year=@extract_year,
    month=@extract_month,
    day=@extract_day,
    hour=@extract_hour,
    minute=@extract_minute,
    second=@extract_second,
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0',
    items=^message)/
/assigning_security_classification(
    security_class_name=@security_class,
    security_ecl_id='urn:plcs:rdl:LITS',
    items=^message)/
Characterizations
No common characterizations of the template MoDAvDEXmessage 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