ElectronicFlightFolder

System and Message Overviews

Document Version: 2.6

Date: January 8, 2020


Copyright © 2009-2023 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 since the previous release.

Date

Description of Updates Made

14-October-10

Initial Entry. Created new overview, added new xsd, added new message.
24-February-11 New XSD.
8-June-11 New XSD. Updated EF001 to allow mapping. New EF002: Request to generate and distribute EF001 message PUBLISH
15-November-11 New XSD.
Updated EF001 to make effOperationalFlightPlan/aircraft/@aircraftIcaoCode optional. Added latDecimalDegree and longDecimalDegree as optional float elements. Updated windspeedvalue, and BasicDistanceEnumType. Removed restriction of minLen 1 from positionName, string.
17-February-12 New XSD.
Updated EF001 and EF002 to add unique ID, optional, nillable. The purpose of this new element is to allow receiving systems to identify proper post-processing upon receipt of these messages.
1-May-12

New XSD.
Updated EF001 vE and EF002 vC.
New EF003 vA, and EF004 vA
23-July-13 New XSD.
19-March-14 New XSD. Updated xsd to move to a production version 1. Updated EF002, and EF002 to V1, and added v1 sample.
18-September-14

Updated xsd for EF003 v1
Deprecated EF001 and EF002 - replaced by EF003.
Updated JPE Adapter - Plan Formatter to handle incoming EF003 Requests. Updated EF003 Request to be identical to EF002.

26-May-15

Updated XSD.
Updated EF003 to version 2
3-March-16 Added EF003v2ResponseCommercialFlightKeyOFPA633.1.xml and EF003v2OperationalFlightPlanA633.xml sample messages.
15-November-16

Updated XSD.
Updated EF003 to version 3
Added cross-versioning for EF003 v3 to v2, v2 to v3, and added cdata-section-elements="ns0:formattedFlightPlan ns0:flightPlanNotes ns0:flightRelease ns0:a633FlightPlan"" to the v2 to v3 cross versioning to allow the data to flow through to the plan formatter.
a633FlightPlan added the ability to pass both A633-1, A633-2

30-January-17

Updated XSD.
Updated EF003v3 - Added a633FlightPlan ability to pass both A633-1, A633-2.

1-November-17

Removed Deprecated message information.
15-October-18

Deprecated EF003 version 1 and version 2.
25-January-19

Updated XSD.
Updated EF003 to version4 - Added error element group at the system fail level, and at the data fail level.
8-January-20

Updated XSD.
Updated EF003 to version5 - Corrected flightKeyChoice structure in EF003 to v5 request/response.

Table Of Contents

1    Introduction
1.1    Audience
1.2    Scope
1.3    XML Schema/XSD
2    Message Summary
3    AOC Interface Messages
3.1    EF003 – Transform Flight Plan
3.1.1  Message Overview
3.1.2  Message System Flow
3.1.3  Message Details
3.2    EF004 – Acknowledge Receipt of Flight Plan Message
3.2.1  Message Overview
3.2.2  Message System Flow
3.2.3  Message Details

 

1  Introduction

This document is currently in draft - details and description of functions will follow.

1.1  Audience

This document is currently in draft - details and description of functions will follow.

1.2  Scope

This document discusses the Electronic Flight Folder 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: ElectronicFlightFolder.xsd

2  Message Summary

Table 2-1 lists the messages that can be sent or handled by the application.

Table 2-1 Message Summary

ID

Message

Publish

Request

Response

EF003

Transform Flight Plan (Request)
Operational Flight Plan (Response)

 

X

X

EF004

Acknowledge Receipt of Flight Plan Message

X

 

 

 

3 AOC Interface Messages

The following messages are processed by the ElectronicFlightFolder system.

3.1 EF003 - Transform Flight Plan (Request) / Operational Flight Plan (Response)

3.1.1  Message Overview

This document is currently in draft - details and description of functions will follow.

3.1.2  Message System Flow

This document is currently in draft - details and description of functions will follow.

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

EF003 v5

Message Header Details (REQUEST/RESPONSE)

msgName: EF003
msgClass: REQUEST/RESPONSE
version: 5

Message Specification

EF003 TransformFlightPlanRequestType
EF003 OperationalFlightPlanResponseType

Defined in XSD

ElectronicFlightFolder.xsd

Sample Messages

EF003v3ResponseCommercialFlightKeyOFP.xml
Message Version History Version A:
* EF003 Request = EF002. EF003 Response = EF001

Version 1:
* Relaces EF001 and EF002.

Version 2:
Add BAGA flightKeyChoice.
** 3-March-16: Added EF003v2ResponseCommercialFlightKeyOFPA633.1.xml and EF003v2OperationalFlightPlanA633.xml sample messages.

Version 3:
* Added cross-versioning for EF003 v3 to v2, v2 to v3, and added cdata-section-elements="ns0:formattedFlightPlan ns0:flightPlanNotes ns0:flightRelease ns0:a633FlightPlan"" to the v2 to v3 cross versioning to allow the data to flow through to the plan formatter. Added a633FlightPlan ability to pass both A633-1, A633-2.

* 15-October-2018: Deprecated version 1 and version 2

Version 4:
* Added error element group at the system fail level, and at the data fail level.

Version 5:
* Corrected flightKeyChoice structure in EF003 to v5 request/response.

 

3.2 EF004 - Acknowledge Receipt of Flight Plan Message

3.2.1  Message Overview

This document is currently in draft - details and description of functions will follow.

3.2.2  Message System Flow

This document is currently in draft - details and description of functions will follow.

3.2.3   Message Details

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

Message Version

EF004 vA

Message Header Details

msgName: EF004
msgClass: PUBLISH
version: A

Message Specification

EF004 AckReceiptOfFlightPlanMessageType

Defined in XSD

ElectronicFlightFolder.xsd

Sample Messages

Samples not available for this message version.
Message Version History Version A:
*( EF004 is a new message that is for use in implementations where the EF001 message is delivered to the aircraft via an EFB. (Note that version A is in draft and should not be implemented without further discussion with an implementation specialist)