Binary Transport

System and Message Overviews

Document Version: 1.8

Date: January 8, 2020


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

18-September-14

Initial publication of document.
Create a new JSI message (BT) for communicating binary data (.eff package) from the EFF Aggregator, to JSI. At JSI the binary data will be recreated in it's original .eff package format and sent on to the BEGGS (or other) queue. Added new element in BT001 as zipCreationString for date, time, down to milliseconds for BEGGS. BEGGS has restriction that only allows passage of a string.

24-December-14

New XSD.

26-May-15

New XSD. Common.xsd added flightKey which had a trickle-down effect causing this xsd to be updated.

17-July-17

New XSD. Improved BT001 to enhance routing with CBR rules.

1-November-17

New XSD. Updated BT001 to version 3; added accessType to BT001 for FCB, in support of CBR rules.

15-October-18

New XSD. Updated BT001 to version 4; Corrected capitalization of BT001 from GenericBinaryTransportType to genericBinaryTransportType

25-October-18

New XSD. Updated BT001 to version 5, Added sourceSystem to BT001, cleanup deliverToSystem per annoation make "repeatable".

7-June-19

New XSD. Added a text element to the BT001 to include an optional, not repeatable "packageType" element. Enumerations: original, full, update, signed. Added an optional element, string, called "tripKit" to include the full url to download the associated trip kit for this briefing.

8-January-20

New XSD. Updated BT001 to version 7 - Replaced flightKey with flightKeyChoice structure.



Table Of Contents


1 Introduction

This document defines the interfaces which govern the interchange of data between Binary Transfer 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.

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 of applications moving data by means of Binary Transport within an Airline Operation Center.

1.2  Scope

This document discusses the Binary Transport messages currently supported by Jeppesen Solution Integrator (JSI). 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: BinaryTransport.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 “BT”) are further discussed in Section 3 AOC Interface Messages.

Table 2-1 Message Summary

ID

Message

Publish

Subscribe

Request

Response

BT001

Generic BinaryTransport

X

     

 

3 AOC Interface Messages

The following messages are processed by the Binary Transfer system.

3.1 BT001 Generic Binary Transport

3.1.1  Message Overview

The Binary Transport message is an asynchronous message with the primary purpose of carrying large blocks of binary data - specifically for flight planning systems. The binary transport message was created to address two problems; (1) the Jeppesen Solution Integrator (JSI) limitation of carrying only xml or Base64 content, and (2) the Electronic Flight Folder (EFF) -- receiving system -- limitation that all data must be received in a .pdf file folder structure.
When using the Binary Transport message, it is necessary for the sending system to transform the non-xml data, such as .pdf file structure, into a Base64 encoded format. The Base64 encoded data is then wrapped with CDATA tags and placed in the binaryDataEncodedFormat element. Flight planning specific data such as flight key, aircraft registration, and POA is required in the message to identify the contents of the encoded data. When the BinaryTransport data is received by JSI, the JSI adapter software transforms the binary data into the original format and sends this new data package to the receiving system.
The Binary Transport message is currently implemented in the Electronic Flight Folder application where the EFF data must be delivered to the receiving product in a .pdf file folder format.

3.1.2  Message System Flow

This message interacts with the systems as shown in Figure1.

BT001 Message System Flow

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

BT001 v7

Message Header Details (PUBLISH)

msgName: BT001
msgClass: PUBLISH
version: 7

Message Specification

BT001 GenericBinaryTransportType

Defined in XSD

BinaryTransport.xsd

Sample Messages

Samples not available for this message version.

Message Version History Version 1
* Added flightKey which causing this xsd to be updated.

Version 2
* Improved BT001 to enhance routing with CBR rules

Version 3
* Added accessType to BT001 for FCB, in support of CBR rules.

Version 4
* Corrected capitalization of BT001 from GenericBinaryTransportType to genericBinaryTransportType.

Version 5
* Added sourceSystem to BT001, cleanup deliverToSystem per annoation make "repeatable".

Version 6
* Added a text element to the BT001 to include an optional, not repeatable "packageType" element. Enumerations: original, full, update, signed. Added an optional element, string, called "tripKit" to include the full url to download the associated tripkit for this briefing.

Version 7
* Replaced flightKey with flightKeyChoice structure.