Professional Documents
Culture Documents
Date: 02/02/2015
Paul Crisp
Commercial in Confidence
Ultra Electronics Airport Systems AIDX Active Flight Distribution Service
LIST OF CONTENTS
1. INTRODUCTION................................................................................................................. 4
1.1 PURPOSE................................................................................................................... 4
1.2 SERVICE DESCRIPTION............................................................................................4
1.3 RELATIONSHIP TO OTHER SERVICES AND DOCUMENTS.....................................4
2. SCOPE................................................................................................................................ 4
2.1 GENERAL.................................................................................................................... 4
3. OUTLINE DESCRIPTION...................................................................................................5
3.1 GENERAL.................................................................................................................... 5
3.2 SCHEMA, MESSAGES, WSDL...................................................................................6
3.3 PERIOD OF USAGE....................................................................................................6
3.4 FLIGHT IDENTIFICATION...........................................................................................6
4. APPLICATION LEVEL SPECIFICATION............................................................................7
4.1 SUBSCRIPTION OPTIONS.........................................................................................7
4.1.1 Flight Window.......................................................................................................... 7
4.1.2 Flight Window Example............................................................................................8
4.1.3 FLIGHT MESSAGE FILTERS..................................................................................9
4.2 MASTER AND CODESHARE FLIGHTS......................................................................9
4.3 MESSAGE CONTENT TRANSFORMATIONS...........................................................10
4.4 ADDITIONAL COMPLEX BUSINESS RULES...........................................................10
4.5 FLIGHT RECORDS...................................................................................................10
4.6 NIL FIELDS................................................................................................................ 11
4.6.1 Flight identifier operations......................................................................................11
4.6.2 Delete..................................................................................................................... 11
4.6.3 Do Not Display.......................................................................................................11
4.7 DATA DOWNLOAD CAPABILITY...............................................................................11
4.8 NORMAL DAY-TO-DAY OPERATION........................................................................12
4.9 AFTER FLIGHT OPERATION....................................................................................12
4.10 CHARACTER SETS..................................................................................................13
4.11 ADDITIONAL INFORMATION....................................................................................13
5. MESSAGE SEQUENCES.................................................................................................13
5.1 STARTUP.................................................................................................................. 13
5.2 SUBSCRIPTION REQUEST......................................................................................13
5.3 DOWNLOAD DATA....................................................................................................13
5.4 NORMAL OPERATION..............................................................................................14
5.4.1 Event Driven Notifications......................................................................................14
5.5 CANCELLATION OF SUBSCRIPTION......................................................................14
1. INTRODUCTION
The AIDX Active Flight Distribution Service (AAFDS) provides a distribution service
for active flight information relating to flights operating at an airport using AIDX
standard messages. This document describes the interface to enable a client
system to access the service.
1.1 PURPOSE
The purpose of this document is to provide detail on the architectural design of the
service, messages to be transferred and the real-time interaction between the IB
and client systems.
It is used to assist the design and implementation of third-party interface software
and defines how the non-functional requirements are satisfied and supported.
The AAFDS provides a distribution service for active flight information. Any system
located on the network, or with VPN access, can subscribe to the service, subject
to the necessary agreement and security aspects.
All communication is in the form of XML messages.
The service can supply a different subset of the data to each client system if
necessary by applying an XSLT.
2. SCOPE
2.1 GENERAL
The message schemas, which are defined separately, form part of the specification
of this interface and must be used in conjunction with this document during the
interface development process.
From the point of view of the client system, the IB provides the AAFDS service.
However the actual flight information is sourced by the IB from the back-end
AODB, in a manner hidden from the client system. The internal working of the IB
and the interfaces between the IB and the back-end database is outside the scope
of this document.
The service is designed to satisfy a wide range of client system requirements and
is therefore described in a generic manner.
The interface for a specific client system is defined in the Interface Definition
Document (IDD), which contains the following:
1. Description of the use of separate application services (e.g. AAFDS), which are
combined to satisfy the overall interface requirements
2. The data element table for each service listing the elements which are sent or
received
3. Business rules configured in the IB configuration for the client system, which
restrict the allowable parameters which can be selected in a subscription
request.
4. Implementation information such as:
JMS queue names (if appropriate)
Web Service endpoint URL (if appropriate)
Time out values to be used
The client system IDD takes precedence over information in this document.
The IDD may therefore override recommended information given in this
specification, for example, configurable items such as timeouts suggested in this
document.
3. OUTLINE DESCRIPTION
3.1 GENERAL
The AAFDS provides a distribution service for active flight information. Any system
located on the network, or with VPN access, can subscribe to the service, subject
to the necessary agreement and security aspects.
All communication is in the form of XML messages.
The service can supply a different subset of the data to each client system.
A client system subscribes to the service by sending a flight leg request message
(IATA_AIDX_FlightLegRQ). The request message allows the client system to
request data according to a specific carrier, otherwise further filtering on:
Flight Window
Flight direction
Terminal
Flight sector
Service type IATA code
can be applied automatically provided agreed in advance.
The client system can request a snapshot of the current data, to enable the client
system to initialise itself. The IB then sends messages to the client system in real-
time as updates to flight data take place. The AAFDS service is long running and
the distribution of flight information continues until the subscription is cancelled.
Operational N
Day e
x
t
Seasonal Flight
D-1 D0 D+1 D+2 D+3 D+4 D+5 D+6
Schedule
A service client can subscribe to a window of AIDX flight data messages which
starts a defined number of days before the day of operation – up to a maximum of
6 days before. The start day of the flight window is defined by the FlightWindow
configuration data element.
For example, where the FlightWindow configuration element is set to D+3 then
the subsystem receives flight information for the window from D+3 to D0.
When the system moves into a new day, the flights for that new D+n day (e.g. D+3)
is sent to the client and the window is extended to this new day.
All flight windows operate in the same manner, except for the window start time.
For example all windows include the day of operation and extend into the period
after operation.
A client system supplier, in conjunction with Ultra, will agree on the value for the
FlightWindow. Note, that to increase conformity, it is expected that most clients
will subscribe to the same flight window.
The operation of the flight schedule window is as follows:
Every night a process decides which flight data messages to send to each
subsystem.
For each flight, if the scheduled operation date of the flight has now entered the
required flight window for the client system, then the flight record is sent to the
client system. As this is the first time the flight is sent, then it is sent as a complete
flight record.
Some AAFDS data messages contain only changed data elements and some
messages contain a complete record of all data elements with a current value held
in the AODB.
1. When the complete record is sent, then all non-null elements are present. The
client system can use this to update an existing record or to create a new
record if the flight does not already exist.
2. A message may be sent with only data changes, then only the elements which
have been changed in the AODB (since the previous message sent for this
flight) are present in the message. The client system can use this to update a
record in its local database, using the flight identification included in the
message.
If an AIDX data message does not contain a certain element, this simply means
that the service provider is not supplying any information about that element. This
could be because there has not been a change to that element when the message
was constructed. A client would not be expected to remove the value of the
element from its internal database.
If an AIDX data message contains an element but it has the nil attribute assigned
to it then that indicates that the value for that particular element should be cleared.
Complete data messages are sent only in the following circumstances:
a. When the message is first sent as a result of either flight schedule entering the
request flight window period for the client system or where a new flight has
been created on the AODB (e.g. by an airline)
b. Where the flight messages are sent as a download in response to the initial
IATA_AIDX_FlightLegRQ request
c. Where a change has been made in the AODB to a message element used for
message filtering, which results in the message now satisfying the message
filtering specification where previously it did not.
d. When the AODB only supports complete data records
Where a field is specifically set to “no value” in the AODB, then this information is
passed to subscribing systems by using the “nillable=true” attribute which can be
attached to any nillable) data element in the AAFDS data message. Where a data
element is received with this attribute set, then client system should delete the
contents of the equivalent field in the local database.
The applicable fields are defined in the message schemas.
4.6.2 Delete
When a flight is deleted from the AODB, a data message is sent with the Special
Operation set to “Delete” to indicate that the client system should delete the flight
from its local database.
When a new flight is created or updated in the AODB, the flight will be sent as a
normal IATA_AIDX_FlightLegRS message.
If a flight key (FlightIdentity, FlightDirection, ScheduledDate) is changed in the
AODB, then AAFDS sends a Delete for the old flight followed by the new flight.
Since the Full Download causes IB to send all flight data messages satisfying
the requested flight window, it will send a large number of flight leg data to the
client.
The full data download is requested by sending an IATA_AIDX_FlightLegRQ
request and setting the TransactionStatusCode to ‘Start’.
2. Partial download: In a partial data download, the client system defines a
date/time for the start of the snapshot data. In this download, a flight data
message is sent for every flight which has been modified since the specified
date/time.
This mechanism is provided so that a client system can recover more quickly
from a situation where recent flight update messages have been lost (e.g. due
to temporary communications loss), but the client system database is
otherwise valid.
The partial data download is requested by sending an IATA_AIDX_FlightLegRQ
request and setting the TransactionStatusCode to ‘Continuation’ and the
Timestamp attribute to the start date/time window. This date/time should be set to
a value of Timestamp attribute of last successfully received
IATA_AIDX_FlightLegRS message. After the download data has been sent, the
subscription will revert to the transmission of normal real-time AAFDS notification
messages. Any flight data updates to the AODB that occurred during transmission
of the download will be queued by the IB on a First-in / First-out basis and sent
following the download.
limited time (to be defined on a per client system basis in the IDD) and can include
updates during the day after scheduled operation.
As defined in the XML Coding standards [Ref 1], AAFDS character coding uses
UTF-8 which allows a wide range of special symbols and character sets.
5. MESSAGE SEQUENCES
5.1 STARTUP
To subscribe to the service, the client should first send a StatusRequest message.
The IB will normally reply with a StatusResponse indicating the current service
state. If this state indicates that the service is currently unavailable (or if no
response is received) then the client system should continue sending status
requests until state of “Down” is received. When a “Down” StatusResponse has
been received the client system sends a IATA_AIDX_FlightLegRQ message to
the IB.
The IB may also cancel the subscription if some other problem occurs, such as
loss of communication between the IB and the back-end database.
Note that an IATA_AIDX_FlightLegRS message queued for receipt by a client
system is subject to the same time to live as other messages. This message is
primarily to inform the client system more quickly that its subscription has been
cancelled. If the client system is unsure about the state of the subscription then the
client should restart the whole subscription process.
6.1 GENERAL
Refer to the AIDX Implementation Guide which can be found in reference 6 and if
an UltraDB is used, then also the AIDX Operations guide in reference 8.
- Reconsider re-
establishing a
connection to see
if that resolves
the issue
any other value any N/A Not currently Treat as for
(for future use) other used Incomplete/294
value
(for
future
use)
LIST OF FIGURES
LIST OF TABLES
None
AMENDMENT RECORD
APPROVALS