Maintenance

System and Message Overviews

Document Version: 6.0

Date: March 3, 2014


Copyright © 2009-2021 Jeppesen. All rights reserved. Your use of the AIM Bookshelf and all supporting documentation is subject to a separate license agreement between you and Jeppesen, a copy of which is included in the zip file or can be obtained from Jeppesen. The AIM Bookshelf is delivered "AS IS" without warranty of any kind and is not guaranteed to be free from errors or defects. You rely on the AIM Bookshelf at your own risk. No support for the AIM Bookshelf is implied through its publication. The AIM Bookshelf is intended solely for use as a reference and examples of interfaces to Jeppesen systems. Jeppesen may revise, update or cease publication at any time, without notice. Building to the specifications set forth in the AIM Bookshelf does not mean that your intended integration needs will be met or that an interface will function as documented. We recommend contacting Jeppesen directly to discuss professional services options with respect to production application integration and validation efforts.

 


Document Revision History

The following revision history table reflects all substantive changes to this document.

Date

Description of Updates Made

04-August-08

Rewrote MX001. Added messages MX002 through MX009. Added multiplier
field to DmiDataType. Modified some overview data.

09-September-08 Added DRAFT content for MX013, MX014, and MX015.
27-October-08 Changed all instances of AircraftIdType to AircraftIdentType. AircraftIdentType is defined in the CommonTypes.xsd.
12-December-08 Updated messages MX001 - MX008.
29-December-08 Updated the message overviews.
01-July-09 Added new messages MX013, MX014, and MX015.
15-July-09 Changed element "airline" to "airlineCode" in MX002. miDurationTime was updated from a duration to a string.
01-February-10 MX013, MX014: Removed pattern restriction from aircraftGroundedIndicator.
MX013, MX014, MX015: Updated annotations and enumerations in various elements for consistency. The enumerations have been updated to: MEL – Minimum Equipment List, CDL – Configuration Deviation List, NEF - Nonessential Equipment and Furnishings (previously known as PDL - Priority Deferral List), DMI – Deferred Maintenance Item, SEL - Special Equipment List.
31-March-10 Updated the following messages to version 2: MX001, MX002, MX003, MX004, MX013, MX014, and MX015. Changed the login element to access element for each of these messages.
30-August-10 Updated links for new Bookshelf directory structure.
14-December-10 New XSD. Updated message MX005 from vB to v1: Added optional:  dmiData group of elements. 
8-August-11 New XSD. Updated MX001, MX002, MX003, and MX004 with Boolean to indicate dmiParent. Updated MX013, MX014, and MX015 with primary (parent) and secondary (child) dmi structure for storage of parent/child associations.
5-October-10 Updated links for new Bookshelf directory structure.
15-November-11 New XSD. Updated MX013, MX014 and MX015 - Made melOutputName string optional.
1-May-12 New XSD. Updated MX013, and MX014 - Add new elements for ICAO 2012 Flight Plan update. Added optional elements: 10 a/b Equipment Degradation; PBN Degradation; PBN/Degradation Description; COM/MEL Override; DAT/MEL Override; SUR/MEL Override; Code/Mel Override; Per/Mel Override. Update DMI Penalty (MEL db)
23-July-13 New XSD.
3-March-14 New XSD.


Table Of Contents

 


1  Introduction

This document defines the interfaces which govern the interchange of data between a Maintenance system and other systems within an Airline Operation Center (AOC).  Each AOC interface is represented by a message described in an associated XSD (XML Schema Definition). The XSD defines and enforces the required, optional, and conditional data that can be included in a message.

Maintenance systems store and retrieve aircraft maintenance information such as deferred maintenance item (e.g. MEL, PDL) and maintenance events.

1.1  Audience

The intended audience for this document includes existing and potential Jeppesen customers, integration partners, and personnel with roles associated with application architecture, application development, system testing, implementation, and application support related to aircraft maintenance.

1.2  Scope

This document discusses the Maintenance messages currently supported by the Jeppesen Solution Integrator. Each message description includes the following:

  • Overview for common message uses within an AOC
  • Message Version Summary listing all available versions of each message
  • Links to the message specifications including direct links to XSD documentation, where you can explore the XSD hierarchy and interface specifications in a navigable HTML format
  • Links to the XSD source code
  • Links to sample XML messages for each AOC message

Other data interfaces or formats not included in this document will be considered custom and not supported.

1.3  XML Schema/XSD

The XML schema for this ICD is published in the following file: Maintenance.XSD

1.4  Key Concepts

1.4.1 Maintenance Systems

Airlines may use multiple maintenance systems to manage scheduled and other emergency maintenance items. The following maintenance systems are referenced in the following message descriptions:

Maintenance Control System:
Used on the day-of-operation to manage aircraft maintenance. These systems are used to track aircraft as they are taken out of service, returned to service, and throughout the scheduled and emergency maintenance work. These systems often communicate with Operations Control systems.

Maintenance Planning Systems:
Used to schedule routine and other future maintenance for aircraft. These systems often communicate with Schedule Planning systems to ensure that out-of-service aircraft are not schedule for flights.

Other Maintenance Systems:
Used to track and communicate DMI penalties. These penalties are often stored in a central location where other systems can access it. For example, the Dispatch system could access this maintenance system to locate a penalty associated with a particular DMI when planning a flight.

1.4.2 Maintenance Roles

The following roles within a maintenance organization are referenced in the following sections:

Maintainer:
Airline employee who performs actual maintenance on an aircraft.

Maintenance Controller:
Airline employee who manages and tracks maintenance items. This can include tracking DMIs, parts, and outstanding maintenance issues.

2  Message Summary

Table 2-1 lists the messages that can be sent or handled by the application. The messages originated by this application (messages that begin with “MX”) are further discussed in Section 3 AOC Interface Messages.

Table 2-1 Message Summary

ID

Message

Publish

Subscribe

Request

Response

MX001

DMI Report

X

 

 

 

MX002

Update DMI Report

X

 

 

 

MX003

Clear DMI

X

 

 

 

MX004

Delete DMI

X

 

 

 

MX005

Reopen DMI

X

 

 

 

MX006

Extend DMI

X

 

 

 

MX007

Schedule Event

X

 

 

 

MX008

Update Scheduled Event

X

 

 

 

MX009

Delete Scheduled Event

X

 

 

 

MX010

Create Out Of Service Event

X

 

 

 

MX011

Update Out Of Service Event

X

 

 

 

MX012

Return to Service

X

 

 

 

MX013

Create DMI Penalties

X

 

 

 

MX014

Update Penalty

X

 

 

 

MX015

Delete Penalty

X

 

 

 

 

3 AOC Interface Messages

The following messages are processed by the Maintenance system.

3.1 MX001 – DMI Report

3.1.1  Message Overview

This message is used to send Deferred Maintenance Item (DMI) information to Dispatch system from the Maintenance Control system.

Federal Aviation Regulations require all equipment on an aircraft to be operational in order for that aircraft to fly. However, there are less significant pieces of equipment on an aircraft that do not hinder flight’s safety when not operational. Therefore, an airline can file a Minimum Equipment List (MEL), which lists the items that must be operational for an aircraft to fly. Any non-operational item can be listed as a Deferred Maintenance Item (DMI), and the flight can proceed. For example, a single cabin light bulb burns out before a flight. Because the light is not critical for flight safety it is listed as a DMI, and the flight can proceed as planned.

MX001 is also used to notify flight planning systems of any limitations that might be applicable to an aircraft.  These limitations, which are also known as penalties, are critical elements in flight planning.  For example, if a fuel penalty DMI exists for an aircraft limiting the amount of burnable fuel an aircraft contains, it is critical for the dispatcher to not assign the aircraft to a flight that is farther than the fuel allows. 

3.1.2  Message System Flow

This message interacts with the systems as shown in Figure 1.

MX001 message system flow

Figure 1. MX001 message system flow

3.1.3 Message Details

The following table provides details on the message version and includes links to the message’s technical specification.

Message Version

MX001 v2

Message Header Details

msgName: MX001
msgClass: PUBLISH
version: 2

Message Specification

MX001 DmiReportType

Defined in XSD

Maintenance.xsd

Sample Messages

MX001v2DmiReport.xml

Message Version History Version 1
Updated DmiReportType and Updated DmiDataType.

Version 2
Changed the login element to access element. Updated with Boolean to indicate dmiParent.

3.2 MX002 – Update DMI Report

3.2.1 Message Overview

This message is used to update a MX001 message previously sent to the receiving system from the Maintenance Control system.

3.2.2  Message System Flow

This message interacts with the systems as shown in Figure 2.

MX002 message system flow

Figure 2. MX002 message system flow

3.2.3  Message Details

The following table provides details on the message and includes links to the message’s technical specification.

Message Version

MX002 v2

Message Header Details

msgName: MX002
msgClass: PUBLISH
version: 2

Message Specification

MX002 UpdateDmiReportType

Defined in XSD

Maintenance.xsd

Sample Messages

MX002v2UpdateDmiReport.xml

Message Version History Version 1
Updated Updated DmiDataType.

Version 2
Changed the login element to access element. Updated with Boolean to indicate dmiParent.

3.3  MX003 – Clear DMI

3.3.1  Message Overview

This message is used to clear an MX001 message previously sent to the receiving system from the Maintenance Control system. A clear DMI message typically indicates that a DMI has been resolved.

This message is similar to MX004 - Delete DMI. It’s up to individual airlines to determine how they want to use Clear versus Delete. The different messages can trigger different business logic. For example, the Clear can trigger final maintenance paperwork, whereas the Delete just removes the record and cancels all pending work on an item.

3.3.2  Message System Flow

This message interacts with the systems as shown in Figure 4.

MX003 message system flow

Figure 4. MX003 message system flow

3.3.3  Message Details

The following table provides details on the message and includes links to the message’s technical specification.

Message Version

MX003 v2

Message Header Details

msgName: MX003
msgClass: PUBLISH
version: 2

Message Specification

MX003 ClearDmiType

Defined in XSD

Maintenance.xsd

Sample Messages

MX003v2ClearDmi.xml

Message Version History

Version 2
Changed the login element to access element. Updated with Boolean to indicate dmiParent.

 

3.4  MX004 – Delete DMI

3.4.1   Message Overview

This message is used to delete a previously sent MX001 message. For example, an airline may want to remove (or delete) a DMI message that was logged incorrectly. Depending on the airline's business logic, the DMI could then be completely deleted from the system or simply marked as "deleted."  

This message is similar to MX003 - Clear DMI. It’s up to individual airlines to determine how they want to use clear versus delete. The different messages can trigger different business logic. For example, the Clear can trigger final maintenance paperwork, whereas the Delete just removes the record and cancels all pending work on an item.

3.4.2  Message System Flow

This message interacts with the systems as shown in Figure 5.

MX004 message system flow

Figure 5. MX004 message system flow

3.4.3  Message Details

Message Version

MX004 v2

Message Header Details

msgName: MX004
msgClass: PUBLISH
version: 2

Message Specification

MX004 DeleteDmiType

Defined in XSD

Maintenance.xsd

Sample Messages

MX004v2DeleteDmi.xml

Message Version History

From v1 to v2
Changed the login element to access element. Updated with Boolean to indicate dmiParent.

 

3.5  MX005 – Reopen DMI

3.5.1  Message Overview

This message is used to reopen a previously cleared (MX003) or deleted (MX004) DMI.

For example, a DMI related to the aircraft's air conditioning was cleared after the maintenance crew reported that the item was fixed. After one hour of operation, the air conditioning unit failed. The maintenance controller sends the MX005 message to reopen the DMI. This way the maintenance history is preserved to help with troubleshooting and later reporting.

3.5.2  Message System Flow

This message interacts with the systems as shown in Figure 6.

MX005 message system flow

Figure 6. MX005 message system flow

3.5.3  Message Details

Message Version

MX005 v1

Message Header Details

msgName: MX005
msgClass: PUBLISH
version: 1

Message Specification

MX005 ReopenDmiType

Defined in XSD

Maintenance.xsd

Sample Messages

MX005v1ReopenDmi.xml

Message Version History Version 1
Added optional:  dmiData group of elements.

 

 

3.6  MX006 – Extend DMI

3.6.1  Message Overview

This message is used to extend the times set by a previously sent MX001 message. 

For example, a DMI is set to expire today (on December 11) and the dispatcher is planning a flight for tomorrow (December 12). After further investigation the maintenance team decides that the DMI will not be fixed until next week (December 15). In this situation, the DMI would not show up in tomorrow’s list and the dispatcher would assign the aircraft without considering any penalties resulting from the still-active DMI. Therefore, to avoid dispatch errors, the DMI is extended through December 15 to reflect the updated aircraft maintenance schedule.

3.6.2  Message System Flow

This message interacts with the systems as shown in Figure 7.

MX006 message system flow

Figure 7. MX006 message system flow

3.6.3  Message Details

Message Version

MX006 v1

Message Header Details

msgName: MX006
msgClass: PUBLISH
version: 1

Message Specification

MX006 ExtendDmiType

Defined in XSD

Maintenance.xsd

Sample Messages

MX006v1ExtendDmi.xml

Message Version History No changes.

 

3.7  MX007 – Schedule Event

3.7.1  Message Overview

This message is used to create a scheduled maintenance event.  Scheduled maintenance events are those that are planned in advance and are normally sent to the Schedule Planning system. The Schedule Planning system then knows not to schedule an aircraft for out-of-service dates.

3.7.2  Message System Flow

This message interacts with the systems as shown in Figure 8.

MX007 message system flow

Figure 8. MX007 message system flow

3.7.3  Message Details

Message Version

MX007 v1

Message Header Details

msgName: MX007
msgClass: PUBLISH
version: 1

Message Specification

MX007 ScheduleEventType

Defined in XSD

Maintenance.xsd

Sample Messages

MX007v1ScheduleEvent.xml

Message Version History No changes.

 

3.8  MX008 – Update Scheduled Event

3.8.1  Message Overview

This message is used to update a scheduled event received from an MX007 message. Schedule updates can be the result of shifting maintenance priorities or resources.

3.8.2  Message System Flow

This message interacts with the systems as shown in Figure 9.

MX008 message system flow

Figure 9. MX008 message system flow

3.8.3  Message Details

Message Version

MX008 v1

Message Header Details

msgName: MX008
msgClass: PUBLISH
version: 1

Message Specification

MX008 UpdateScheduledEventType

Defined in XSD

Maintenance.xsd

Sample Messages

MX008v1UpdateScheduledEvent.xml

Message Version History No changes.

 

3.9  MX009 – Delete Scheduled Event

3.9.1  Message Overview

This message is used to delete a scheduled event previously received using a MX007 message. Deletions can result from incorrect event scheduling or because a DMI was corrected earlier than scheduled.

3.9.2  Message System Flow

This message interacts with the systems as shown in Figure 10.

MX009 message system flow

Figure 10. MX009 message system flow

3.9.3  Message Details

Message Version

MX009 v1

Message Header Details

msgName: MX009
msgClass: PUBLISH
version: 1

Message Specification

MX009 DeleteScheduledEventType

Defined in XSD

Maintenance.xsd

Sample Messages

MX009v1DeleteScheduledEvent.xml

Message Version History No changes.

 

3.10  MX010 – Create Out Of Service Event

3.10.1  Message Overview

This message is used to create an out of service event. This is used for both scheduled and unplanned maintenance. This message is typically sent from a Maintenance Control system to the Operations Control system to communicate that the aircraft is unavailable.

3.10.2  Message System Flow

This message interacts with the systems as shown in Figure 11.

MX010 message system flow

Figure 11. MX010 message system flow

3.10.3  Message Details

Message Version

MX010 vA

Message Header Details

msgName: MX010
msgClass: PUBLISH
version: A

Message Specification

MX010 CreateOutOfServiceEventType

Defined in XSD

Maintenance.xsd

Sample Messages

MX010vACreateOutOfServiceEvent.xml

Message Version History No changes.

 

3.11  MX011 – Update Out Of Service Event

3.11.1  Message Overview

This message is used to update an out of service event received from an MX010 message.

3.11.2  Message System Flow

This message interacts with the systems as shown in Figure 12.

MX011 message system flow

Figure 12. MX011 message system flow

3.11.3  Message Details

Message Version

MX011 vA

Message Header Details

msgName: MX011
msgClass: PUBLISH
version: A

Message Specification

MX011 UpdateOutOfServiceEventType

Defined in XSD

Maintenance.xsd

Sample Messages

MX011vAUpdateOutOfServiceEvent.xml

Message Version History No changes.

 

3.12  MX012 – Return To Service

3.12.1  Message Overview

This message is used to return an aircraft to service. This message is typically sent from a Maintenance Control system to the Operations Control system to communicate that the aircraft is once again available.

3.12.2  Message System Flow

This message interacts with the systems as shown in Figure 13.

MX012 message system flow

Figure 13. MX012 message system flow

3.12.3  Message Details

Message Version

MX012 vA

Message Header Details

msgName: MX012
msgClass: PUBLISH
version: A

Message Specification

MX012 ReturnToServiceType

Defined in XSD

Maintenance.xsd

Sample Messages

MX012vAReturnToService.xml

Message Version History No changes.

 

3.13  MX013 – Create DMI Penalties

3.13.1  Message Overview

This message is used to create defined penalties and aircraft degradations associated with maintenance items (e.g. DMI, MEL, PDL, SEL). These penalties are sent to a centralized location that can be accessed by the flight planning system. When DMIs are later created for an aircraft, these penalties (defined by MX013) are attached to the aircraft. The dispatcher must then accommodate for these penalties when scheduling flights for the penalized aircraft.

Example: Aircraft 123ABC has a problem with its fuel tank. The maintenance controller logs a DMI for the aircraft's fuel tank using MX001. A separate maintenance system assigns penalties to the different potential maintenance items using MX013. The dispatcher assigns plane to a flight – the maintenance item and penalty (from different systems) are displayed or automatically accounted for in the flight plan.

MX013 message overview

Figure 14. Example using MX013 message

This message is one of three messages designed to create, update, and delete DMI Penalties.

TIP: After MX013 updates the database, CS001 can be configured to notify other products that the database has been updated. Those products can then refresh their data as required.

3.13.2  Message System Flow

This message interacts with the systems as shown in Figure 15.

MX013 message system flow

Figure 15. MX013 message system flow

3.13.3  Message Details

Message Version

MX013 v4

Message Header Details

msgName: MX013
msgClass: PUBLISH
version: 4

Message Specification

MX013 CreateDmiPenaltiesType

Defined in XSD

Maintenance.xsd

Sample Messages

MX013v4CreateDmiPenalties.xml

Message Version History Version 2
02-01-10: Removed pattern restriction from aircraftGroundedIndicator. Updated annotations and enumerations in various elements for consistency. The enumerations have been updated to: MEL – Minimum Equipment List, CDL – Configuration Deviation List, NEF - Nonessential Equipment and Furnishings (previously known as PDL - Priority Deferral List), DMI – Deferred Maintenance Item, SEL - Special Equipment List.
03-31-10: Changed the login element to access element.

Version 3
Updated with primary (parent) and secondary (child) dmi structure for storage of parent/child associations.

Version 4
Add new elements for ICAO 2012 Flight Plan update. Added optional elements: 10 a/b Equipment Degradation; PBN Degradation; PBN/Degradation Description; COM/MEL Override; DAT/MEL Override; SUR/MEL Override; Code/Mel Override; Per/Mel Override

 

3.14  MX014 – Update Penalty

3.14.1  Message Overview

This message is used to update a defined penalties and aircraft degradations associated with maintenance items (e.g. DMI, MEL, PDL, SEL). These penalties are sent to the flight planning system. When DMIs are created for an aircraft, they contain the penalties that are defined by this message.

This message is one of three messages designed to create, update, and DMI Penalties.

TIP: After MX014 updates the database, CS001 can be configured to notify other products that the database has been updated. Those products can then refresh their data as required.

3.14.2  Message System Flow

This message interacts with the systems as shown in Figure 16.

MX014 message system flow

Figure 16. MX014 message system flow

3.14.3  Message Details

Message Version

MX014 v4

Message Header Details

msgName: MX014
msgClass: PUBLISH
version: 4

Message Specification

MX014 UpdateDmiPenaltyType

Defined in XSD

Maintenance.xsd

Sample Messages

MX014v4UpdateDmiPenalty.xml

Message Version History Version 2
02-01-10: Removed pattern restriction from aircraftGroundedIndicator. Updated annotations and enumerations in various elements for consistency. The enumerations have been updated to: MEL – Minimum Equipment List, CDL – Configuration Deviation List, NEF - Nonessential Equipment and Furnishings (previously known as PDL - Priority Deferral List), DMI – Deferred Maintenance Item, SEL - Special Equipment List.
03-31-10: Changed the login element to access element.

Version 3
Updated with primary (parent) and secondary (child) dmi structure for storage of parent/child associations.

Version 4
Update DMI Penalty (MEL db)

 

 

3.15  MX015 – Delete Penalty

3.15.1  Message Overview

This message is used to delete a defined penalties & aircraft degradations associated with maintenance items (e.g. DMI, MEL, PDL, SEL). These penalties are sent to the flight planning system. When DMIs are created for an aircraft, they contain the penalties that are defined by this message.

This message is one of three messages designed to create, update, and DMI Penalties.

TIP: After MX015 updates the database, CS001 can be configured to notify other products that the database has been updated. Those products can then refresh their data as required.

3.15.2  Message System Flow

This message interacts with the systems as shown in Figure 17.

MX015 message system flow

Figure 17. MX015 message system flow

3.15.3  Message Details

Message Version

MX015 v2

Message Header Details

msgName: MX015
msgClass: PUBLISH
version: 2

Message Specification

MX012 DeletePenaltyType

Defined in XSD

Maintenance.xsd

Sample Messages

MX015v2DeleteDmiPenalty.xml

Message Version History Version 2
02-01-10: Updated annotations and enumerations in various elements for consistency. The enumerations have been updated to: MEL – Minimum Equipment List, CDL – Configuration Deviation List, NEF - Nonessential Equipment and Furnishings (previously known as PDL - Priority Deferral List), DMI – Deferred Maintenance Item, SEL - Special Equipment List.
03-31-10: Changed the login element to access element.