Template:— MoDAvDEXmessage_serviceability_change (MoDAvmsg_ser_chg)
Context:— MoDAvDEX
Date: 2008/02/03 07:53:26
Revision: 1.11

This section specifies the template MoDAvDEXmessage_serviceability_change.

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 the change of serviceability of a reportable item.

Business perspective
Serviceability change messages represent a record of the change of serviceability status of a reportable item. The messages are triggered whenever a serviceability change occurs.
Business object definition

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

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_serviceability_change". The text highlighted in blue shows the template parameters.

Figure 2 shows the templates required to represent the change of serviceability status of a reportable item. 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 a change in serviceability status using ISO 10303 239 PLCS is provided in Aviation Maintenance DEX: Faults and States.

The following mandatory templates are shown in Figure 2 and used to represent different aspects of the record of serviceability change.

Template: #1 MoDAvDEX.MoDAvDEXmessage
The template: #1 MoDAvDEX.MoDAvDEXmessage (Figure 2) is used to represent the message meta data.
Template: #2 MoDAvDEX.ref_work_order
the template: #2 representing_activity_actual (Figure 2) is used to reference the wok order that led to the change in serviceability status.
Template: #3 assigning_activity
The template: #3assigning_activity (Figure 2) relates the template: representing_activity_actual to template: #4 MoDAvDEX.reportable_item, the reportable item that changed location.
Template: #4 MoDAvDEX.reportable_item
the template: #4 MoDAvDEX.reportable_item (Figure 2) is used to represent the reportable item whose serviceability status has changed.
Template: #5 assigning_activity
The template: #5assigning_activity (Figure 2) relates the template: representing_activity_actual to template: #4 MoDAvDEX.reportable_item, the reportable item that changed location.
Template: #6 assigning_asserted_state
The template: #6assigning_asserted_state (Figure 2) is used to represent the serviceability status of the reportable item.
Template: #7 assigning_time
the template: #7 assigning_time (Figure 2) is used to represent the time when the serviceability status of the reportable item changed.
Template: #8 assigning_organization
the template: #8 assigning_organization (Figure 2) is used to represent the organization that owns the reportable item.


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

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

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

Figure 3 —  The graphical representation of the MoDAvDEXmessage_serviceability_change 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 (Type='STRING')
The identifier of the work order.
serial_number (Default=/NULL,Type='STRING', Optional)
The serial_number of the reportable item whose serviceability status has changed.
part_number (Default=/NULL,Type='STRING', Optional)
The part_number of the reportable item whose serviceability status has changed.
supplier (Default=/NULL,Type='STRING', Optional)
The supplier of the reportable item whose serviceability status has changed.
NSN (Default=/NULL,Type='STRING', Optional)
The NSN of the reportable item whose serviceability status has changed.
serviceability_state (Type='CLASS')
The new serviceability state of the reportable item.
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_serviceability_state]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
own_organization (Type='STRING')
The organization that owned the reportable item when the state changed.
state_year (Type= 'TYPE (year_number)' )
Calendar_date year_component. Year state changed.
state_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component. Month state changed.
state_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component. Day state changed.
state_hour (Type= 'TYPE (hour_in_day)' )
Local_time hour_component of the date and time. Hour state changed.
state_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time minute_component of the date and time. Minute state changed. This parameter is optional. If not given, it will remain unset.
state_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time second_component of the date and time. Second state changed. This parameter is optional. If not given, it will remain unset.
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_serviceability_change.message%
where target is the parameter to which the Message 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_serviceability_change.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_serviceability_change.dir_act%
where target is the parameter to which the Directed_activity 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_serviceability_change.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_serviceability_change.view%
where target is the parameter to which the Product_as_individual_view is bound.
serv_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_serviceability_change.serv_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.
/ref_work_order(
    wo_id=@wo_id)/
%^dir_act = $ref_work_order.dir_act%
%^work_order = $ref_work_order.work_order%

-- Instantiate the reportable item
/reportable_item(
    serial_number=@serial_number,
    part_number=@part_number,
    supplier=@supplier,
    NSN=@NSN)/
%^par = $reportable_item.par%
%^view = $reportable_item.view%

-- instantiate assigning_organization for the owner of reportable item
/assigning_organization(
    org_id=@own_organization,
    org_id_class_name='Organization_name',
    org_id_ecl_id='urn:plcs:rdl:std',
    org_assgn_class_name='Owner_of',
    org_assgn_ecl_id='urn:plcs:rdl:std',
    items=^par)/

-- instantiate assigning_activity
/assigning_activity(
    role_class_name='Activity_input',
    role_ecl_id='urn:plcs:rdl:std',
    assigned_activity=^dir_act,
    items=^par)/

-- Instantiate the message
/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=^dir_act)/
%^message = $MoDAvDEXmessage.message%
/assigning_asserted_state(
    state_class_name=@serviceability_state,
    state_ecl_id='urn:plcs:rdl:LITS',
    assigned_to=^par)/
%^serv_state = $assigning_asserted_state.state_assert%

-- instantiate assigning_activity
/assigning_activity(
    role_class_name='Activity_input',
    role_ecl_id='urn:plcs:rdl:std',
    assigned_activity=^dir_act,
    items=^serv_state)/

-- instantiate assigning_time for date of current state
/assigning_time(
    date_class_name='Date_actual_start',
    date_ecl_id='urn:plcs:rdl:std',
    year=@state_year,
    month=@state_month,
    day=@state_day,
    hour=@state_hour,
    minute=@state_minute,
    second=@state_second,
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0',
    items=^serv_state)/
Characterizations
No common characterizations of the template MoDAvDEXmessage_serviceability_change 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