Training

System and Message Overviews

Document Version: 5.3

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

Initial publication of document.

15-July-09 Changed instance of element name 'aircraftType' to 'equipmentCode' in the
Training.xsd to correct issue with message TN002.
01-October-09 Updated TN002.
30-August-10 Updated links for new Bookshelf directory structure.
15-september-10 Updated TN002 and TN004 to version 1.
10-November-12 Added new TN002 and TN004 sample messages
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 Training 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.

 Training systems are used to manage the crew training related to keeping crew members qualified to operate the aircraft.

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 within Training.

1.2  Scope

This document discusses the Training 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: Training.XSD

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 “TN”) are further discussed in Section 3 AOC Interface Messages.

Table 2-1 Message Summary

ID

Message

Publish

Subscribe

Request

Response

TN001

Request Training

X

 

 

 

TN002

Schedule Training

X

 

 

 

TN003

Reschedule Training

X

 

 

 

TN004

Completed Training

X

 

 

 

TN005

Crew Dequalification

X

 

 

 

 

3 AOC Interface Messages

The following messages are processed by the Training system.

3.1 TN001 – Request Training

3.1.1  Message Overview

This message is used to request training for crew members.  Training of crew members can involve both ground and air training.  The Training system tracks the crew members qualifications to operate aircraft.  When the Training system determines that a crew member requires training to maintain their qualifications, that information may need to be provided to an external training system.  This message is also used to allow an external training system to request training from the Training system.

Once training is scheduled message TN002 is used to notify the requesting system.

3.1.2  Message System Flow

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

TN001 message system flow

Figure 1. TN001 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

TN001 vA

Message Header Details

msgName: TN001
msgClass: PUBLISH
version: A

Message Specification

TN001 RequestTrainingType

Defined in XSD

Training.xsd

Sample Messages

TN001vARequestAirTraining.xml
TN001vARequestGroundTraining.xml

Message Version History No changes.

 

3.2 TN002 – Schedule Training

3.2.1 Message Overview

This message is used to provide a system that is requesting training using TN001 with times for the requested training.  It is important that an external training system as well as the Training system with the training schedule exist so that the crew member is not scheduled to operate aircraft during the scheduled training.

3.2.2  Message System Flow

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

TN002 message system flow

Figure 2. TN002 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

TN002 v1

Message Header Details

msgName: TN002
msgClass: PUBLISH
version: 1

Message Specification

TN002 ScheduleTrainingType

Defined in XSD

Training.xsd

Sample Messages

TN002v1ScheduleTraining.xml

Message Version History Added sample message

 

3.3  TN003 – Reschedule Training

3.3.1  Message Overview

This message is used to request training that has been previously requested using TN001, be rescheduled.  Once the training has been rescheduled, the responding system would use TN002 to respond with the new scheduled training information.

3.3.2  Message System Flow

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

TN003 message system flow

Figure 3. TN003 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

TN003 vA

Message Header Details

msgName: TN003
msgClass: PUBLISH
version: A

Message Specification

TN003 RescheduleTrainingType

Defined in XSD

Training.xsd

Sample Messages

TN003vARescheduleTraining.xml

Message Version History No changes.

 

3.4  TN004 – Completed Training

3.4.1   Message Overview

This message is used to notify either the Training system or an external training system when training that has been scheduled using TN001 and TN002 has been completed.  This message can be used to provide an indication of whether the training was completed successfully or if the training resulted in a unsatisfactory score. It is common to see this message followed by TN005 to dequalify the crew member if/when that crew member has failed training.

3.4.2  Message System Flow

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

TN004 message system flow

Figure 4. TN004 message system flow

3.4.3  Message Details

Message Version

TN004 v1

Message Header Details

msgName: TN004
msgClass: PUBLISH
version: 1

Message Specification

TN004 CompletedTrainingType

Defined in XSD

Training.xsd

Sample Messages

TN004v1CompletedTraining.xml

Message Version History Added sample message

 

3.5 TN005 – Crew Dequalification

3.5.1  Message Overview

This message is used to dequalifiy a crew member.  There are many reasons that a crew member may be dequalified to include failing training requirements and expired qualification.

3.5.2  Message System Flow

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

TN005 message system flow

Figure 5. TN005 message system flow

3.5.3  Message Details

Message Version

TN005 vA

Message Header Details

msgName: TN005
msgClass: PUBLISH
version: A

Message Specification

TN005 CrewDequalificationType

Defined in XSD

Training.xsd

Sample Messages

TN005vACrewDequalification.xml

Message Version History No changes.