Enterprise Resource Planning

System and Message Overviews

Document Version: 5.2

Date: March 3, 2014


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

04-August-08

No changes since previous release.

30-August-10

Updated links for new Bookshelf directory structure.

23-July-13 New XSD.
3-March-14 New XSD.


Table Of Contents

 


1  Introduction

This document defines the interfaces which govern the interchange of data between an ERP 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.

ERP messages support new customer account creation and maintenance, and transaction billing.

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 within ERP.

1.2  Scope

This document discusses the ERP 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: EnterpriseResourcePlanning.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 “EP”) are further discussed in Section 3 AOC Interface Messages.

Table 2-1 Message Summary

ID

Message

Publish

Subscribe

Request

Response

EP001

Create Customer Account

 

 

X

X

EP002

Verify Customer Account

 

 

X

X

 

3 AOC Interface Messages

The following messages are processed by the ERP system.

3.1 EP001 – Create Customer Account

3.1.1  Message Overview

The tables presented in this section describe how customer account records are created. The content of each table describes a type of message that either requests an action or responds to the request. For example, a message type may request that a new data record be created. For each request message type, there is a corresponding response message.

3.1.2  Message System Flow

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

EP001 Message System Flow

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

EP001 vA

Message Header Details
(REQUEST/RESPONSE)

msgName: EP001
msgClass: REQUEST/RESPONSE
version: A

Message Specification

EP001 CreateCustomerAccountRequestType
EP001 CreateCustomerAccountResponseType

Defined in XSD

ERP.xsd

Sample Messages

EP001vACreateCustomerRequest.xml
EP001vACreateCustomerResponse.xml

Message Version History No changes

 

3.2 EP002 – Verify Customer Account

3.2.1 Message Overview

The tables presented in this section describe how customer account is verified for validity and currency. The content of each table describes a type of message that either requests an action or responds to the request. For example, a message type may request information concerning the validity and status of a user account. For each request message type, there is a corresponding response message.

3.2.2  Message System Flow

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

EP002 Message System flow

Figure 2. EP002 message system flow

3.2.3  Message Details

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

Message Version

EP002 vA

Message Header Details
(REQUEST/RESPONSE)

msgName: EP002
msgClass: REQUEST/RESPONSE
version: A

Message Specification

EP002 VerifyCustomerAccountRequestType
EP002 VerifyCustomerAccountResponseType

Defined in XSD

ERP.xsd

Sample Messages

EP002vAValidateCustomerRequest.xml
EP002vAValidateCustomerResponse.xml

Message Version History * Added airline code (customer) information to EP002 request. Changed userStatus in
EP002 from Mandatory (M) to Conditional (C).
* Added list of valid products to EP002
response.