Notam Management

System and Message Overviews

Document Version: 2.14

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-July-10

Initial publication of document.

30-August-10

Updated links for new Bookshelf directory structure.

18-November-10 Updated XSD.
24-February-11 New XSD.
24-March-11 New XSD. Added NM002
8-June-11 New XSD. Added NM003
8-August-11 New XSD. Updated NM002: ad nmtAction, w/enum: ADD_OR_CHANGE, REMOVE, required to NotamType; add correlationId, xs:long, required to NotamDistributionType. NM003: add correlationId, xs:long, required to RequestNotamType
15-November-11 New XSD. Updated NM001 - Added reQuery as optl Boolean.
NM002 - Made targetSystem optional.
NM003 - Changed structure of retransmitType to required, repeatable, with two required elements:  jeppNumber (string), jeppNumberVersion (integer), Added required targetSystem, and optional targetSystemData, and changed targetSystem and targetSystemData to sourceSystem and sourceSystemData.
15-August-12 New XSD. Updated NM001 - Added new NM001 Request and Response samples to the bookshelf. NM001v3RegisterAndRequest.xml, NM001v3NotamResponseToRegisteredFlights.xml.
15-November-12 New XSD. Updated NM001 - Updated annotation in notamAlternate/"alternateCode".
23-July-13 New XSD. New sample message NM001 v3.
8-November-13 New XSD. Updated NM001 to v4.
19-March-14 New XSD. Added optional boolean "adhocQuery to request. If true, NMT knows that this is an ad hoc request and performs validation to ensure send alerts are set to false. Otherwise, NMT will return an error. If false, then NMT knows this is a typical request for Notams and alerts will automatically be sent. Set default value setting for the boolean-false.
18-September-14 New XSD. Updated NM001 Response, NotamType for new optional string "notamRunway". Added "simpleFormattedText", string to NotamType (to be populated with CDATA). Added "notamFir" to NotamType.
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 NM011 to version 7: Added new optional string element, eNotamFormattedText.
15-November-16 New XSD. Updated NM001 to version 8, and NM002 to version 4 to make Notamtype/nmtAction optional.
17-July-17 New XSD. Updated NM001 <NotamSearchCriteriaAttributetype> with new <xs:enumeration value="TERM_PROC"/>
15-October-18 New XSD. Updated NM001 to version 9: 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 NM001 to version 10, Added new element to response to carry the ntmNotamType (data from the eNOTAM stream). Added request to allow output of certain formats: simple, icao, enotam, 633-2 basic, 633-2 extended. NM001 Response, added "NotamType" for output of the 633-2 xml (basic or extended).
25-January-19 New XSD. Updated NM001 to version 11, Added receivedDate to response.
7-June-19 New XSD. Updated NM001 version 11, Updated the annotations for some NM001 response elements. No change to the version number. Update the annotation for the <eNotamFormattedText>, <basicArinc633Xml> and <extendedArinc633Xml> elements with following text: "The content of CDATA has been escaped by org.apache.commons.lang.StringEscapeUtils::escapeXml()".
2-October-19 etd Removed NM002NOTAMDistributionLoglistData.xml sample


Table Of Contents


1 Introduction

This document defines the interfaces which govern the interchange of data between the NOTAM Management 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 within an Airline Operation Center.

1.2  Scope

This document discusses the Notam Management 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: NotamManagement.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 “NM”) are further discussed in Section 3 AOC Interface Messages.

Table 2-1 Message Summary

ID

Message

Publish

Subscribe

Request

Response

NM001

Notam

 

 

X

X

NM002

Notam Distribution

X

 

 

 

NM003

Request Notam

X

 

 

 

 

3 AOC Interface Messages

The following messages are processed by the NOTAM Management system.

3.1 NM001 - NOTAM

3.1.1  Message Overview

NOTE: Some versions of the NM001 message do not include XSLs which impacts the ability to crossversion.

The NM001 message versions that do not include XSLs are not used and are not expected to be used in production.

* See the Jeppesen Solution Integrator Configuration Specification (Config Spec) for more information about release cross-versioning compatabilities.
** External customers must consult their Jeppesen representative for more information on release cross-versioning compatabilities.

The NM001 message allows external systems to request a NOTAM data package.  The package can be for a specific flight, or for a generic attributive query.  The message can be set to active, which results in alerts being triggered for new or cancelled NOTAMs that affect the NOTAM search criteria.  The NM001 can also be used to cancel an active query (discontinue alerts).

The NMT has two basic deployment types - single and multi-tenant. Within the xml schema, multi-tenant deployments must use the owner element located in the message header to carry the tenant ID for each unique tenant/customer. Single tenant deployments do not require a tenant ID.

3.1.2  Message System Flow

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

NM001 message flow

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

NM001 v11

Message Header Details (REQUEST/RESPONSE)

msgName: NM001
msgClass: REQUEST/RESPONSE
version: 11

Message Specification

NM001 NotamRequestType
NM001 NotamResponseType

Defined in XSD

NotamManagement.xsd

Sample Messages

Samples messages not yet available.

Message Version History Version 1:
* Initial publication.

Version 2:
* Basic update.

Version 3:
* Added new NM001 Request and Response samples to the bookshelf. NM001v3RegisterAndRequest.xml, NM001v3NotamResponseToRegisteredFlights.xml. Updated annotation in notamAlternate/"alternateCode".

Version 4:
* Updated NotamSearchCritieraDetailType/attribute enumerations. Added an enumeration, as follows: JEPP_BROADCAST_INDICATOR.

Version 5:
* Added optional boolean "adhocQuery" to request. If true, NMT considers this is an ad hoc request, performs validation to ensure send alerts are set to false, and returns the appropriate result set. If "adhocQuery" is set to true, and send alerts is set to true, NMT returns an error. If send alerts is set to false, then NMT considers this a registered request for NOTAMs and alerts will automatically be sent. The default value setting for the "adhocQuery" boolean = false.

Version 6:
* Updated NM001 Response, NotamType for new optional string "notamRunway". Added "simpleFormattedText", string to NotamType (to be populated with CDATA). Added "notamFir" to NotamType.

Version 7:

* Added new optional string element, eNotamFormattedText.

Version 8:
* Made Notamtype/nmtAction optional.

Version 9:
* Updated NM001 <NotamSearchCriteriaAttributetype> with new <xs:enumeration value="TERM_PROC"/> .
* Create CustomFlightKeyChoice in common that includes a choice of gufi + departureAirport, custom commerical flight key with gufiId + customAirport structure, and customBagaFlightKey with gufiId+customAirportStructure.

Version 10:
* New XSD. Updated NM001 to version 10, Added new element to response to carry the ntmNotamType (data from the eNOTAM stream).
* Added request to allow output of certain formats: simple, icao, enotam, 633-2 basic, 633-2 extended. NM001 Response, added "NotamType" for output of the 633-2 xml (basic or extended).

Version 11:
* New XSD. Updated NM001 to version 11, Added receivedDate to response.
* Updated the annotations for some NM001 response elements. No change to the version number. Update the annotation for the <eNotamFormattedText>, <basicArinc633Xml> and <extendedArinc633Xml> elements with following text: "The content of CDATA has been escaped by org.apache.commons.lang.StringEscapeUtils::escapeXml()".

 

3.2 NM002 - NOTAM Distribution

3.2.1  Message Overview

This message allows the NOTAM Management Tool (NMT) to send outbound notifications (alerts) containing xml NOTAM content based on the ingestion of NOTAMs that match active saved queries in the NMT.  The message can also be used to send outbound logList content for the purposes of reconciliation for a specific active saved query with a downstream system.

3.2.2  Message System Flow

NM001 message 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

NM002 v4

Message Header Details

msgName: NM002
msgClass: PUBLISH
version: 4

Message Specification

NM002 NotamDistributionType

Defined in XSD

NotamManagement.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History Version 1:
* Updated NM002: ad nmtAction, w/enum: ADD_OR_CHANGE, REMOVE, required to NotamType; add correlationId, xs:long, required to NotamDistributionType.

Version 2:
* Made targetSystem optional.

Version 3:
* Added "simpleFormattedText", string to NotamType (to be populated with CDATA). Added "notamFir" to NotamType.

Version 4:
* Made Notamtype/nmtAction optional.

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

 

3.3 NM003 - Publish NOTAM

3.3.1  Message Overview

This message allows downstream systems to request individual NOTAM content typically in response to activity driven by the absence of a NOTAM found in a reconciliation logList, or the existence of a NOTAM found in the downstream system, but not present in a reconciliation request logList.

3.3.2  Message System Flow

NM001 message 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

NM003 v2

Message Header Details

msgName: NM003
msgClass: PUBLISH
version: 2

Message Specification

NM003 RequestNotamType

Defined in XSD

NotamManagement.xsd

Sample Messages

NM003v2RequestNotam.xml

Message Version History Version 1:
* Updated NM003: add correlationId, xs:long, required to RequestNotamType

Version 2:
* Changed structure of retransmitType to required, repeatable, with two required elements: jeppNumber (string), jeppNumberVersion (integer), Added required targetSystem, and optional targetSystemData, and changed targetSystem and targetSystemData to sourceSystem and sourceSystemData.