Alert Notification

System and Message Overviews

Document Version: 2.6

Date: November 11, 2021

Document Revision History

The following revision history table reflects all substantive changes to this document.

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

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.

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.

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.

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.

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.

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.

3.4 AN004 – Desk Assignment Notification

3.4.1  Message Overview

The Message Overview for this version is not yet available for this DRAFT version.

3.4.2  Message System Flow

The Message System Flow diagram is not yet available for this DRAFT version.

3.4.3   Message Details

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

3.5 AN005 – Desk Assignment Alert Query

3.5.1  Message Overview

The Message Overview for this version is not yet available for this DRAFT version.

3.5.2  Message System Flow

The Message System Flow diagram is not yet available for this DRAFT version.

3.5.3   Message Details

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