Maximo Enterprise AdapterSystem Administrators Guide

August 2006

MaximoRelease 6.1

This document and its publication do not constitute or create a contract. MRO Software, Inc. makes no warranties, express or implied, as to the accuracy or completeness of this document or with respect to the related software.

2006 MRO Software, Inc. All rights reserved. This document contains confidential and trade secret information of MRO Software, Inc. Use, transfer, disclosure, or copying without MRO Software, Inc.s express written permission is strictly forbidden.

Patents: United States Patent Nos. 6,324,522 B2, 6,519,588 B1, and Aust. Pat. No. 758001. Multiple foreign patents pending.

U.S. Restricted Rights: If Customer is a government agency, this constitutes notice that the Licensed Software is provided with RESTRICTED RIGHTS. Subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause at 252.227-7013 of the Department of Defense FAR Supplement and FAR clause 52.227-19 entitled Commercial Computer Software Restricted Rights, apply and use, duplication, or disclosure by the Government is subject to restrictions as set forth in the applicable license agreement. The aforementioned restrictions shall prevail over any similar Rights provisions under the laws of any country. Contractor/Manufacturer: MRO Software, Inc., 100 Crosby Drive, Bedford, MA 01730.

Trademarks: Maximo is a registered trademark, and MRO Software and MXES are trademarks, of MRO Software, Inc. The following table contains a list of MRO Softwares other trademarks and service marks:

IBM and WebSphere are registered trademarks of IBM Corporation. BEA WEBLOGIC SERVER is a registered trademark of BEA Systems, Inc. webMethods is a registered trademark of webMethods, Inc. Snowbound and RasterMaster are trademarks of Snowbound Software Corporation. Syclo and Agentry are registered trademarks of Syclo, LLC.

Other products and brand names are trademarks or registered trademarks of their respective companies.

Third-Party Technology: Certain MRO Software, Inc. products contain technology provided under license from third parties, as noted in the following table:

Open Source: Maximo contains computer software obtained from the public domain, known as Open Source. A complete listing of all Open Source contained in Maximo may be viewed at http://www.mro.com/support/opensource ownership of which is attributed as follows: Portions 2005, International Business Machines Corporation and others. Portions 2002, Steve Souza (admin@jamonapi.com). Portions 2000 by Jef Poskanzer (jef@acme.com). Portions 2000-2004 Jason Hunter & Brett McLaughlin. Portions 2004-2005, The Apache Software Foundation (http://www.apache.org/).

Maximo Enterprise

Maximo Enterprise ITAM

Maximo Service Desk

Maximo Discovery

Maximo Navigator

Maximo Calibration

Maximo SLA Manager

Maximo Change Manager

Maximo Project Manager

Maximo Contract and Procurement Manager

Maximo Incident and Problem Manager

Maximo OCSSM

Maximo Fusion

Maximo Enterprise Adapter

Maximo Mobile Suite

Maximo Mobile Auditor

Maximo Mobile Inventory Manager

Maximo Mobile Work Manager

Maximo Mobile Calibration

MXESTM Mobile Suite

Maximo Mobile for Work Management

Maximo Mobile for Inventory Management

MRO Software Products Third-Party Information

Maximo Portions 1995-2004 Actuate Corporation. Portions 2005 BEA Systems, Inc. BEA WebLogic Server provided by BEA Systems, Inc. Portions 1996-2005 IBM Corporation. All Right Reserved.

Portions 1996-2005, i-net software GmbH. J-Integra for COM v2.4 2004 Intrinsyc Software International, Inc.

All Products Portions 1996-2003 Visual Mining, Inc. Visual Mining NetCharts Server provided by Visual Mining, Inc.

Maximo Discovery 1998-2005 Centennial Software Limited. MSDE Copyright Microsoft Corporation.

Maximo Navigator Portions 1993-2002 Snowbound Software Corporation. RasterMaster Raster imaging technology provided by Snowbound Software Corporation. Portions 1991 Pegasus Imaging Corp.

Maximo Mobile Suite Portions 1996-2005 Syclo, LLC.

MXES Mobile Suite Portions 2005 DataMirror, Inc. Portions 2000-2005 Zaval Creative Engineering Group.

Maximo 6, 08/2006 iii

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiWhy Read This Guide?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiAudience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiNotation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiiSection Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiiChapter Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiiiRelated Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xivSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Section I: Using the Maximo Integration

Chapter 1: What is the Maximo Enterprise Adapter? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Chapter 2: Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2Integration Object Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5

Integration Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5Integration Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7

Integration Point Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7Query and Response Integration Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7Integration Point Processing Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8

Real Time Integration Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8Interface Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9

Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9Internal Type Adapters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9External Type Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10

Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10Interface Operation Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12Query and Response Type Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12Interface Processing Class and User Exit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12Data Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13Interface Data Format Conversion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13

Interface Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14Interface Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14

External System Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15External System Definition and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15Interface Control Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16End Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16Inbound and Outbound Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17

Inbound and Outbound Communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18Inbound Gateway Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18Outbound Handler Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19

Chapter 3: Outbound and Inbound Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Outbound Integration Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Initiating the Outbound Integration Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Real Time Integration Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Batch Integration Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

Building the Integration Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Contents

Contents

iv Maximo 6, 08/2006

Applying Integration Point Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7Duplicating the Integration Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8Applying Interface Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10Applying User Exit Preprocessing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11Applying Interface Class Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12Applying User Exit Postprocessing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13Applying XSL Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14Sending the Interface to the External System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-15

Inbound Integration Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16Queue-based Inbound Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17

Initiating the Inbound Integration Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18Writing Messages to the Inbound Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19Retrieving Messages from the Inbound Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22Identifying the Integration Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23Applying User Exit Preprocessing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24Applying Interface Class Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-25Applying User Exit Postprocessing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-26Applying XSL Mapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-27Duplicating the Integration Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-28Applying Integration Object Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-30Building the MBOs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31Applying MBO Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-32Applying the Integration Point Processing Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33Applying User Exit MBO Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34Applying MBO Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-35

Web Services Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36Data Synchronization Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37Query Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38

Chapter 4: Maximo XML and Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Structure of Maximo XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Interface Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Header Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Header Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Header Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

Content Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Standard Integration Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Merged Integration Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Action Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

Add Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9Delete Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9Update Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9Comparison of the Change, Replace, and AddChange Actions. . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Valid Action Attribute Combinations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

Field Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Changed Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Glorder Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16Langenabled Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17Maxvalue Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

Additional Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18XML Schemas for Maximo Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19

Schema Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19Key Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19Validation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19Schema Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19

Schema Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20Regeneration of the Schema Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20

Contents

Maximo 6, 08/2006 v

Chapter 5: Interface Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Use of Interface Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Location of Interface Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Naming Convention for Interface Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Interface Queue Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3Creation of Interface Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Regeneration of Interface Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Deletion of Interface Tables and Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Format of Interface Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

Key Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Duplicate Columns and Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6

Column Name Lengths and Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Update of an Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6

Restricted Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7Integration Processing Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

IFACENAME Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7TRANSID Column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8TRANSSEQ Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10EXTSYSNAME Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10ACTION Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11

Long Description Columns in Oracle Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11Interface Table Polling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12External System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13

Chapter 6: Basic Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Predefined Components and Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Configuration Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3Prerequisite Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6Configuring Integration Administration Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6

Maximo User Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Global Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Update SENDERSYSID Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Domain Values Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Administrator and Sender E-mail Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-7Mail Server Host Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7

Configuring and Enabling the JMS Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8Queue Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8Enabling the Cron Task for the Sequential Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10Enabling the Message Beans for the Continuous Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12

Configuring External System and Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13Creating an External System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13Identifying the Queues to the External System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14Creating or Configuring an End Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15Assigning the End Point to an External System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17Enabling Outbound Integration Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17Disabling Unneeded Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19Associating Inbound and Outbound Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20Specifying the Inbound Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21

Configuring External System Interface Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23Changing System-Level Default Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23Assigning Organization and Site Level Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28

Enabling the External System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32Restarting the Maximo Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32Creating Interface Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33

Creating the Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33Configuring the Cron Task for the Interface Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-35

Contents

vi Maximo 6, 08/2006

Configuring the Data Export Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-36Configuring the Data Import Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-38

Chapter 7: Error Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1Queue Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Interface Table Error Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Error Management Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Integration Administration Setup Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4External Systems Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5Maximo.properties Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

Error Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Error Management Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7Error Correction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9

Common Causes of Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9Researching Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10Updating Message Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11Deleting Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11

Section I: Advanced Topics

Chapter 8: Integration Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1Gateway Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

Interpretation Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2Writing Your Own Interpreter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3Bypassing Interpretation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4Sending Transactions via EJB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5

Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5

Sending Transactions via HTTP/HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6

Sending Transactions via the Gateway Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7

Chapter 9: Router. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1End Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3

EJB Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4FLATFILE Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6

Flat File Naming Convention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6Flat File Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7Flat File Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7

HTTP Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8IFACETABLE Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9JMS Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10WEBSERVICE Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12XMLFILE Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-14

Writing Custom Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-15

Chapter 10: Advanced Interface Table Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1Cron Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2Selectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2Queue Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3

Chapter 11: JMS Queue Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1Sequential Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2Continuous Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3

Contents

Maximo 6, 08/2006 vii

Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3Number of Beans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4Caching of Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4Redelivery Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4

Selectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5Queue Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6Queue Creation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7Queue Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7

Chapter 12: Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1Securing Integration Queues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2Securing the Integration Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4Securing the Gateway Web Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-6Securing the Servlet (HTTP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7Securing Maximo Web Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-9Securing the Remote Integration APIs (MicService) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12Securing Interface Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12Outbound Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12

Chapter 13: Cluster Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1Cron Task Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2JMS Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2Global Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3Integration Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3

EJB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3Servlet (HTTP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3Gateway Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3Maximo Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4

Chapter 14: Customization with Processing Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1MBOs and Sub-records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2Defining a Processing Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3

Specifying the Sub-record or MBO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3Specifying when to Trigger the Processing Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4Specifying the Processing Rule Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4

Message Processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4Field Transformation Actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5

Specifying the Processing Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10Defining Conditions and Evaluations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10

Specifying a Condition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10Specifying the Evaluation Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11Specifying the Field to Evaluate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-13Specifying the Type of Evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14Specifying when to Evaluate the Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-15Specifying the Comparison Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16

Interface Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18Control Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18Control Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19

Boolean Type Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19List Type Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19Value Type Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19Cross-Reference Type Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19

Creating New Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-20

Chapter 15: Customization with User Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1Outbound Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-2

Integration Point Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4Interface Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4

Contents

viii Maximo 6, 08/2006

User Exit Preprocessing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4Interface Processing Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-5User Exit Postprocessing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-6XSL Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-6Handler Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-7

The HTTP Processing Exit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15-7The EJB Processing Exit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-8The JMS Processing Exit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-9The Web Service Processing Exit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-10

Inbound Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-12Interface Table User Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-13XSL Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-14User Exit Preprocessing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-15Interface Processing Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-16User Exit Postprocessing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-16Integration Object and MBO Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-17Integration Point Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-17MBO User Exit Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-18

Chapter 16: Adding and Modifying Integration Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1Adding or Modifying a Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-2Creating an Integration Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-2

Determining the Required MBOs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-2Building the Integration Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-3

Alternate Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-4Required Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-6Interface Table and Flat File Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-6Inbound Setting Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-7

Modifying a Predefined Integration Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-8Creating an Integration Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-9Modifying a Predefined Integration Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-11Creating Adapters and Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-11

Creating an Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-11Creating Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-13

Modifying Predefined Adapters and Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-15Creating an External System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-16Modifying a Predefined External System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-17

Chapter 17: Using Integration Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1Query Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-2Header Attributes for Query Type Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-3Header Attributes for Response Type Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-4Content Element for Query Type Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-5

Operator Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-5Field Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-6Range Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-7

Content Element for Response Type Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-8Web Service Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-8

Chapter 18: Maximo Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1Web Services Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-2Web Service Deployment Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-4XML Schema Generation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-5WSDL Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-6Web Service Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-7UDDI Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-8Invoking a Maximo Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-9Web Services Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-9

Contents

Maximo 6, 08/2006 ix

Chapter 19: Multiple Language Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1Default Processing for Translatable Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-2Outbound Multi-Language Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-2Inbound Multi-Language Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-3Additional Multi-Language Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-3

Appendix A: MAXIMO Adapter Interface Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Application Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2System Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4

Appendix B: MAXIMO Adapter Interface Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1Master Data Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2

MXASSETInterfaceAsset Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3MXCOAInterfaceChart of Accounts Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-4MXCRAFTInterfaceCraft Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-6MXGLCOMPInterfaceGeneral Ledger Components Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . B-7MXLABORInterfaceLabor Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8MXOPERLOCInterfaceOperating Locations Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-9MXPERSONInterfacePerson Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10MXPROJInterfaceFinancial Projects Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-11MXSTORELOCInterfaceStoreroom Location Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-12MXVENDORInterfaceVendor Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-13MXVENDORMSTRInterfaceVendor Master Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-14

Item Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-15MXITEMInterfaceItem Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-16MXSERVITEMInterfaceService Item Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-17MXTOOLITEMInterfaceTool Item Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-18MXINVENTORYInterfaceInventory Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-19MXINVBALInterfaceInventory Balance Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-20MXINVVENDORInterfaceItem-Vendor Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-21MXINVRESInterfaceInventory Reservations Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-22MXINVISSUEInterfaceIssues Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-23

Document Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-24The STATUSIFACE Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-24

The STATUSIFACE Field and Outbound Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-24The STATUSIFACE Field and Inbound Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-25

Outbound Processing Rules for Purchasing Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-26MXPCInterfacePurchase Contract Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-28MXPOInterfacePurchase Order Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-30MXPRInterfacePurchase Requisition Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-31MXINVOICEInterfaceInvoice Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-32

Outbound Processing Rules for Work Order Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-35MXWOInterfaceWork Order Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-36MXWODETAILInterfaceWork Order Details Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-37

Transaction Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-38MXRECEIPTInterfaceReceipts Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-39MXRCVROTITMInterfaceMaterial Receipts Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-42MXGLTXNInterfaceGeneral Ledger (Journal Entry) Interface . . . . . . . . . . . . . . . . . . . . . . B-44MXEMPACTInterfaceLabor Time Reporting Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-49

System Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-50MXINTOBJInterfaceIntegration Object Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-51MXINTTYPEInterfaceIntegration Adapter Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-52MXINTIFACEInterfaceIntegration Master Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-53MXENDPOINTInterfaceEnd Point Master Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-54MXEXTSYSInterfaceExternal System Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-55MXMESSAGEInterfaceMessage Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-56MXOBJECTCFGInterfaceMBO Configuration Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . B-57MXDOMAINInterfaceDomain Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-58

Contents

x Maximo 6, 08/2006

MXWFInterfaceWorkflow Definition Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-59MXCTEMPLATEInterfaceCommunication Template Interface. . . . . . . . . . . . . . . . . . . . . . B-61MXACTIONInterfaceAction Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-62MXMAXROLEInterfaceMaximo Role Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-63

Appendix C: Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1Format of Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2

Process Control ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2System ID 1 and System ID 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3Process Control Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3

Default Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3Retrieving a Collaboration Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4Viewing Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-5Modifying a Collaboration Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-6Adding a Collaboration Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-6Inventory Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-9Invoice Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-11Labor Transaction Collaboration Switches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-13Purchase Order Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-13Purchase Requisition Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-15Receipt Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-17Work Order Collaboration Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-18

Appendix D: Creating the JMS Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-1Creating the JMS Queues in WebLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-2Configuring the MEA Connection Factory in WebLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-18Configuring the Redelivery Delay in WebLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-20Configuring Maximum JMS Queue Space in WebLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-21Creating the JMS Bus (Queues) in WebSphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-23

Adding Servers to the JMS Bus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-25Creating the JMS Bus Destination for the Continuous Inbound (cqinbd) Queue . . . . . . . . . . . . . D-27Creating the JMS Bus Destination for the Sequential Inbound (sqinbd) Queue. . . . . . . . . . . . . . D-32Creating the JMS Bus Destination for the Sequential Outbound (sqoutbd) Queue . . . . . . . . . . . D-33

Creating the MEA Connection Factory and Queues in WebSphere . . . . . . . . . . . . . . . . . . . . . . . . . . . D-34Creating the Continuous Inbound (cqin) JMS Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-36Creating the Sequential Inbound (sqin) JMS Queue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-37Creating the Sequential Outbound (sqout) JMS Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-38Creating JMS Activation for the Continuous Inbound Queue (cqin) . . . . . . . . . . . . . . . . . . . . . . . D-39

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1

Maximo 6, 08/2006 xi

About This Guide

This section briefly summarizes this document and how it can help you as a Maximo user. It also provides information about other MRO resources available to you, such as additional documentation and support.

Why Read This Guide?

This guide explains how to implement the Maximo Enterprise Adapter applications and customize them for your business practices.

Audience

The guide is intended for the following people: T Developers T Implementation analystsT Support personnel T System administrators

Notation Conventions

xii Maximo 6, 08/2006

Notation Conventions

The following notations have special meaning:

Section Contents

This guide consists of two sections:

Notation Description

Bold text Denotes a button, check box, or field on a screen

T Bulleted procedures Instructions that you can perform in any sequence

CAUTION Precedes information that, if ignored, can result in loss of data

NOTE Precedes information of special importance

1 Numbered procedures Instructions that you must perform in the numbered sequence

Denotes an XML tag

Denotes a variable

[data value] Denotes an optional variable

Section Name Section Contents

Using the Maximo Integration Overall features and concepts of the Maximo Integration

Advanced Topics Customization, performance tuning, and other activities

About This Guide

Maximo 6, 08/2006 xiii

Chapter Contents

The following table briefly describes each chapter in this document. Read the chapters in the order they appear and perform the tasks in sequence as written.

Chapter Name Chapter Contents

Chapter 1: What is the Maximo Enterprise Adapter?

Features of the Maximo Enterprise Adapter and the MAXIMO adapter

Chapter 2: Architecture Architecture of Maximos integration functionality

Chapter 3: Outbound and Inbound Processing

Processing of outbound and inbound transactions

Chapter 4: Maximo XML and Schema

Structure, elements, and attributes of XML messages created by Maximo

Chapter 5: Interface Tables Use of interface tables to exchange messages

Chapter 6: Basic Configuration

Configuration of Maximo for basic integration processing

Chapter 7: Error Management Error notification and correction

Chapter 8: Integration Gateway

Receipt and interpretation of XML transactions via the integration gateway

Chapter 9: Router Routing of outbound messages from the JMS queue to an external system

Chapter 10: Advanced Interface Table Polling

Performance tuning of the interface table polling process

Chapter 11: JMS Queue Configuration

Configuration of JMS queues

Chapter 12: Security Security options for integration processing

Chapter 13: Cluster Configuration

Integration considerations when running Maximo in a cluster

Chapter 14: Customization with Processing Rules

Customization of integration processing without Java classes

Chapter 15: Customization with User Exits

Customization of integration processing with Java classes and XSL

Related Documentation

xiv Maximo 6, 08/2006

Related Documentation

You can find more information regarding the Maximo Enterprise Adapter in the following documents:

Chapter 16: Adding and Modifying Integration Components

Creation of new integration components and modification of predefined components

Chapter 17: Using Integration Queries

Use of the Maximo Integration to query the Maximo database

Chapter 18: Maximo Web Services

Configuration and deployment of Maximo Web services

Chapter 19: Multiple Language Support

Use of multiple languages in integration transactions

Appendix A: MAXIMO Adapter Interface Components

Predefined components provided with the MAXIMO adapter

Appendix B: MAXIMO Adapter Interface Specifications

Details about the interfaces defined within the MAXIMO adapter

Appendix C: Collaboration Switches

Description of the collaboration switches for each Maximo application

Appendix D: Creating the JMS Queues

Creation of the JMS queues after the installation of Maximo

Chapter Name Chapter Contents

Document Description

Maximo Users Guide Provides an overview of Maximo features, and describes relationships among modules.

Maximo System Administrators Guide

Explains how to customize the system, manage the database, set up accounting features of the general ledger, and use Maximo utilities.

Maximo Installation Guide Explains how to install and configure Maximo.

Maximo online help Provides step by step procedures for every action in Maximo.

About This Guide

Maximo 6, 08/2006 xv

Support

MRO Software, Inc. users with a valid Annual Customer Support Plan (ACSP) can obtain product support online at http://support.mro.com.

The Support Web site includes information about product releases, software patches, and documentation updates. To find the most current version of a document, refer to the Support Web sites Knowledge Base.

Support

xvi Maximo 6, 08/2006

Maximo 6, 08/2006

Chapter 1: What is the Maximo Enterprise Adapter?

Chapter 2: Architecture

Chapter 3: Outbound and Inbound Processing

Chapter 4: Maximo XML and Schema

Chapter 5: Interface Tables

Chapter 6: Basic Configuration

Chapter 7: Error Management

Using the Maximo Integration I

Maximo 6, 08/2006

Maximo 6, 08/2006 1-1

The Maximo Enterprise Adapter is a set of applications and predefined integration points that help you to integrate Maximo with your enterprise applications and create business flows between Maximo and your other enterprise applications.

The key features of the Maximo Enterprise Adapter are:

T Applications to manage integration processing and to create new integration points

T An application to create processing rules for customizing interfaces

T Support for multiple integration models using HTTP, messaging, and database interface tables and flat files

T Real time, batch, and user-initiated processing of outbound and inbound interfaces

T Support for customization of the predefined integration objects

T Provision for data transformation using XSL

T Load and performance scalability using multiple queues and/or multiple queue consumers

T Support for clustered environments that enable reduced downtime and increased availability and performance

The Enterprise Adapter includes the MAXIMO adapter, which contains a comprehensive set of predefined Maximo interfaces to enable integration with Maximo applications. All MAXIMO adapter interfaces are Web service ready by default. Users can easily create new interfaces and enable them for Web service without writing any code.

The key features of the MAXIMO adapter are:

T A comprehensive set of predefined outbound and inbound integration points and interfaces

T Support for query and data synchronization interfaces

T Bulk export of all interfaces, with the ability to select data through a user-defined query

T The ability to create XML or flat files for outbound interfaces

What is the Maximo Enterprise Adapter? 1

1-2 Maximo 6, 08/2006

T The ability to perform bulk loading of XML or flat files for inbound interfaces

T Dynamic XML schema generation for all integration objects and MAXIMO adapter interfaces

T Dynamic generation of WS-I compliant Web services for all MAXIMO adapter interfaces

Additional adapters can be quickly configured and deployed for enterprise connectivity with various systems. Each adapter can have its own interfaces and delivery mode. Preconfigured adapters for Oracle and SAP are available as add-ons.

Maximo 6, 08/2006 2-1

This chapter describes the architecture of integration processing in Maximo.

Anyone involved in the implementation or day-to-day administration of the Maximo Enterprise Adapter applications should read this chapter. Familiarity with the concepts in this chapter is essential for understanding the remaining documentation and using the application.

This chapter contains the following sections:

T Overview T Integration Object Layer T Interface Layer T External System Layer T Inbound and Outbound Communication

Architecture 2

Overview

2-2 Maximo 6, 08/2006

Overview

Maximo Integration facilitates data exchange between Maximo and external applications or systems in a real time or batch mode. Data is exchanged via interfaces, each of which acts as a communication channel between the external system and one or more integration points (points of data exchange) in Maximo.

Maximo Integration Overview

ExternalSystem(s)

Inbound Processing

Outbound Processing

IntegrationObjects

andIntegration

Points

InterfacesMaximoDatabase

MaximoBusinessObjects(MBOs)

Maximo

Chapter 2: Architecture

Maximo 6, 08/2006 2-3

Maximo Integration processing can be represented in three layers, as described in the following table:

Integration Processing Layers

In addition to the three layers, the integration includes specific entities for outbound (Maximo to external system) and inbound (external system to Maximo) communication. These appear in the Inbound Gateway Communication and Outbound Handler Communication sections of the following diagram.

Integration Layer Description

Integration Object layer Create and manage integration objects and integration points. Each integration object is built from one or more MBOs that provide the content needed for a specific integration point. Integration points provide a framework for accessing the MBOs in the integration object and any methods defined on the MBOs.

Interface layer Create and manage interfaces, including business rules processing and data transformations. Interfaces implement one or more integration points in either direction (outbound or inbound) and each interface-integration point combination can have a processing class, a user exit class, and processing rules associated with it.

External System layer Create and manage external systems and their interfaces. This includes defining external systems that are exchanging data with Maximo, identifying the specific interfaces applicable to each external system in either direction (outbound or inbound), setting up interface control values where applicable for each interface, and identifying queue parameters for the system and the communication method used for sending data to the system.

Overview

2-4 Maximo 6, 08/2006

Maximo Integration Architecture

Maximo Database Tables

MAXIMO Business Objects

Integration ObjectsIntegration Points Real Time Integration Events

Integration Point Processing Class

Data Synchronization Interfaces

Interface Processing Rules

Interface Processing Class

Interface Controls

User Exit Class

Internal Adapter External Adapter

External System Definition and Configuration End Points

Inbound and Outbound Queues

Interface Control Values

Interface Tables Flat FilesXML FilesJMSHTTPEJB

SAPOracleMAXIMO Adapter

Web Service

Query/ResponseInterfaces

Inbound Gateway Communication

Outbound Handler Communication

External System Layer

Interface Layer

Integration Object Layer

Chapter 2: Architecture

Maximo 6, 08/2006 2-5

Integration Object Layer

The integration object layer of Maximo interacts with the Maximo Business Objects and facilitates their creation and maintenance.

Maximo Enterprise Adapter Integration Object Layer

Integration Objects

An integration object consists of one or more sub-records that derive their content from a particular Maximo Business Object (MBO, or may-bo). A MBO is a functional unit of the Maximo application server that defines a set of fields and business rules and may update one or more Maximo database tables.

Each sub-record contains fields from a specific MBO. When you create an integration object, you specify the MBO(s) whose fields make up the object. You can then modify the integration object by excluding unneeded fields and adding user-defined fields. The name of the sub-record is the same as that of the corresponding MBO.

MBOs and sub-records are two distinct entities and it is important to distinguish between them.

MBOs and Sub-records

Integration ObjectsIntegration Points Real Time Integration Events

Integration Point Processing Class

Integration Object Layer

Entity Description

MBO The Maximo Business Objects that Maximo uses to directly update the database. During inbound integration processing, MBOs are created from the integration object sub-records. During outbound integration processing, integration object sub-records are created from MBOs.

Sub-record A copy of a Maximo MBO that is included in an integration object. It may or may not include all the persistent and non-persistent fields in the original MBO. During outbound processing, Maximo populates the sub-record fields from the corresponding fields in the original MBO. An integration object consists of one or more sub-records.

Integration Object Layer

2-6 Maximo 6, 08/2006

Example

The predefined purchase order integration object, MXPO, contains sub-records that correspond to the MBOs in the following diagram.

MXPO Integration Object

If multiple sub-records are defined for an integration object, valid parent-child relationships must exist between the corresponding MBOs. These relationships are defined within the framework of the MBOs and are used to navigate between the various MBOs involved in defining a specific business entity.

Each MBO has persistent and non-persistent fields in its definition. A persistent field is one that maps directly to a database column in Maximo, and a non-persistent field is one that is included in the MBO definition but not stored in the database. By default, all persistent fields are included in the corresponding sub-record in an integration object, and all non-persistent fields are excluded. Users can optionally exclude persistent fields and include non-persistent ones. Users can also add user-defined fields to support data requirements beyond what is available from the MBOs.

PO sub-record(from PO MBO)

POTERM sub-record(from POCOST MBO)

POLINE sub-record(from POLINE MBO)

POCOST sub-record(from POCOST MBO)

Chapter 2: Architecture

Maximo 6, 08/2006 2-7

Integration Points

An integration point provides access to an integration object in a given direction (inbound or outbound). Outbound integration points retrieve data from the MBOs to build the integration object, while inbound integration points create, update, or query MBOs, depending on the operation associated with the point. An integration object can have multiple integration points associated with it, in either direction.

Maximo provides predefined integration points for its predefined integration objects. Most integration objects have inbound and outbound integration points; some, such as the chart of accounts, general ledger components, and journal entries, have only one or the other.

Integration Point Properties

Integration points have two primary properties, direction and operation.

The direction property indicates the origin and destination of transactions that use the point, as follows:

Outbound and Inbound Transactions

The operation property indicates the purpose of the integration point. Some operations are permitted only in specific directions:

Operation Properties

Query and Response Integration Points

Maximo provides a framework for external systems or applications to query Maximo using integration objects and query type integration points; and to return the response to the query using response type integration points. Query integration points can be defined only in the inbound direction and response integration points can be defined only in the outbound direction.

Direction Description

Outbound The data transaction originates in Maximo and is sent to an external system or application.

Inbound The data transaction originates in an external system or application and is sent to Maximo.

Operation Purpose Direction

Notify The integration point performs data synchronization.

Outbound, Inbound

Query The integration point processes queries.

Inbound only

Response The integration point provides responses to queries.

Outbound only

Integration Object Layer

2-8 Maximo 6, 08/2006

Integration Point Processing Class

An integration point processing class is a Java class that provides access to the corresponding integration object and the MBOs associated with that object. Processing classes act in conjunction with the MBOs to facilitate the transfer of data to and from Maximo. Integration point processing classes are optional; an integration point can have one or no processing classes associated with it. Users can create custom integration point processing classes.

Inbound integration point processing classes are more common than outbound ones. They often filter data; invoke specific methods on the MBOs or otherwise preprocess data; and convert integration objects back into MBOs that can be processed by Maximo.

The predefined outbound integration points typically do not use a processing class. However, in cases where Maximo uses the same MBO for different business processes or applications, an outbound integration point processing class filters the data from the MBOs to ensure that only the relevant transactions are sent out via the integration point.

Example

The MXISSUE integration object uses the MATUSETRANS MBO, which handles issues, returns, direct receipts, and invoice variance transactions. Since the MXISSUEOUT integration point sends only issue and return transactions, it uses a processing class to filter out direct receipts and invoice variance transactions.

Real Time Integration Events

During the creation of an outbound integration point, an integration event listener is automatically registered on the primary MBO of the integration object. When the listener is enabled, it monitors Maximo for activity on the corresponding MBO. Whenever any instance of that MBO is created or updated, outbound integration processing is initiated for all interfaces tied to that point.

Chapter 2: Architecture

Maximo 6, 08/2006 2-9

Interface Layer

The interface layer of the Maximo Integration exposes integration points to external systems and applications. Interfaces provide the ability for multiple external systems and applications to access inbound integration points, and outbound integration points to send data to multiple external systems and applications.

Maximo Enterprise Adapter Interface Layer

Adapters

All interfaces are defined within an adapter, which is a set of related interfaces, programs, mappings, and controls.

By default, all interfaces provided with Maximo are defined within the MAXIMO adapter. Predefined adapters for integration with major application providers like Oracle and SAP are available from MRO Software. Users can add new interfaces to an existing adapter and create new adapters, if necessary.

Adapters can be of an internal or external type, depending on the data format of the interfaces within the adapter.

Internal Type Adapters

Interfaces defined within internal type adapters derive their content definition directly from the corresponding integration objects; that is, there is no difference between the integration object data format and the interface data format.

Since the formats of the interface and integration object are the same, internal type adapters allow the use of interface tables (database tables) as well as XML messages to process interfaces defined within these adapters. Interface tables are one of the mechanisms available to Maximo users for processing inbound and outbound data. Their format mirrors that of corresponding interfaces and they are available only for interfaces that are defined within internal type adapters. For more information about interface tables, see Chapter 5, "Interface Tables," on page 5-1.

The MAXIMO adapter provided with Maximo Integration is an internal type adapter. By default, new adapters are created as internal type adapters.

NOTE Maximo Web services are available only for interfaces defined within the MAXIMO adapter.

Data Synchronization Interfaces

Interface Processing Rules

Interface Processing Class

Interface Controls

User Exit Class

Internal Adapter External Adapter

SAPOracleMAXIMO Adapter

Query/ResponseInterfaces

Interface Layer

Interface Layer

2-10 Maximo 6, 08/2006

External Type Adapters

Interfaces defined within external type adapters use a data format different from that used by Maximo. Mapping between the external format and Maximo format is done using Java code or XSL style sheets. Interfaces defined for external type adapters cannot use interface tables to process data between Maximo and an external system.

Interfaces

Maximo uses interfaces to transform data from Maximo format to an external format, and vice versa; and to apply additional business rules to the data beyond the rules implemented in the inbound or outbound integration point associated with the interface.

For example, Maximo might need to send accounting transactions to a general ledger application, purchasing requisitions to a central purchasing application, and so on. Each external system or application uses different data formats and business rules. Application- and external system-specific interfaces process the transactions according to the formatting and processing requirements of each external system.

Maximo provides predefined application-specific interfaces and system interfaces. The latter are primarily for updating metadata in Maximo. For more information about system interfaces, see "System Interfaces" on page B-50.

If an integration object is specified for an interface, it restricts the integration points that can be associated with the interface, as follows:

An integration object must be defined for an interface within an internal type adapter. These interfaces use the content definition of the integration object that is associated with the interface.

Integration objects cannot be specified for interfaces within an external type adapter. The format of the interface is not based on an integration object. A Java class or XSL style sheet must be used to create the necessary format.

Chapter 2: Architecture

Maximo 6, 08/2006 2-11

Interfaces in Internal Type Adapters

Interfaces in External Type Adapters

Maximo Enterprise Adapter Purchase Order Components

Direction Restrictions

Outbound Only one integration point can be specified for the interface. The integration point must be defined on the integration object associated with the interface.

Inbound Multiple inbound integration points can be specified for the interface, and they do not need to be defined for the integration object associated with the interface. If multiple inbound integration points are specified, they must belong to different integration objects; that is, for a given interface, there cannot be two inbound integration points specified for the same integration object.

Direction Restrictions

Outbound Multiple integration points can be specified for an interface. If multiple points are specified, they must belong to different integration objects; that is, for a given interface, there cannot be two inbound integration points specified for the same integration object.

Inbound Same as outbound.

MXPOInterfaceInterface

MXPOOUTOutbound

Integration Point

MXPOIntegration Object

MXPOINInbound

Integration Point

MXPOIntegration Object

MXPOInterfaceInterface

Interface Layer

2-12 Maximo 6, 08/2006

Interface Operation Property

Like integration points, every interface has an operation property (Notify, Query, or Response), which indicates the purpose of the interface. An operation must be specified for an interface before integration points are associated with the interface.

The operation specified for the interface restricts the integration points that can be associated with the interface. Only integration points with the same operation property can be associated with an interface; that is, notify type interfaces can be associated only with notify type integration points; query type interfaces with query type integration points; and response type interfaces with response type integration points.

Query and Response Type Interfaces

Query and response operations are available only for interfaces defined within the MAXIMO adapter. They expose the Query and response type integration points defined on an integration object and allow a user to query Maximo for data using XML documents. The Query and response type interfaces are available only via Maximo Web services.

Interface Processing Class and User Exit Class

Like integration point processing classes, interface processing and user exit classes are Java classes that contain processing logic. An interface maps to one or more integration points in either direction; for each interface-integration point combination, you can optionally specify one interface processing c