Heartbeat
System and Message Overviews
Document Version: 1.10
Date: December 24, 2014
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. |
7-October-2010 |
Updated sample message HB001. |
1-May-2012 |
Updated AOC Heartbeat webpage links |
| 23-July-13 | New XSD. |
| 3-March-14 | New XSD. |
| 24-December-14 | New XSD. Added new boolean element to HB001, made all timestamps in request/response optional. Changed name of element in response from heartbeatResponseGood to targetSystemOnline, boolean, required. If true then target system online. If false then target system is not online. |
Table Of Contents
1 Introduction
This document defines the interfaces which govern the interchange of data between a "Heartbeat" message 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 Communications 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: Heartbeat.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 “HB”) are further discussed in Section 3 AOC Interface Messages.
Table 2-1 Message Summary
| ID | Message |
Publish |
Subscribe |
Request |
Response |
HB001 - HB009 |
Heartbeat |
|
|
X |
X |
3 AOC Interface Messages
The following messages are processed by the Communications system.
3.1 HB001 - HB009 Heartbeat
3.1.1 Message Overview
This message is used by a monitoring application to check the status of applications within the AOC. The monitoring application sends a request to an application and then waits for a response. If the target application does not respond, or responds too slowly, then the monitoring application can send an alert.
Request/Response messages can only be sent from one node to another node in AOCi. Therefore, Jeppesen has provided identical messages HB001 through HB009 so that a monitoring application can check the status on multiple applications within the AOC.
3.1.2 Message System Flow
This message interacts with the systems as shown in Figure 2.
Figure 1. HB001 - HB009 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 |
HB001 v2 |
Message Header Details (REQUEST/RESPONSE) |
msgName: HB001 |
Message Specification |
|
Defined in XSD |
|
Sample Messages |
Samples not yet available for this message version. |
| Message Version History | Updated sample message.
|