Customer Data Services System and Message Overviews Document Version: 2.7 Date: March 3, 2014
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.
Table Of Contents
1 IntroductionThe purpose of this document is to provide the interface control specifications for messages regarding Airports, Aircraft, and Routes Customer Databases. These are data repositories used to store all information related to a specific airline. 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 AudienceThe 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 that rely on customer database data. 1.2 ScopeThis document discusses the Customer Data Services messages currently supported by the Jeppesen Solution Integrator. Each message description includes the following:
Other data interfaces or formats not included in this document will be considered custom and not supported. 1.3 XML Schema/XSDThe XML schema for this ICD is published in the following file: CustomerDataServices.XSD
2 Message SummaryTable 2-1 lists the messages that can be sent or handled by the application. The messages originated by this application (messages that begin with “CS”) are further discussed in Section 3 AOC Interface Messages.
3 AOC Interface MessagesThe following messages are processed by the Maintenance system. 3.1 CS001 – Change Notification3.1.1 Message OverviewThis message notifies a product when customer data is modified. The product can then act on this information--update data in the database or send notifications to affected parties. For example, if the customers MEL penalties were modified in the customer database, the CS001 message could notify the dispatch product of the change. The dispatch product could then analyze the flights that might be affected and notify the appropriate dispatchers of the updates. The CS001 message includes information on the database change: database name, table name, and unique identifiers for the row or rows that have changed. Figure 1 provides a sample implementation of the CS001 message.
3.1.2 Message System FlowThis message interacts with the systems as shown in Figure 2. 3.1.3 Message DetailsThe following table provides details on the message version and includes links to the message’s technical specification.
3.2 CS002 – Create Update City Pair Fleet Record3.2.1 Message OverviewThis message is used to create or update database entries for the estimated taxi in and out times associated with a specific pair of airports. Airlines can provide the average taxi times for both out of and into an airport, based on averages that have been collected. The average, or base, taxi time is then adjusted based on the time of day. For example, if the base time for a taxi out is 15 minutes, but for the segment of time between 1600 and 1659, the adjustment is -3, then the total taxi time out for leaving the airport at 1630 would be 12 minutes. There are two sets of data that airlines may set. These sets are based on seasonal traffic. For example, set 1 may be used during summer, while set 2 may be used in winter operations. 3.2.2 Message System FlowThis message interacts with the systems as shown in Figure 3. 3.2.3 Message DetailsThe following table provides details on the message and includes links to the message’s technical specification.
3.3 CS004 – Delete City Pair Fleet Record3.3.1 Message OverviewThis message is used to delete database entries for the estimated taxi in and out times associated with a specific pair of airports. Airlines can provide the average taxi times for both out of and into an airport, based on averages that have been collected. The average, or base, taxi time is then adjusted based on the time of day. For example, if the base time for a taxi out is 15 minutes, but for the segment of time between 1600 and 1659, the adjustment is -3, then the total taxi time out for leaving the airport at 1630 would be 12 minutes. Airlines can set two sets of data, often based on seasonal traffic. For example, set 1 may be used during summer, while set 2 may be used in winter operations. Note that use of this message causes the delete of a entire City Pair Fleet record, not just the CPF taxi times. 3.3.2 Message System FlowThis message interacts with the systems as shown in Figure 4. 3.3.3 Message Details
3.4 CS005– Create Update City Pair Record3.4.1 Message OverviewThis message is used to create or update database entries for the loading of QBR data. QBR is a combination of air queue, burn factor and holding time. There are two sets of data that airlines may set. These sets are based on seasonal traffic. For example, set 1 may be used during summer, while set 2 may be used in winter operations. 3.4.2 Message System FlowThis message interacts with the systems as shown in Figure 5. 3.4.3 Message Details
3.5 CS007– Delete City Pair Record3.5.1 Message OverviewThis message is used to delete database entries related to QBR data. QBR is a combination of air queue, burn factor and holding time. There are two sets of data that airlines may set. These sets are based on seasonal traffic. For example, set 1 may be used during summer, while set 2 may be used in winter operations. 3.5.2 Message System FlowThis message interacts with the systems as shown in Figure 6. 3.5.3 Message Details
3.6 CS008 – Validate Airport3.6.1 Message OverviewThis message is used in the validation of user-specified Airports for flight planning. This message is a request response pattern. The typical usage of this message is for the validation of airports when a dispatcher is preparing a flight plan and inputting airports for various purposes, such as alternates. Alternates such as ETOPS and drifdown are examples of airports that may be selected by a dispatcher. The dispatch system would send the message request to the airport validation service. The airport validation service then validates that the airport can be used for the specified purpose with the specified aircraft or aircraft type (equipment code / fleet type). The airport validation service then responds with the valid uses for that airport. 3.6.2 Message System FlowThis message interacts with the systems as shown in Figure 7. 3.6.3 Message Details
3.7 CS009 – Search Proximity (For Alternate Airport)3.7.1 Message OverviewThis message is used to locate alternate airports within a certain proximity range to another airport based on distance and aircraft type. This message is a request response pattern. Dispatchers may need to locate nearby alternate airports when scheduling a flight or when responding to a mandatory reroute. The dispatch system requests the proximity airport information from an Airport Proximity Service (like the one provided by Jeppesen's JetPlan engine). The Airport Proximity Service then calculates eligible alternate airports (within the specified proximity) for their given Aircraft fleet, and provide the response to the dispatch system. Note that this message does not update a database. 3.7.2 Message System FlowThis message interacts with the systems as shown in Figure 8.
3.7.3 Message Details
3.8 CS010 – Create Update Airport Fleet Record3.8.1 Message OverviewThis message is used to create or update database entries for the estimated taxi in and out times associated with a specific airport fleet. An "airport fleet" is one or more airports through which an aircraft (or aircraft fleet) can operate. Airlines can provide the average taxi times for both out of and into an airport, based on averages that have been collected. The average, or base, taxi time is then adjusted based on the time of day. For example, if the base time for a taxi out is 15 minutes, but for the segment of time between 1600 and 1659, the adjustment is -3, then the total taxi time out for leaving the airport at 1630 would be 12 minutes. 3.8.2 Message System FlowThis message interacts with the systems as shown in Figure 9. 3.8.3 Message Details
3.9 CS012 – Delete Airport Fleet Record3.9.1 Message OverviewThis message is used to delete database entries for the estimated taxi in and out times associated with a specific airport fleet. Note that use of this message causes the delete of a entire Airport Fleet Taxi Times record. 3.9.2 Message System FlowThis message interacts with the systems as shown in Figure 10.
3.9.3 Message Details
3.10 CS013 – Create Update Airport Record3.10.1 Message OverviewThis message is used to create or update database entries associated with a specific airport record.3.10.2 Message System FlowThis message interacts with the systems as shown in Figure 11. 3.10.3 Message Details
3.11 CS014 – Delete Airport Record3.11.1 Message OverviewThis message is used to delete database entries for a specific airport record.3.11.2 Message System FlowThis message interacts with the systems as shown in Figure 12. 3.11.3 Message Details
3.12 CS015 – Create Update Airport RNP Record3.12.1 Message OverviewThis message is used to create or update RNP database entries for a specific airport record.3.12.2 Message System FlowThis message interacts with the systems as shown in Figure 13. 3.12.3 Message Details
3.13 CS016 – Delete Airport RNP Record3.13.1 Message OverviewThis message is used to delete RNP entries for a specific airport record. Note that this message is used to delete an entire record. It can NOT be used to delete select information within a record.3.13.2 Message System FlowThis message interacts with the systems as shown in Figure 14. 3.13.3 Message Details
3.14 CS017 – Read Airport RNP Record3.14.1 Message OverviewThis message is used to request a report for ONE or ALL RNP records from a database. One system sends a CS017 (request) to the second system containing the RNP data asking for one or all records. The second system then sends the requested report within the CS017 (response).3.14.2 Message System FlowThis message interacts with the systems as shown in Figure 15. 3.14.3 Message Details
3.15 CS018 – Airport RNP Record3.15.1 Message OverviewThis message is used to send an error message if the following messages are unsuccessful: CS016 (Create/Update Airport RNP Record), or CS017 (Delete Airport RNP Record)3.15.2 Message System FlowThis message interacts with the systems as shown in Figure 16. 3.15.3 Message Details
3.16 CS019 – Operator Configuration Data3.16.1 Message OverviewThis message is a request that is automatically sent from a dispatch client when a user logs into the client. The purpose of the request is to query the Jeppesen identity management system for a list of the data sources from which the operator is authorized to receive data feeds. The response message is received from Jeppesen's identity management system back to the dispatch client in response to the CS019 request. The purpose of the response is to provide the user of the dispatch client with a list of data sources from which the operator is authorized to receive data feeds.3.16.2 Message System Flow
3.16.3 Message Details
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||