Alert Notification

System and Message Overviews

Document Version: 2.5

Date: October 2, 2019


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

31-March-10

Original publication of document.

31-July-10 Updated AN001 and AN002 from DRAFT to version 1.

15-September-10

Updated links for new Bookshelf directory structure. Added new message AN003.

7-October-10

Added an updated XSD. Updated message AN003

18-November-10 Added updated XSD.
1-May-12 Added updated XSD.
23-July-13 New XSD
3-March-14 New XSD
26-May-15 New XSD. Common.xsd added flightKey which had a trickle-down effect causing this xsd to be updated
3-March-16 New XSD. Updated AN003 to version 2. Added optional string elements: icaoFormattedText, simpleFormattedText, companyFormattedText, eNotamFormattedText to CM004 publish, ND003 response, AN003 Publish messages.
1-November-17 New XSD. Updated AN002 to version 2. Added gufiId.
15-October-18 New XSD. Updated AN003 to version 3. Created CustomFlightKeyChoice in common that includes a choice of gufi + departureAirport, custom commerical flight key with gufiId + customAirport structure, and customBagaFlightKey with gufiId+customAirportStructure.
25-October-18 New XSD. Updated AN003 to version 4: NotamAlertType for output of the 633-2 basic and/or extended xml, optional, and added phase information.
2-October-19 etd Removed AN002v1ErrorNotification.xml, AN002vAErrorNotification.xml, and AN003v3BagaFlightKey.xml samples


Table Of Contents

 


1  Introduction

This document defines the interfaces which govern the interchange of data between an Alert Notification 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 for any programs that require the Alert Notification system.

1.2  Scope

This document discusses the Alert Notification 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: AlertNotification.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 “AN”) are further discussed in Section 3 AOC Interface Messages.

Table 2-1 Message Summary

ID

Message

Publish

Subscribe

Request

Response

AN001

Alert

X

 

 

 

AN002

Error Notification

X

 

 

 

AN003

NOTAM Alert

X

 

 

 

 

3 AOC Interface Messages

The following messages are processed by the Alert Notification system.

3.1 AN001 – Alert

3.1.1  Message Overview

This message sends an unsolicited message (i.e. alert) to systems within the AOC. The message includes a configurable alert level (1-4), which can be used to trigger custom behavior in the recipient system, and a text description of the alert. These alerts can be sent to flights or desks.

3.1.2  Message System Flow

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

AN001 message system flow

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

AN001 v1

Message Header Details

msgName: AN001
msgClass: PUBLISH
version: 1

Message Specification

AN001 AlertType

Defined in XSD

AlertNotification.xsd

Sample Messages

AN001v1AlertNotificationForFlight.xml
AN001v1AlertNotificationToDesk.xml

Message Version History Original publication of message.

 

3.2 AN002 – Error Notification

3.2.1  Message Overview

This message returns errors related to AOCi messages to the sending product. This message can include similar information that is currently captured in the AOCi server log.

3.2.2  Message System Flow

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

AN002 message system flow

Figure 2. AN002 message system flow

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

AN002 v2

Message Header Details

msgName: AN002
msgClass: PUBLISH
version: 2

Message Specification

AN002 ErrorNotificationType

Defined in XSD

AlertNotification.xsd

Sample Messages

No sample messages

Message Version History Version 1:
* Original publication of message.

Version 2:
* Updated AN002 to version 2. Added gufiId.

*** 10-2-19 edit: No Version Change: Removed AN002v1ErrorNotification.xml, and AN002vAErrorNotification.xml samples

 

3.3 AN003 – NOTAM Alert

3.3.1  Message Overview

The AN003 message is sent from a NOTAM Management Tool to a downstream client system (i.e. Dispatch or Flight Planning system). The AN003 alerts the downstream client system of any new or cancelled NOTAM messages associated with a registered flight that has been flagged to send alerts.

Figure 3 illustrates a sample use case for this message.

Figure 3. AN003 use case

3.3.2  Message System Flow

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

AN003 message flow

Figure 4. AN003 message system flow

3.3.3   Message Details

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

Message Version

AN003 v4

Message Header Details

msgName: AN003
msgClass: PUBLISH
version: 4

Message Specification

AN003 NotamAlertType

Defined in XSD

AlertNotification.xsd

Sample Messages

AN003v1NotamNotification.xml

Message Version History Version 2:
* Updated AN003 to version 2. Added optional string elements: icaoFormattedText, simpleFormattedText, companyFormattedText, eNotamFormattedText to CM004 publish, ND003 response, AN003 Publish messages.

Version 3:
* Updated AN003 to version 3. Created CustomFlightKeyChoice in common that includes a choice of gufi + departureAirport, custom commerical flight key with gufiId + customAirport structure, and customBagaFlightKey with gufiId+customAirportStructure.

Version 4:
* Updated AN003 to version 4: NotamAlertType for output of the 633-2 basic and/or extended xml, optional, and added phase information.

*** 10-2-19 edit: No Version Change: Removed AN003v3BagaFlightKey.xml sample.