BMC Atrium Integration Engine 7.1.

00

Administrator’s Guide

August 2007

www.bmc.com

Contacting BMC Software
You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain information about the company, its products, corporate offices, special events, and career opportunities.

United States and Canada
Address BMC SOFTWARE INC 2101 CITYWEST BLVD HOUSTON TX 77042-2827 USA Telephone 713 918 8800 or 800 841 2031 Fax 713 918 8000

Outside United States and Canada
Telephone (01) 713 918 8800 Fax (01) 713 918 8000

If you have comments or suggestions about this documentation, contact Information Development by email at doc_feedback@bmc.com. © Copyright 1999–2007 BMC Software, Inc. BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service marks, and logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered trademarks are the property of their respective owners. DB2 is a registered trademark of International Business Machines Corporation. IBM is a registered trademark of International Business Machines Corporation. ITIL is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is registered in the U.S. Patent and Trademark Office. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Oracle is a registered trademark of Oracle Corporation. UNIX is a registered trademark of The Open Group. BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this information is subject to the terms and conditions of the applicable End User License Agreement for the product and the proprietary and restricted rights notices included in this documentation.

Restricted Rights Legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, as amended from time to time. Contractor/Manufacturer is BMC Software, Inc., 2101 CityWest Blvd., Houston, TX 77042-2827, USA. Any contract notices should be sent to this address.

Customer Support
You can obtain technical support by using the Support page on the BMC Software website or by contacting Customer Support by telephone or email. To expedite your inquiry, please see “Before Contacting BMC Software.”

Support Website
You can obtain technical support from BMC Software 24 hours a day, 7 days a week at http://www.bmc.com/support_home. From this website, you can:
■ ■ ■ ■ ■ ■ ■

Read overviews about support services and programs that BMC Software offers. Find the most current information about BMC Software products. Search a database for problems similar to yours and possible solutions. Order or download product documentation. Report a problem or ask a question. Subscribe to receive email notices when new product versions are released. Find worldwide BMC Software support center locations and contact information, including email addresses, fax numbers, and telephone numbers.

Support by telephone or email
In the United States and Canada, if you need technical support and do not have access to the Web, call 800 537 1813 or send an email message to customer_support@bmc.com. (In the Subject line, enter SupID:<yourSupportContractID>, such as SupID:12345.) Outside the United States and Canada, contact your local support center for assistance.

Before Contacting BMC Software
Have the following information available so that Customer Support can begin working on your issue immediately:

Product information — — — Product name Product version (release number) License number and password (trial or permanent)

Operating system and environment information — — — — — Machine type Operating system type, version, and service pack System hardware configuration Serial numbers Related software (database, application, and communication) including type, version, and service pack or maintenance level

■ ■ ■

Sequence of events leading to the problem Commands and options that you used Messages received (and the time and date that you received them) — — — Product error messages Messages from the operating system, such as file system full Messages from related software

.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The data transfer process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The initialization phase. . Integration Engine service . . . . . . . . 11 AR System documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Gathering information. . . . . . . . . . . . Installing or upgrading Integration Engine on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Data Exchange application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Performance considerations . . . . . . . . . . . . . . . . . . . . . Post-installation configuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing or upgrading Integration Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UNIX prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 2 Installing Integration Engine Installation overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 BMC Atrium CMDB documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing or upgrading Integration Engine on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . Integration Engine components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Database adapter prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . The processing phase . . . . . . . . . . . . . . . . . . Contents 5 . . . . . . Removing Integration Engine from UNIX. . . 12 Chapter 1 Understanding Integration Engine 15 16 17 18 18 19 19 19 20 21 22 22 25 26 27 28 28 29 29 31 31 35 39 42 43 43 44 Overview . . . . . . . . . . . . . 9 Best Practice and New icons. . . . . . . . . . . . Getting the prerequisites. . . . . . . . . . . . . . . . . . . . 10 Integration Engine documents . . . . . . . . . . Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . Adapter Development Kit interface . . . . . . .Contents Preface 9 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Windows prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event Request interface . . Removing Integration Engine from Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing Integration Engine Online Help . . . Uninstalling Integration Engine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. 57 Row-level query syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Sample configuration file . . . . . . . . . . . . . . . . . . . . . . .Chapter 3 Defining rules and queries 45 Defining rules . . . . . . 86 Running the Integration Engine service on UNIX. . . . . . . . . . . . . . . . 69 Using the the adapter rule helper utilities on UNIX platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Target SQL command syntax (targetsql|<command>) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Using the DB2 Adapter Rule Helper utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Changing Integration Engine AR System password. . . . . . . . . . . . . . 70 Chapter 4 Activating event-driven data exchanges 73 Creating a request on the Application Pending form . 81 Activating an event-driven data exchange through workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Precedence syntax (<{rule}> <{rule}> <{rule}>) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Understanding the configuration file and its parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Examples of the event-driven request command syntax . 53 Target process command syntax (targetprocess|<command>) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Loading the adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Process command syntax (process|<command>) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Completion codes returned by eiexfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Using the XML Adapter Rule Helper utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Editing the configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Managing instances . . . . . . . . . . . . . . . . . . . . . . . . .dbg debug file . . . . 55 AR System query syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Creating a request using the eiexfer utility. . . . . . . . . . . . . . . . . . . . . . . . . .dbg debug file. . . 69 Using the File Adapter Rule Helper utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 SQL command syntax (sql|<command>) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 6 Administrator’s Guide . . . . . . . . . . . . . . . . . . . . . . . 54 If/then/else syntax (STMT|<statement>) . . . . . . . . . . . . . . . . . . . 69 Populating the rule control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Chapter 6 Logging and debugging 97 Log messages. . . . 102 Using an <exchange_name>. . . . . 83 Chapter 5 Running and configuring the Integration Engine service 85 Running the Integration Engine service on Windows . . . . . . . . 62 Using the SQL Adapter Rule Helper utility. . . . . . . . . . . . . . . . . . . 56 Data key syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Debug logging settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Defining queries . . . . . . . . . . . . . . . . . . . . . . . 89 Configuration file parameters . . . . . . . . . . . . . 60 Using the Oracle Adapter Rule Helper utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Debug messages . . . . . . . . . . . . . . . . . . . . . . . 102 Using the <instance name>_eiemain. . . . . . . . . . . . . 59 Using the adapter rule helper utilities. . . . . . . . . . . . . . . 46 Constant syntax (constant|<string>) . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Function syntax (function|<function(parameters)>) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

114 Using date functions in AR System Date/Time fields . . . . . . . . . . . . . . . . . 110 Troubleshooting data exchanges . . . . . . . . . . . . . . . . . . . . . . . . 111 Export exchange and mapping configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Handling data types . . . . . . . . . . . . . . 115 Stopping the AR System server accidentally when stopping the Integration Engine service on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Determining if a record has an out-of-range error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Adding missing items in the AR System field drop-down lists . . . . . . . . . . . . . . . . . . . 116 Index 119 Contents 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Using character string comparisons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Chapter 7 Troubleshooting Integration Engine 109 Running the Integration Engine service . . . . . . . . . . . . . 110 Estimating memory usage when running a data exchange . . . . .

8 Administrator’s Guide .

and BMC Remedy User applications. The administrator is the architect of AR System applications and oversees their integration with external applications. As an administrator. Preface 9 . configure. or maintain a custom-built or BMC Remedy application that they want to use with an external database. license.00 Workflow Objects for additional information. you must know how to use the AR System. The AR System administrator can designate another user to be the subadministrator. They must also be familiar with access principles and designing and modifying workflow. Integration Engine is used to transfer data between external databases and BMC Remedy Action Request System (AR System) applications or between external databases and the BMC Atrium Configuration Management Database (CMDB) product. Audience This document is intended for AR System administrators who install. Remedy Import. See the BMC Remedy User Online Help and the BMC Remedy Action Request System 7. including the BMC Remedy Administrator.1.Preface This document describes how to install. use. and use the BMC Atrium Integration Engine (Integration Engine) application. Subadministrators must be familiar with external applications and their database table structure.

1. Users and Product Administrators Help Everyone Everyone Users Print and PDF Print and PDF Print and PDF 10 Administrator’s Guide .00 Best Practice and New icons Documentation for Integration Engine contains two icons: Icon Description The New icon identifies features or products that are new or enhanced with version 7.1. The Best Practice icon highlights processes or approaches that BMC has identified as the most effective way to leverage certain features in the application.1.00 User’s Guide creating data exchanges and data mappings. and Engine 7.00 Release Notes resolved issues.1. and AR System.bmc. Integration Engine documents The following table shows the Integration Engine documentation. the Electronic Product Distribution (EPD) site at http://webapps. open issues. BMC Atrium Integration Combined index of all guides. Title BMC Atrium Integration Engine 7.BMC Atrium Integration Engine 7. Related documentation This section describes the related documentation for Integration Engine.bmc.00 Adapter Development Kit Developer’s Guide Description Audience Format Print and PDF Procedures describing how to build adapters that Developers can transfer information between an external data store and either AR System forms or BMC Atrium CMDB.00 Master Index BMC Atrium Integration Information about new features.1. BMC Atrium Integration Procedures and conceptual information about Engine 7. available by clicking Help in the product interface.1.00.com/support_home. The softcopy documentation is available in the Docs directory of the product DVD. Engine 7.00 Online Help exchanges and data mappings and to configure administrative options. BMC Atrium CMDB. BMC Atrium Integration Procedures describing how to create data Engine 7.1.com/epd and the Support site at http://www.

Related documentation BMC Atrium CMDB documents The following table shows BMC Atrium CMDB documentation.1.00 Classes Programmers HTML Administrators Mappings of common IT objects to the appropriate class in which to store them.1.1.00 Concepts and Best Practices Guide BMC Atrium CMDB 2. print and PDF BMC Atrium CMDB 2.bmc. reconciliation.1. whether part of the Common Data Model or an extension.00 Javadoc API Help variables that integrate with BMC Atrium CMDB Mapping Your Data to BMC Atrium CMDB 2. open issues.00 Common Data Model Diagram BMC Atrium CMDB 2. The softcopy documentation is available in the Docs directory of the product DVD.00 Data Model Help Document provides Hierarchical diagram of all classes in the Common Data Model (CDM) including unique attributes and applicable relationships Audience Administrators Format Print and PDF Information about CMDB concepts and best IT leaders and practices for planning your BMC Atrium CMDB administrators implementation Description and details of superclasses. using Administrators C and web services API functions and data and programmers structures.00 Release Notes Print and PDF Product Help Help for using and configuring BMC Atrium Users and CMDB.1.1. including permissions.00 Online Help BMC Atrium CMDB 2. Also includes information about further categorizing instances using key attributes.1. Title BMC Atrium CMDB 2. subclasses. but can be updated to include information about data model extensions you install.1. Administrators Print and PDF HTML BMC Atrium CMDB 2.com/support_home.00 Installation and Configuration Guide Information about creating API programs. and federation Administrators Print and PDF Print and PDF BMC Atrium CMDB Information about Java classes. the Electronic Product Distribution (EPD) site at http://webapps.com/epd and the Support site at http://www.00 Master Index BMC Atrium CMDB 2. methods.00 Developer’s Reference Guide BMC Atrium CMDB 2.1.1. and a list of error messages Information about installing and configuring BMC Atrium CMDB. and relationship classes for each class. Contains only information about the Common Data Model at first. and resolved issues Everyone Print and PDF Preface 11 . Combined index of all guides Everyone Spreadsheet. available by clicking Help in the product administrators interface Information about new features. class definitions.bmc. and 2. attributes.

PDF and Print PDF and Print PDF and Print Information about the mid tier. and BMC Support personnel Print and PDF BMC Atrium CMDB 2. Audience Format Administrators.1.1.1. including applications.com/support_home. OLE.00: Getting Started BMC Remedy Action Request System 7. including API. including Administrators BMC Remedy Action Request mid tier installation and configuration.com/epd and the Support site at http://www. searching for objects.00: Configuring Administrators PDF and Print PDF and Print PDF and Print Topics that are usually only learned when Everyone first starting to use the system.00: Integrating with Plug-ins and Third-Party Products Information about integrating AR System Administrators with external systems using plug-ins and and Developers other products.1.1. filter. Developers Information about configuring AR System Administrators servers and clients. and console error messages and their solutions. includes information about other AR System products as well as a comprehensive glossary for the entire AR System documentation set.00: Installing BMC Remedy Action Request System 7.BMC Atrium Integration Engine 7. Tier BMC Remedy Action Request System 7.00 User’s Guide Information about using BMC Atrium CMDB. and archiving data. Developers Overview of all the workflow information. Users including searching for and comparing CIs and relationships.bmc. Title BMC Remedy Action Request System 7. Print and PDF programmers. and ARDBC. Information about the components necessary to build applications in AR System. relating CIs. and System 7.1. The softcopy documentation is available in the Docs directory of the product DVD.1.00: Workflow Objects BMC Remedy Action Request System 7.1.00 Title BMC Atrium CMDB 2. and views.1. the Electronic Product Distribution (EPD) site at http://webapps. fields. including LDAP.00: Installing and Administering BMC Remedy Mid web server configuration.1.1. including logging in. Procedures for installing AR System Audience Everyone Format PDF and Print BMC Remedy Action Request System 7. PDF and Print 12 Administrator’s Guide . viewing history. importing and exporting data. localizing. forms.00: Concepts Description Overview of AR System architecture and features with in-depth examples. and launching federated data AR System documents The following table shows BMC Remedy AR System documentation.00: Form and Application Objects BMC Remedy Action Request System 7.bmc. and so on.00 Troubleshooting Guide Document provides Information about resolving issues with BMC Atrium CMDB components.

Everyone compatibility lists. List and expanded descriptions of AR System error messages.00 Database Reference related to how AR System interacts with specific databases.1. configuring.00: C API Reference BMC Remedy Action Request System 7.00: Release Notes Administrators PDF and and Programmers Print Administrators PDF and and Programmers Print PDF and Print Procedures for installing. C API function calls.1.1.00: Error Messages BMC Remedy Action Request System 7.1.1.1.00: C API Quick Reference BMC Remedy Action Request System 7. PDF and Print PDF and Print Administrators PDF and and Programmers Print BMC Remedy Action Request System 7.1. Quick reference to C API function calls. includes an overview of the data dictionary tables. international issues.00: Administering BMC Remedy Email Engine BMC Remedy Action Request System 7. BMC Remedy Action Request System 7. Flashboards administration and procedures for creating and modifying flashboards and flashboards components to display and monitor AR System information. and OLE support. all online documentation is available in Adobe Acrobat (PDF) format on the BMC Remedy Electronic Software Distribution and on the BMC Remedy Customer Support website.1. and Administrators using the BMC Remedy Email Engine. and open and fixed issues.00: Administering BMC Remedy DSO BMC Remedy Action Request System 7. Unless otherwise noted. Information about AR System data structures.00: Administering BMC Remedy Flashboards Server administration and procedures for Administrators implementing a distributed AR System server environment with the BMC Remedy Distributed Server Option (DSO).00: Optimizing and Troubleshooting Description Audience Format PDF and Print Server administration topics and technical Administrators essays related to monitoring and maintaining AR System for the purpose of optimizing performance and troubleshooting problems.Related documentation Title BMC Remedy Action Request System 7.00: Master Index BMC Remedy Action Request System 7. BMC Remedy Action Request Database administration topics and rules Administrators System 7. Preface 13 . Administrators PDF and and Programmers Print Everyone PDF and Print PDF and Print Information about new features list.1.1. Combined index of all books.

1.00 14 Administrator’s Guide .BMC Atrium Integration Engine 7.

You can use the included adapters for Microsoft SQL Server. You can also use the Integration Engine Adapter Development Kit to build your own adapters to meet your organization’s specific needs. The following topics are provided: Overview (page 16) Integration Engine components (page 17) The data transfer process (page 19) Performance considerations (page 22) Getting started (page 22) Chapter 1 Understanding Integration Engine 15 . XML.Chapter 1 Understanding Integration Engine The Integration Engine application allows you to transfer data between an external data store and AR System forms or BMC Atrium CMDB classes. and flat files such as comma-separated value (CSV) files. Oracle. IBM DB2 UDB.

Synchronize IT data from a discovery application with BMC Atrium CMDB. and data synchronization. For example. or from an AR System application or BMC Atrium CMDB class to an external data store. Supply Chain Management. where it can be reconciled with data from other sources to your production dataset.00 Overview With Integration Engine. depending upon how you have configured your data exchange: Reads records Creates new records Updates records Deletes records 16 Administrator’s Guide . and other enterprise applications. you can use Integration Engine to: Synchronize data from your Human Resources applications with employee data in your BMC Remedy Service Desk application.BMC Atrium Integration Engine 7. You can also use Integration Engine for initial data load. Integration Engine identifies the records to be transferred and performs some or all of the following tasks. Figure 1-1 shows how you can transfer data in either direction: from an external data store to an AR System application or BMC Atrium CMDB class. you can do scheduled bulk data transfers and eventbased integrations initiated by either side. You can build links between BMC Remedy IT Service Management applications and Enterprise Resource Planning (ERP). incremental data transfers. Customer Relationship Management. Figure 1-1: Overview of the data transfer process AR System database External data store Data object BMC Atrium Integration Engine AR System form CMDB class During the data transfer.1. Synchronize asset data tracked in BMC Remedy Asset Management applications with corporate asset data stored in ERP applications.

Figure 1-2: Integration Engine components AR System database or BMC Atrium CMDB Data Exchange application Application Pending form AR System APIs CMDB APIs BMC Atrium Integration Engine Integration Engine service Event Request interface (eiexfer) Adapter Development Kit interface DB2 adapter Oracle adapter SQL adapter XML adapter Flat File adapter ? DB2 database Oracle SQL Server database database XML file Flat file ? ? Other Other Other data store data store data store Out-of-box adapters Custom adapters (not included) Chapter 1 Understanding Integration Engine 17 .Integration Engine components Integration Engine components Integration Engine has four main components: Data Exchange application (page 18) Integration Engine service (page 18) Event Request interface (page 19) Adapter Development Kit interface (page 19) Figure 1-2 shows how these components work with other Integration Engine components and related objects.

how to connect to the external data store. updated.00 Data Exchange application The Data Exchange application is a group of AR System forms that is available from your AR System home page as the AIE Console link. which adapter is used. A data exchange also specifies the conditions under which data is created. and the method used to execute the exchange. or deleted. A data mapping specifies the fields or attributes to be transferred from the source and maps them to fields or attributes in the target. and defines the primary key that identifies a row of data on either side. that provides access to external data and responds to calls from Integration Engine during a data exchange. A data mapping defines data to be transferred. updated. and updated in the source by including queries for each of these things. 18 Administrator’s Guide . and a single execution of a data exchange is called a data transfer. Integration Engine service The Integration Engine service obtains the defined data exchange from the Data Exchange application and completes the transfer of data by communicating with the adapter specified in the data exchange definition. Populate Integration Engine menus with the names of tables and columns from external data stores to simplify the process of creating data mappings. Specify the administrator user and online help path for the application.BMC Atrium Integration Engine 7. either provided by BMC or custom built. You associate a data exchange with one or more data mappings to specify which data is transferred. The Data Exchange application also lets you perform the following configuration tasks: Define external data store connection parameters for multiple data exchanges simultaneously. Adapters are software. You use a data mapping by associating it with a data exchange. Display version numbers for Integration Engine and related products. and specifies any fields or attributes in the source that should be updated when a record in the target is created. and you use it to work with these integration objects: A data exchange is the object that you execute to move data with Integration Engine. A data exchange specifies whether the external data store is the source or the target for a data transfer. and deleted. It specifies the external file or database table and the AR System form or BMC Atrium CMDB class between which data is transferred. A data mapping can limit the rows of data to be transferred from the source. View the Integration Engine instances you defined at installation time and edit some settings for them. updated in the target.1.

or by invoking the eiexfer utility. the Integration Engine service loads the adapter that is associated with that data exchange. You can design the adapter to obtain a license that is specifically issued to it or get a license from a pool of available adapter licenses issued to Integration Engine. The Adapter Development Kit interface defines a set of C++ objects that are used by the Integration Engine service to manage data exchanges that use these adapters. The Integration Engine service runs as a client to the AR System server using the AR System application programming interface (API). When Integration Engine detects a data exchange.1. For information about the AR System API. It does not need to reside on the same computer as the AR System server or the external data stores. a log message is written to the EIE:Log form and the Integration Engine log file indicating that the adapter is not licensed.00: C API Reference. If the adapter is not licensed. The data transfer process When you start Integration Engine. Event Request interface You can execute a data exchange on an event-driven basis using the Event Request interface. but can be on any computer that is network-connected to both of these.cfg file. You create an event-driven request by directly creating an Application Pending entry. Optionally. the Integration Engine service can handle individual event requests immediately if you enter them through the eiexfer utility. Adapter Development Kit interface Integration Engine also has a special interface that allows it to interact with adapters. The Adapter Development Kit interface is an interface built into Integration Engine that allows Integration Engine to communicate with non-BMC adapters. The adapter needs to be licensed before you can run it. After the appropriate adapter is located and its license is verified. The Integration Engine service processes requests at a scheduled interval configured in the eie. If the license comes from a pool of Integration Engine licenses. Each event-driven request is created as an entry in the Application Pending form on the AR Server where the Data Exchange application is installed. it locates data exchanges by reading entries in the Data Exchange application. the adapter is loaded. see BMC Remedy Action Request System 7. you can implement further license checking in the adapter to prevent unauthorized use of the adapter. Chapter 1 Understanding Integration Engine 19 .The data transfer process The Integration Engine service can connect to any Windows or UNIX AR System server. regardless of which method was used to create the requests. by using AR System workflow to create the entry.

e Starts a thread. During validation. followed by the processing phase where data is transferred. d Disconnects from data sources. the Integration Engine service starts a thread to manage the data exchange process. At the end of the initialization phase. The Integration Engine service connects to both the source and target data stores. At the same time.00 After this point. During validation. the adapter indicates if any errors or warnings were detected and if the rules are ready to be used in a data exchange. The C++ objects contain the data exchange definition. Data is not actually exchanged until the processing phase. which is described in the next section.BMC Atrium Integration Engine 7. b Connects to data stores to validate rules. the Integration Engine service indicates if any errors or warnings were detected and if the rules are ready to be used in a data exchange. and all adapter-defined configuration parameters and rules. In the initialization phase. The Integration Engine service validates rules owned by Integration Engine. 20 Administrator’s Guide . After the rules are validated. c Validates data exchange rules. The Integration Engine service loads all the rules defined in the Data Exchange application and prepares the C++ objects defined by the Adapter Developer Kit interface. The initialization phase The initialization phase prepares a data exchange to run. but a connection to both data stores is necessary to validate rules. the Integration Engine service disconnects from both data sources. the adapter is called to validate adapter-owned rules. the data mapping rules. there are two phases to a data transfer: the initialization phase where a data exchange is prepared to run. The Integration Engine service does not transfer data at this point.1. the Integration Engine service: a Loads data exchange rules. An AR System form or BMC Atrium CMDB class can serve as either the source or the target.

The data transfer process

The processing phase
In the processing phase, the transfer of data takes place. This phase begins when the data exchange is executed, which can be scheduled or event driven. During the processing phase, the Integration Engine service: Refreshes the data exchange. Before data is exchanged, the Integration Engine service checks the Data Exchange application to determine if any changes were made to the data exchange definition. If changes were made, the Integration Engine service updates the loaded data exchange with the new definition. Starts a separate thread for each data exchange. Each data exchange connects to data stores. The Integration Engine service connects to both the source and target data stores. The Integration Engine service communicates through the AR System API or BMC Atrium CMDB API to pull data out of and push data into those data stores, and through the Adapter Developer Kit interface to pull data out of and push data into the external data store. Locates data to be exchanged. The Integration Engine service obtains a list of keys from AR System or BMC Atrium CMDB and asks the adapter to create a list of keys. The Integration Engine service converts the keys to a common data type (if necessary) and then sorts the keys to make sure that they are in the same order so the key lists can be compared. Transfers data. The Integration Engine service compares the keys and determines from the data exchange definition how new and existing records should be treated. The Integration Engine service decides on a key-by-key basis whether to create, update, or delete records. For each key, adapters can be called to read, write, update, or delete a record. Disconnects from data stores. After all keys are processed, the data transfer is considered complete. The Integration Engine service closes the connection to AR System or BMC Atrium CMDB and asks the adapter to close the connection to the external data store.

NOTE
The thread remains active, as does the adapter, unless the data exchange is deactivated in the Data Exchange application or the Integration Engine service is asked to terminate. In either of those events, the adapter .dll is released and the thread terminates.

Chapter 1

Understanding Integration Engine

21

BMC Atrium Integration Engine 7.1.00

Performance considerations
Performance considerations for Integration Engine are difficult to quantify because performance is affected by your network, AR System, the AR System server database, and the external data store load. It is difficult to predict the effect of a specific change on Integration Engine performance, but configuration considerations can influence it. While it is easy to add field mappings or extra rules for each field, remember that each item you add is compared against every record in your database. Seemingly minor additions could have major effects if many records are in your database. For example, if you have 1200 records in your database and the change you make adds an additional half-second to the run time for each record, the data transfer might take an additional 10 minutes to run.

Getting started
If you are new to BMC Atrium Integration Engine, you might be wondering where to start to get your first successful data transfer underway. After installing, here are the high-level steps you need to take. See the recommended area of the Integration Engine documentation for specific instructions on each.

To get started using Integration Engine
Step 1 Populate the database field menus for your external data stores using the rule

helpers in the Database Field Menus Console.

This greatly simplifies the process of creating data mappings by allowing you to choose field names from a menu instead of manually typing them. For instructions, see the section “Using the adapter rule helper utilities” in the Administrator’s Guide.
Step 2 Create a data mapping to specify which data should be transferred and where it

should go.

For instructions, see the appropriate chapter of the User’s Guide: Chapter 3, “Creating a data mapping for BMC Atrium CMDB CI classes,” Chapter 4, “Creating a data mapping for BMC Atrium CMDB relationship classes,” or Chapter 5, “Creating a data mapping for AR System forms.”
Step 3 Create a data exchange to control the execution, direction, and other characteristics

of your data transfers.

For instructions, see Chapter 2, “Creating a data exchange,” in the User’s Guide. These three steps are sufficient to enable a simple data transfer. If you have a more complex situation, you might need to perform more configuration than this.

22

Administrator’s Guide

Getting started

Chapter 1

Understanding Integration Engine

23

00 24 Administrator’s Guide .BMC Atrium Integration Engine 7.1.

The following topics are provided: Installation overview (page 26) Getting the prerequisites (page 27) Gathering information (page 29) Installing or upgrading Integration Engine (page 31) Post-installation configuration tasks (page 42) Uninstalling Integration Engine (page 43) Chapter 2 Installing Integration Engine 25 .Chapter 2 Installing Integration Engine This section describes how to install Integration Engine.

com/epd or from the product DVD. Click the product documentation link and unzip the files. NOTE All products can now be downloaded from the Electronic Product Distribution (EPD) page at http://webapps. SQL Server Adapter. IMPORTANT The Integration Engine installer installs the Integration Engine components on the machine on which you run the installer. : 26 Administrator’s Guide . and XML Adapter.1. the Event Request interface.BMC Atrium Integration Engine 7. see “Post-installation configuration tasks” on page 42. For more information. the Data Exchange application. This documentation includes all Integration Engine manuals and the Release Notes in PDF format.bmc. After the Integration Engine components and adapter products are installed. The product documentation is no longer installed as a part of the Integration Engine installation. you can move the Event Request interface as needed on your network. Adapters This can include the DB2 Adapter. you can manually copy the documentation files to your local file system. However. The unzip process creates two folders: Docs and Help. After you unzip the documentation files. File Adapter. and optionally the Integration Engine development kit (also called the Integration Engine Adapter Developer’s Kit (ADK)). you install: Integration Engine This includes the Integration Engine service. if you enter a remote AR System server during installation. the Data Exchange application is installed on the remote AR System server.00 Installation overview When you run the Integration Engine installer. Oracle Adapter.

Oracle.19097_63537447. 2. Sets 1. the Integration Engine and the adapters are installed on one machine (see Set 2). The third-party database (DB2. make sure you have the following Windows or UNIX requirements.html Chapter 2 Installing Integration Engine 27 . For the latest compatibility information. see the Product Availability and Compatibility section of the BMC support website: http://www. Getting the prerequisites Before you begin installation. The AR System and the CMDB server are network-connected to the Integration Engine machine (see Set 1).com/info_center_support/overview 0.bmc.3252. Figure 2-1: Sample installation of Integration Engine integration components AR System and BMC Atrium CMDB Atrium Integration Engine DB2 Adapter DB2 Database File Adapter XML Adapter Oracle Adapter Oracle File Source XML Source SQL Adapter SQL Event Request Interface Set 1 Set 2 Set 3 In this example. and 3 can each reside on the same host or on three different hosts.00. or SQL) and the Event Request interface are installed on another networkconnected machine (see Set 3).Getting the prerequisites Figure 2-1 shows a sample installation of the Integration Engine components on a network.

0.1. You must install the Data Exchange application on a server running AR System: 7. but Check you still need root privileges available for some activities. 7.00 installed.0. 7.1.0.1.0. To exchange data with CMDB.00 Windows prerequisites Review the prerequisites in Table 2-1 for Windows. To exchange data with CMDB.1 or v2.0. 28 Administrator’s Guide . Table 2-2: UNIX prerequisites Integration Engine component All components Requirements UNIX administrator privileges (root) Note: Installation is possible by a non-root user. Note: The user must have AR System administrator Check privileges.0.1.BMC Atrium Integration Engine 7. you must have CMDB v2. or 7. Data Exchange application You must install the Data Exchange application on a server running AR System: 7.00 On a supported platform Note: The Integration Engine installer can install the Data Exchange application on a remote machine. UNIX prerequisites Review the prerequisites in Table 2-2 for UNIX.01.00 On a supported platform Note: The Integration Engine installer can install the Data Exchange application on a remote machine.1 or v2. you must have CMDB v2.1. Table 2-1: Windows prerequisites Integration Engine component All components Data Exchange application Requirements Windows administrator privileges Valid AR System server user ID and password. or 7.00 installed.01.

Gathering information Database adapter prerequisites Review the prerequisites in Table 2-3 for database adapters. The client must be configured to point to your Oracle database. The client must be configured to point to your SQL Server database. go to <ar_install_dir>\CONF\ar. Table 2-4: Integration Engine installer worksheet Entry or selection AR server name Description Enter your information Action Request System server information window Name of your AR System server. To locate the port number on UNIX. SQL Server 2000 or 2005 (Standard or Enterprise) client software installed on the computer where the SQL Server Adapter is installed.2 client software installed on the computer where the DB2 adapter is installed. The client must be configured to point to your DB2 database. Table 2-3: Database adapter prerequisites Integration Engine component DB2 adapter Requirements Check DB2 8. AR server Administrator User name of the AR System administrator.” If your AR System server uses portmapper.” To find the port number on Windows. Chapter 2 Installing Integration Engine 29 . go to <ar_install_dir>/ conf/ar.cfg and find “TCD-Specific-Port. It is organized by dialog boxes. Oracle adapter SQL Server adapter Gathering information The worksheet in Table 2-4 includes a list of selections for which you are prompted during installation. Oracle 9i (Release 2) or Oracle 10g (Release 2) client software installed on the computer where the Oracle adapter is installed.conf and find the key name “TCD-Specific Port. AR server port Number of the port you want to number use. Complete the worksheet before starting the installation. use the default value. which are placed in the order in which they are displayed during the installation.

The folder where the product is installed. SQL server password. Username Password DB2 Instance SQL Server Database Information window Note: This window and corresponding fields only appear if you selected the Custom mode of installation and SQL adapter from the custom installation window. DB2 database password.1. Oracle database password. SQL server computer name. Database Alias DB2 database alias name. Oracle database user name. Option to select whether you want to connect using Windows authentication or SQL Server Authentication using a Username and Password. DB2 instance. Enter your information DB2 Database Information window Note: This window and corresponding fields only appear if you select the Custom mode of installation and the DB2 adapter from the custom installation window.BMC Atrium Integration Engine 7. SQL Server Name Database Name Connect using Username Password Oracle Database Information window Note: This window and corresponding fields only appear if you selected the Custom mode of installation and Oracle adapter from the custom installation window.00 Entry or selection AR server admin password Description The password for the AR System administrator. The default password for administrator Demo is an empty string. Database system identifier (SID). Directory where you want the Oracle database to be installed. DB2 database user name. SQL database name. The default folders are: Windows: C:\Program Files\BMC Software\BMC Atrium Integration Engine\<server name>-<port number> UNIX: /usr/bmc/apps/aie/ <server name>-<port number>/ Oracle Home Directory Database SID Username Password Destination folder Database Alias Databse alias. SQL server user name. Choose Destination Location window 30 Administrator’s Guide .

Installing or upgrading Integration Engine on Windows You can install BMC Atrium Integration Engine or upgrade to BMC Atrium Integration Engine from BMC Remedy Enterprise Integration Engine. The Action Request System server information window appears. For details. 3 Select “I accept the terms of the license agreement. 2 Click Next. To install or upgrade Integration Engine on Windows 1 From the folder where you unzipped the product download or from the root folder of the product DVD. This can be a different machine from the Integration Engine service. Figure 2-2: Action Request System server information window NOTE The Data Exchange application is installed on the machine on which the AR System server runs. The Welcome window appears.exe. It also contains instructions for installing the Integration Engine Online Help. The License Agreement window appears. double-click aieinstall_windows. see “Getting the prerequisites” on page 27.” and then click Next.Installing or upgrading Integration Engine Installing or upgrading Integration Engine This section contains instructions for installing or upgrading Integration Engine on Windows and UNIX. Chapter 2 Installing Integration Engine 31 .

BMC Atrium Integration Engine 7.1.00 4 Do the following actions:

Accept the default value in the ARServer Name field, or type the name of your AR System server. Accept the default value in the ARServer Port Number field, or type the number of the port you want to use. Accept the default value in the ARServer Administrator field, or type the name of an AR System administrator user. Type the user’s password in the ARServer Admin Password field.
5 Click Next.

NOTE
If you are upgrading to BMC Atrium Integration Engine from BMC Remedy Enterprise Integration Engine, a confirmation dialog box appears asking you if you are sure you want to upgrade. Click Yes. The Setup Type window appears.
6 Do one of the following actions: Select Express To Install BMC Atrium Integration Engine with all adapters and the Adapter Development Kit. Only one instance of the Integration Engine service is installed. Choose which components to install and how many instances of the Integration Engine service to install. Then The Choose Destination Location window appears. Click Next, and skip to step 19 on page 35. The Select Components window appears. Click Next, and continue with step 7.

Custom

7 Select the components you want to install. The following components are available

for installation:

Adapter Development Kit DB2 Adapter File Adapter Microsoft SQL Server Adapter Oracle Adapter XML Adapter

IMPORTANT
If you are upgrading existing ADK, Integration Engine, Remedy Link For Oracle, or Remedy Link For SQL installations, the ADK, File Adapter, Oracle adapter, and SQL adapters will be selected for installation by default. These cannot be deselected.

32

Administrator’s Guide

Installing or upgrading Integration Engine

If you selected the DB2 Adapter component to install, the DB2 Database Information window appears.
Figure 2-3: DB2 Database Information window

8 Enter your DB2 database alias, database instance, username, and password in the

appropriate fields, and click Next.

If you selected the SQL Server Adapter component to install, the Microsoft SQL Server Database Information window appears.
Figure 2-4: Microsoft SQL Server Database Information window

9 Enter your SQL Server computer name in the SQL Server Name field and your

database name in the Database Name field.

10 Select whether to connect to the database using Windows Authentication or SQL

Server Authentication.

11 If you selected SQL Server Authentication, enter a valid SQL Server user name and

password in the Username and Password fields.

Chapter 2

Installing Integration Engine

33

BMC Atrium Integration Engine 7.1.00 12 Click Next.

If you selected the Oracle Adapter component to install, the Oracle Database Information window appears.
Figure 2-5: Oracle Database Information window

13 In the Oracle Home Directory field, enter the directory where Oracle database is

installed.

14 Enter the database SID and alias. 15 Enter a valid Oracle user name and password in the Username and Password

fields.

16 Click Next.

The Instance Information window appears.
Figure 2-6: Instance Information window

34

Administrator’s Guide

a message appears telling you that installation of BMC Atrium Integration Engine is now complete. type the number of instances of the Integration Engine service you want to install. select whether you want all instances to start automatically or you want them all to start manually.Installing or upgrading Integration Engine 17 In the Number of Instances field. The Choose Destination Location window appears.sh 3 Press Enter. The Integration Engine installation process begins.tar. which can take several minutes to complete. NOTE If you are upgrading your existing installation. 18 In the Instance Startup Mode field. verify that you have enough free space on the drive which you choose for installation.gz. 20 In the Space Required and Space Available fields. A message appears telling you that a record of the installation will be preserved in the following directory: /usr/tmp/aie_install. . by that user ID only. A message appears asking if you wish to install BMC Atrium Integration Engine.tar. Chapter 2 Installing Integration Engine 35 . locate and extract aieinstall_<platform>. you can continue the installation without adding any instances by typing 0 in the Number Of Instances field. and press Enter. 22 To view the installation log. Installing or upgrading Integration Engine on UNIX To install or upgrade Integration Engine on UNIX 1 From the folder where you unzipped the product download or from the root folder of the product DVD./aie_install. The Start Copying Files window appears.log. The installer copies files and loads workflow. 2 Type the following command: . and then click Next. and then click Next. IMPORTANT If you are performing the installation with a non-root user ID. or click Browse to select another location. select the View log file checkbox and then click Finish to complete your installation. 21 Click Next. Once the installation is complete.gz. 19 Accept the default installation location. you must extract the installer. 4 Type Y.

a confirmation message appears asking you to upgrade the existing installation. or type the name of the new directory path. 13 Press Enter. I agree to the terms of this agreement. I disagree to the terms of the agreement.1. 36 Administrator’s Guide . At any time while reading the agreement. The default administrator login for a new installation is the “Demo” user name and no password. type 1 to accept the agreement. NOTE If you are upgrading to BMC Atrium Integration Engine from BMC Remedy Enterprise Integration Engine. press Enter to accept the default directory path. or type the name of your AR System server. 9 At the installation directory prompt. and press Enter to accept the agreement. At the end of the agreement. 12 At the password for the AR System Administrator prompt. 3) I would like to read the agreement again. or re-read the agreement. the correct port number. you can press q to accept. press Enter to accept the default port number. and press Enter.00 5 Read the End User License and Maintenance Agreement. A message appears asking you to specify the directory where the Action Request System is currently installed. 7 At the server name prompt. Press Enter to accept the default (Y). press Enter to accept the default server. and press Enter. and press Enter. 10 At the TCP/IP port prompt. reject. or type the ID. A message appears informing you the AR System server was found. press Enter to accept the default. or type A message appears notifying you that to load an application into the AR System. and press Enter. you must have a valid AR System Administrator ID and password. press Enter to accept the default ID. A confirmation message apppears: You have chosen AR System server ‘<servername>’ Is this correct? [y] 8 Press Enter to accept the default. 6 At the prompt.BMC Atrium Integration Engine 7. 11 At the AR System Administrator ID prompt. or type a password. and press Enter. TIP Press Enter to scroll through the entire agreement. the following message appears: Please select one of the following. 2) No. 1) Yes. and press Enter.

do one of the following actions: Select Express— (Press Enter to accept this default). the following components are available for installation: Adapter Development Kit DB2 Adapter File Adapter Oracle Adapter XML Adapter If you are upgrading an existing installation of ADK. If you choose a custom installation. The following prompts appear in this order: Do you want to install Adapter Development Kit? [y] Do you want to install DB2 Adapter? [y] Do you want to install File Adapter? [y] Do you want to install Oracle Adapter? [y] Do you want to install XML Adapter? [y] After selecting the components you want to install. Recommended for advanced users. a prompt appears asking you to add more instances. Integration Engine. press Enter to accept the default (Y) and NOTE install that component. 2) Custom: Select the components that you want to install.Installing or upgrading Integration Engine 14 The following message appears allowing you to run the installation in two modes: Installation can be run in the following two modes: 1) Express: All the components (ADK. Continue with step 15 on page 37. File adapter. Only one instance of the Integration Engine service is installed. or type N. Chapter 2 Installing Integration Engine 37 . At the prompt. and press Enter). XML adapter) will be installed iwth default settings. Then Skip to step 20 on page 39. Custom— (Type 2. DB2 adapter. To Install BMC Atrium Integration Engine with all adapters and the Adapter Development Kit. 15 After each of the following prompts. They will be upgraded by default. or Remedy Link For Oracle. these components will not be available for component selection. and press Enter to skip installation of that component and move to the next option. Oracle adapter. Choose which components to install and how many instances of the Integration Engine service to install.

and press Enter. or type Y to add more instances. Complete the following actions: press Enter. 17 Type the number of instances you want to add. and press Enter. the installer shows the default values in square brackets. c Press Enter. and b Type the DB2 login name. NOTE If you are installing Integration Engine which points to the AR server that already has Integration Engine forms (possibly imported by another installation from another Integration Engine host). depending on which components you chose to install. and press Enter. and press Enter. After you complete these steps.00 16 Press Enter to accept the default [n]. and press Enter. a prompt appears. You can either enter new values. retype the Oracle login password. type the installation path where the DB2 is installed. and press Enter. [system] for Oracle User. c Press Enter. a At the Oracle database System ID prompt. type the DB2 login password. then a message appears asking you to please enter the number of instances you want to add. and press Enter. which is actually read from the existing forms. or you can accept the defaults. 38 Administrator’s Guide . 19 If you selected the Oracle Adapter component to install. If you type Y. asking you if this is correct. type the DB2 database instance name. asking you for a valid Oracle login name. For example. IMPORTANT Steps 18 and 19 will only appear. A confirmation prompt appears. skip to step 20 on page 39. type the Oracle system ID. a prompt appears. and press b Type the Oracle login name.1. A confirmation prompt appears. e At the verification prompt. asking you if this is correct. f At the DB2 alias prompt. d At the password prompt. g At the DB2 installation path prompt. and press Enter. a At the DB2 instance name prompt. and press Enter. asking you for a valid DB2 login name. type the DB2 database alias name. retype the DB2 login password. 18 If you selected the DB2 Adapter component to install.BMC Atrium Integration Engine 7. Complete the following actions: Enter. in steps 18 and 19. d Af the verification prompt.

f At the Oracle installation path prompt. The message also refers you to the installation and workflow import logs.exe. run the Help installer on the web server where Help is to be installed. To install Help for the Integration Engine on Windows 1 Make sure that: Integration Engine is installed The AR System server where the Integration Engine is installed is running The web server for Help is running 2 Navigate to the AIEHelp folder of your installation DVD or download. a message appears telling you that installation of BMC Atrium Integration Engine is now complete. To install Help files on multiple systems. It does not require the BMC Remedy Mid Tier. Installing Integration Engine Online Help The Help system for Integration Engine is installed separately from the application itself. which can take several minutes to complete. then double- click setup. Chapter 2 Installing Integration Engine 39 . Press Enter to accept the default directory. 20 After you complete the steps for the components you want to install. If you want Help to reside on a different machine.Installing or upgrading Integration Engine e At the Oracle database alias prompt. type the Oracle database alias name. type the installation path where the Oracle client is installed. NOTE IMPORTANT You can install Help files on either Windows or UNIX systems. You can install Online Help on the machine where you have Mid Tier and use its web server. Help is installed on a web server and launched with URLs sent from Integration Engine. a prompt appears asking you for the directory to install BMC Atrium Integration Engine. run the installer locally on each individual system. and press Enter. The Welcome window appears. or type the directory. Once the installation is complete. and press Enter. You must perform the procedure in this section to install the Online Help. The installer copies files and loads workflow. This web server does not have to be installed on the same machine as Integration Engine. and press Enter.

00 3 Click Next. The Enter Required Information For Atrium Integration Engine Online Help window appears. If you access the server on a particular port.BMC Atrium Integration Engine 7. enter that number in the Port Number field. 40 Administrator’s Guide . Figure 2-7: Enter Required Information For Atrium Integration Engine Online Help window 4 Enter the login and server information for the AR System server from which you want to install Help.1. and then click I Agree to accept the license agreement on the next window. You need the user name and password for an AR System administrator and the name of an AR System server.

Figure 2-9: Choose Destination Location window Chapter 2 Installing Integration Engine 41 . The Choose Destination Location window appears. Figure 2-8: Atrium Integration Engine Online Help window 5 Enter the host name and port number of the web server to deliver the requested Help files to users. and then click Next.Installing or upgrading Integration Engine The Atrium Integration Engine Online Help window appears.

00 6 Accept the default installation folder or browse and choose another folder.00 User’s Guide. Post-installation configuration tasks After installing Integration Engine and the optional components. These files are listed in Table 2-5.so. 7 Review your settings. you should complete the following post-installation configuration tasks: Configure the Data Exchange application by creating data exchanges and data mappings to transfer your data. Configure the Event Request interface if you want to use it on a remote machine. then click Next. see the BMC Atrium Integration Engine 7.32 <aie_install_dir>/service/bin/libicuucbmc. To configure the Event Request interface on a remote machine Copy the platform-appropriate eiexfer to any remote application host that uses the Event Request interface.dll <aie_install_dir>/service/bin/arutl70. Table 2-5: Platform directory files for Event Request Platform Windows Directory <aie_install_dir>/service/bin/eiexfer. The installer copies necessary files to the installation folder.1.so.BMC Atrium Integration Engine 7. click Back and modify them.dll <aie_install_dir>/service/bin/arrpc70. The Start Copying Files window appears.so.dll <aie_install_dir>/service/bin/icudt32. For more information. 8 Select View installation log file if you want to examine the log after installation.32 UNIX 42 Administrator’s Guide . and then the InstallShield Wizard Complete window appears.exe <aie_install_dir>/service/bin/arapi70.dll <aie_install_dir>/service/bin/eiexfer <aie_install_dir>/service/bin/libicudatabmc.32 <aie_install_dir>/service/bin/libicui18nbmc.dll <aie_install_dir>/service/bin/icuin32. and click Next if they are correct.dll <aie_install_dir>/service/bin/icuuc32. Otherwise. and then click Finish to exit.1.

you might lose all data that is part of the Data Exchange application. IMPORTANT If you have two instances of Integration Engine that use the same AR System server. 5 Click Yes. 4 Click Remove. WARNING By uninstalling Integration Engine. 2 In the Control Panel dialog box. Removing Integration Engine from Windows To remove Integration Engine from Windows 1 Choose Start > Settings > Control Panel on the Windows desktop. <ARServerName> as ARS Server may become invalid if you uninstall the Data Exchange Application. double-click Add/Remove Programs. 3 In the Add/Remove Programs dialog box. select BMC Atrium Integration Engine [<server name>(<port number>)]. Make sure that you back up any forms and data you might need. you will receive a message stating "any other AIE installation using may become invalid." If you continue with the uninstallation any other instances Chapter 2 Installing Integration Engine 43 . A confirmation dialog box appears.Uninstalling Integration Engine Uninstalling Integration Engine You might want to remove Integration Engine to reinstall it or to move it to another machine.

When the uninstall process is complete.00 The Action Request System server information window appears. 3 Delete all menus with the prefix EIE. 7 In the ARServer Admin Password field. 8 Click Next. 9 Click Yes. A dialog box appears asking if you want to uninstall the Data Exchange application. The uninstall process begins. Removing Integration Engine from UNIX To remove Integration Engine from UNIX 1 Start BMC Remedy Administrator. or type the name of the AR System server administrator.reg. 2 Delete all forms with the prefix EIE. Figure 2-10: Action Request System server information window 6 Accept the default value in the ARServer Administrator field.BMC Atrium Integration Engine 7. the Uninstallation completed window appears.1. 44 Administrator’s Guide . 4 Delete all the files and folders in the Integration Engine installation directory. 10 Click Finish. 5 Remove the eie.reg registry file in /etc/eie. type the AR administration password.

you use rules to map AR System fields or BMC Atrium CMDB classes to an external data store. You use queries to limit the data exchange to data that meets certain criteria. The following topics are provided: Defining rules (page 46) Defining queries (page 55) Using the adapter rule helper utilities (page 59) Populating the rule control (page 70) Chapter 3 Defining rules and queries 45 .Chapter 3 Defining rules and queries In Integration Engine. You can also make defining a data mapping more convenient by adding external data store field names and rules to drop-down lists in the data mapping windows.

or a complex set of functions used to compute the value for a rule. For the BMC Atrium CMDB. Runs a process to obtain a single character value in response. Table 3-1: Rule syntax for AR System forms and BMC Atrium CMDB classes Rule Syntax constant| <{rule}> <{rule}> <{rule}> function| sql| targetsql| process| targetprocess| stmt| function|calc_tokenid Description Interprets the value that follows the pipe as a constant. with examples and descriptions of the results. For the AR System.00 Defining rules This section outlines the rule syntax used to define how AR System fields and BMC Atrium CMDB classes are mapped to the external data store.BMC Atrium Integration Engine 7. xxxxxx Any other value is dependent on whether the rule is defined for the AR System. For an external data store rule. A rule syntax can be a data constant. or for the external data store. Runs an SQL command to obtain a value. Table 3-1 describes the use of each kind of rule syntax. the BMC Atrium CMDB. Each is described in detail in the sections that follow. see the external data store documentation for an explanation of the external data store’s rule syntax.1. Note: This function works similarly to generating a Unique GUID for multiple fields. 46 Administrator’s Guide . Performs the function that follows the pipe. this is considered an attribute definition and is the name of an attribute in a BMC Atrium CMDB class. this is considered a field definition and is the name of a field on an AR System form. a simple mapping of external data store and AR System fields or BMC Atrium CMDB classes. Runs a process on the target to obtain a value. Each set of curly brackets ({}) encloses a field mapping rule that is evaluated independently. Defines an if/then/else statement to obtain a value. Calculates a unique alphanumeric value for all the fields mentioned within the function. The first rule to return a response value is considered the value to be returned. Runs an SQL command on the target to obtain a value.

Table 3-2: Constant syntax examples Example constant|Hardware constant|15 constant|”15” Results Returns the character string Hardware. instead. Returns the number 15. If the Notification Number is not found. the Unknown Value string is placed in the field. Returns the character string 15. put quotes around the value. Each set of curly brackets ({}) encloses a field mapping rule that Integration Engine evaluates independently. This syntax is useful if you populate some fields with known values when you create a request. the specified value is used. To force the value to be a string. If not. Table 3-3: Precedence syntax example Example {PO Number} {Notification Number} {constant|Unknown Value} Results The PO Number is returned if not null. the Notification Number is returned if not null. The first rule to return a response value is considered the value to be returned. Table 3-3 provides examples of how to use the precedence syntax. Precedence syntax (<{rule}> <{rule}> <{rule}>) This syntax allows you to set the precedence for a set of rules. Integration Engine does not perform a database lookup in this case. Integration Engine attempts to assign a data type to the constant. If the PO Number is not found. Chapter 3 Defining rules and queries 47 . Integration Engine tries to determine if the value is a date or a number before it defaults to a character value. Table 3-2 provides examples of how to use the constant syntax.Defining rules Constant syntax (constant|<string>) This syntax allows you to generate a value to be placed into a field or class.

m.BMC Atrium Integration Engine 7.. Table 3-4 provides examples of the supported functions. Characters must be in quotation marks (" "). The parameters can be any of these: Constants Field names These must be delimited by dollar signs ($). Table 3-4: Function syntax examples Function calc_token_id Example function|calc_token_id ($field1$. Returns the value that results from appending the string: abcdef concat(string.string. field name. function|concat("abc". string. but numbers are entered without quotation marks. (if $createdate$ is set to Friday. Integration Engine converts the data obtained for each parameter to the correct data type if the data type is not already in the database in the required syntax. or function) currentdate() function|currentdate() Returns the current date as a character string: August 3.00 Function syntax (function|<function(parameters)>) Each function defines an operation that Integration Engine performs to obtain a value. 2007 or function) 12:15:00 a. (if $createdate$ is set to Friday. August 3. field name. 2007 (where timestamp is a ($createdate$) constant.1.) day(timestamp) function|day Returns the date portion of the time stamp data from the field as a character string: August 3.) Returns the day of the time stamp (1 to 31): 3 48 Administrator’s Guide . August 3. 2007 currenttime() function|currenttime() Returns the current time as a character string: 12:15:00 date(timestamp) function|date (where timestamp is a ($createdate$) constant. for example: concat ($<fieldname>$..$field2$) Results Calculates the token ID..m.) "def") (where string is a constant. $<fieldname>$) Other function formats Any parameter not recognized as a field name or a function is treated as a constant. 2007 or function) 12:15:00 a. field name.

Chapter 3 Defining rules and queries 49 .. August 3. to a specified length: LEAD000ABC (where string is a constant. Returns the value that results from "LEAD000000") padding the character string to the (where string and long are constants. 2007 12:15:00 a.) left(string. 7) Strips any leading blanks from a character string: abc Returns the maximum value from a set of values (all must be the same data type): 15 (where any is a constant. or functions) length(string) character string up to the number of bytes indicated: Da (where string is a constant. field name.) max($field$. or function) max(any. or function) lpad(string. field names. .long) function|left("Dana". field name.any.. field names.$field 2$.any.10. field name. or function) Returns the length of a character function|length("Dana") string..m.Defining rules Table 3-4: Function syntax examples Function hour(timestamp) Example Results Returns the hour of the time stamp (0 to 23): 12 function|hour (where timestamp is a ($createdate$) constant. (if $createdate$ is set to or function) Friday. Any non-null value (positive or negative) is greater than null. field name. or functions) ltrim(string) function|ltrim(" abc") left with another string. 3. field name. . These can be field references or constants.long. string) Converts a character string to lowercase: eie function|lpad("ABC".) function|max(15.2) Returns the left-most bytes of a (where string and long are constants. or function) All data types are supported. Example 1: Example 2 (values in database field char1 for five 4 records): Example 2: fantastic africa ice liver rice function|length ($char1$) 9 6 3 5 4 Example 1: lower(string) function|lower("EIE") (where string is a constant..

1) long are constants. field name. field name. "def".1 to 5. function|replace string. or function) replace(string.. "b".2) (where string and (where real is a constant. 2007 12:15:00 a.00 Table 3-4: Function syntax examples Function min(any. or functions) right with another string.any. field name.) Example function|min ("a". 2007 or function) 12:15:00 a. Returns the minute of the time stamp (0 to 59): 15 minute(timestamp) function|minute (where timestamp is a ($createdate$) constant.4 are rounded to 5. string) Returns the rounded value of a real number (5.9 are rounded to 6): 5 function|rpad("ABC".long. (if $createdate$ is set to Friday. "xxx") (where string is a Replaces all instances of a value in a character string with a new value: abcxxxghi You can use field references or constants. 5.) month(timestamp) function|month (where timestamp is a ($createdate$) constant. This is mostly used in queries to see if a value is null. August 3. field name. field name. field names.1. .long) function|right ("Allie".) null() function|null() Returns the month of the time stamp (1 to 12): 1 Returns a null value.5 to 5. field names.10. or function) rpad(string.. These can be field references or constants. Any non-null value (positive or negative) is greater than null. Returns the value that results from "000000LEAD") padding a character string to the (where string and long are constants.string.. (if $createdate$ is set to or function) Friday. to a specified length: ABC000LEAD 50 Administrator’s Guide . Returns the right-most bytes of a character string up to the indicated number of bytes: ie function|round(5.m.m. or functions) round(real) right(string. "c") Results Returns the minimum value from a set of values (all must be the same data type): a (where any is a constant. August 3.any. Integration Engine does not set an AR System value or a BMC Atrium CMDB attribute to null: null value constant...BMC Atrium Integration Engine 7.) ("abcdefghi". or function) All data types are supported.

“ic”) Returns an integer indicating the position of a string within a string. August 3. "def") (where string is a constant. field names. Example 1: 3 Example 2: 7 3 0 -1 1 substr(string. 2007 or function) 12:15:00 a. 2007 12:15:00 am time(timestamp) function|time (where timestamp is a ($createdate$) constant. field name.[.) status() function|status() Returns the second from the time stamp (0 to 59): 0 Returns an integer value to indicate the completion status for the transfer of data for an individual record: 0 indicates that the data transferred without error. (if $createdate$ is set to Friday. This function is only used for response mapping. field name. August 3. string) Example 1: function|strstr ("abcdefg". long. (if $createdate$ is set to or function) Friday. 2007 12:15:00 a. August 3. strstr(string. field name. field name. Starting position is 0 indexed.) Returns the time portion of the time stamp (as a character string): 12:15:00 Chapter 3 Defining rules and queries 51 .m. or function) second(timestamp) function|second (where timestamp is a ($createdate$) constant.long]) function|substr ("abcdefg". 4) (where string and long are constants.Defining rules Table 3-4: Function syntax examples Function rtrim(string) Example function|rtrim("abc ") Results Removes any trailing blanks from a string: abc (where string is a constant. Starting position is 0 indexed: cde Returns the current time as an AR System time stamp: Friday. or function) Example 2 (values in database field char1 for 5 records): fantastic africa ice liver rice function|strstr ($char1$. or functions) timestamp() function|timestamp() Returns the substring of characters in a string starting at a specified position up to an optional end position. If the string is not found. 1 indicates that an error occured.m. 2. -1 is returned.

For example. field name.00 Table 3-4: Function syntax examples Function trunc(real) Example function|trunc(5. the value for the Category field ($category$) is replaced in the select statement before the statement is processed. or function) upper(string) function|upper("Alex") Converts a string to uppercase: ALEX (where string is a constant.) year(timestamp) function|year (where timestamp is a ($createdate$) constant. in Table 3-5.1 to 5. This syntax differs from the target SQL command syntax (described in the following section) in this Integration Engine runs the select statement on the source database defined for the data exchange.1. Integration Engine uses the first value and ignores the remaining values. You can embed field names (<$field$>) into the select statement. Table 3-5: SQL command syntax example Example sql|select categoryid from categories where name = $category$ NOTE Results Returns category IDs from the categories table where the name equals the value obtained for the $category$ field.6) Results Truncates a real number (5. or function) (if $createdate$ is set to Friday. 2007 12:15:00 a.) SQL command syntax (sql|<command>) Integration Engine runs the select statement (<command>) after the pipe to obtain a value.BMC Atrium Integration Engine 7. field name.m. August 3.m.9 results in value 5): 5 (where real is a constant. field name. 2007 12:15:00 a. August 3. or function) weekday(timestamp) function|weekday (where timestamp is a ($createdate$) Returns the weekday of the time stamp (1 to 7 where 1=Sunday): 6 constant. (if $createdate$ is set to Returns the year portion of the time stamp as a four-digit year: 2007 or function) Friday. If the SQL command returns more than one field or more than one row. The value of the field is substituted prior to running the select statement. 52 Administrator’s Guide . field name.

This syntax differs from the SQL command syntax (described in the preceding section) in this Integration Engine runs the select statement on the target database defined for the data exchange.Defining rules Target SQL command syntax (targetsql|<command>) Integration Engine runs the select statement (<command>) after the pipe to obtain a value. You can embed field names (<$field$>) into the select statement. Integration Engine replaces the values for $keyName$ and with the actual data values before running the process. in Table 3-7. the values for the fields are first obtained and substituted prior to invoking the command. Table 3-6: Target SQL command syntax example Example targetsql|select locationid from location where department = $location$ Results Runs the location ID from the location table where the department equals the value of the $location$ field obtained from the source database. The response from the command is used. For example. the value for the Location field ($location$) is obtained from the source database and replaced in the select statement before it is passed to the target database for processing. The value of the field is substituted prior to running the select statement.$field2$) Results Runs the command getlastupdate on the source database. $field2$ For example. passing the values for $keyName$ and $field2$ as parameters. Table 3-7: Process command syntax example Example process| getlastupdate ($keyName$. Chapter 3 Defining rules and queries 53 . If the command has embedded $-delimited field names. The value of the field is obtained from the source database and substituted prior to invoking the select statement on the target database. in Table 3-6. Process command syntax (process|<command>) Integration Engine runs the command that follows the pipe to obtain a value. This syntax differs from the target process command syntax in that Integration Engine runs the command on the source database defined for this data exchange.

54 Administrator’s Guide . The response from the command is used.1.BMC Atrium Integration Engine 7. This syntax differs from the process command syntax in that Integration Engine runs the command on the target database defined for this data exchange. The syntax is as follows: STMT|IF Condition THEN Execution [ELSE Execution] ENDIF The following conditions apply: The line breaks following THEN and ELSE are required. For example. with string values in double quotation marks. Integration Engine obtains the value for the field from the source database and substitutes its value in the command.$field2$) Results Runs the command getlastupdate on the target database. Condition is in the format $SourceField$ Operator Value. Assignments must be in the format VALUE = value. If the command has embedded $-delimited field names. You can use STMT only with character or selection fields in the target.00 Target process command syntax (targetprocess|<command>) The command that follows the pipe is run on the target database to obtain a value. passing the values from the source database for $keyName$ and $field2$ as parameters. Integration Engine replaces the values for $keyName$ and $field2$ with the actual data values in the source database before running the process on the target database. which the target database then runs. in Table 3-8. Operator must be one of: =—SourceField matches Value does not match Value !=—SourceField LIKE—Any part of SourceField matches Value Execution can be either an assignment or another IF block. Table 3-8: Target process command syntax example Example targetprocess| getlastupdate ($keyName$. If/then/else syntax (STMT|<statement>) This syntax allows you to use an if/then/else statement to obtain a value.

Table 3-9: Stmt syntax examples Example STMT| IF $CDiOsType$ = "Windows XP Professional" THEN VALUE = "Windows XP (67)" ENDIF Results Returns Windows XP (67). Because no ELSE clause exists on the nested IF statement. Professional) STMT|IF $ChassisType$ = "12" THEN IF $ChassisSize$ = "Large" THEN VALUE="12CRPF" ENDIF ElSE VALUE="13CRPF" ENDIF The top-level IF statement matches. (if $CDiOsType$ is set to Windows XP Professional) STMT|IF $CDiOsType$ LIKE "Windows XP" THEN VALUE = "Windows XP (67)" ELSE VALUE = "Unknown" ENDIF (if $CDiOsType$ is set to Windows 2003 The string Windows XP does not appear in Windows 2003 Professional. See the adapter documentation for the query syntax supported by your adapter. Returns Unknown. <$field$> <operator> <value> This query syntax applies to AR System forms only.Defining queries Table 3-9 provides examples of how to use the stmt syntax. but the nested one does not. no value is returned. Chapter 3 Defining rules and queries 55 . (if $ChassisType$ is set to 12 and $ChassisSize$ is set to Small) Defining queries Use the following query syntax to define queries on the Query tab of the three Mapping Information windows. Each third-party adapter defines its own query syntax. which might not be similar to the query syntax described in this section.

When you use multiple operators to construct query criteria. Use the AR System query syntax.00 AR System query syntax When you use the AR System query syntax. The value used in the comparison.) Negates the condition that follows. (If the condition is false. you can supply any number of operations. This differs from = in that the <value> must be a list. the result is true. however. Returns all the values in <$field$> when the value is less than or equal to <value>. or enter a data constant.) Performs a pattern search. depending on the condition you want. must be concatenated with either AND or OR. Returns all the values in <$field$> when the value is not equal to <value>. For AR System queries. (The result is true if either condition is true. Returns all the values in <$field$> when the value is equal to <value>. For example. Returns all the values in <$field$> when the value is in the list of values in <value>. (The result is true if both conditions are true. The relational operators are: Returns all the values in <$field$> when the value is greater than <value>. ‘Submitter’ LIKE “Bob” finds all requests with a submitter name that begins with the letters “Bob” (such as Bobby Compton). Parentheses are placed around strings. Each. The fields are delimited by dollar signs. Table 3-10: Query syntax options Option <$field$> Description The field name to be used in the comparison. Returns all the values in <$field$> when the value is less than <value>.1. for example.BMC Atrium Integration Engine 7. This differs from != in that the <value> must be a list. Table 3-10 describes the query syntax options. $SALARY$ > 2000. <value> <operator> < > = != <= >= () AND OR NOT LIKE IN NOT IN 56 Administrator’s Guide . Returns all the values in <$field$> when the value is not in the list of values in <value>. <$field$> names a field on an AR System form. parentheses are the first operators evaluated. Logical AND of the results of two conditions.) Logical OR of the results of two conditions. Returns all the values in <$field$> when the value is greater than or equal to <value>.

CI classes. Supplies the current date and time. Returns all entries in the database where the $category$ field is not a null value. Table 3-12: Field option in the query syntax Syntax $KEY$ Description Indicates all field names defined on the Primary Key Mapping tab of the respective Mapping Information windows for AR System forms. $KEY$ is likely to be supported by any adapter. You can use the functions listed in Table 3-11 in your query. Table 3-11: Function query syntax examples Syntax currentdate() currenttime() null() timestamp() $category$ != $function|null()$ Description Supplies the current date.. CI classes. this is an AR System field name. and relationship classes.$) This is a special syntax that enables you to generate a value for the Value option in your query syntax rather than entering a data constant. You can use any syntax in Table 3-12 for the Field option within the query syntax.. Supplies the current time. CI classes. Data key queries are defined on the Data Key Query subtab of the Query tab on the respective Mapping Information windows for AR System forms. and relationship classes which can be accessed using left side navigation panel provided on Integration Engine console. Three different Mapping Information windows exist for AR System forms. For AR System.Defining queries Function query syntax ($function|. and relationship classes. Identifies a null value (different from blank). Field option in the query syntax ($<field>$) This is a special syntax for data key queries. Data key syntax You can only use the syntax described in this section in a data key query. and relationship classes. The functions supported are listed in the dropdown list accessed by the Rules button on the Query tab of the respective Mapping Information windows for AR System forms. Chapter 3 Defining rules and queries 57 . CI classes. $<fieldname>$ Anything other than $KEY$ is considered a field definition.

Table 3-13: Value option in the query syntax Syntax $function|$ Description Performs the function that follows the pipe to obtain a value. It enables you to automatically include the correct syntax for a multiple or single column key. NOTE $KEYLIST$ is a keyword that is usually supported by any adapter. If this syntax is entered for an AR System query. It generates a query that returns all requests from an AR System form where the AR System data keys for this data mapping exist in the key list obtained from the External data store. NOTE $KEY$ is a keyword that is usually supported by any adapter. You can use any syntax in Table 3-13 for the Value option within the query syntax. Table 3-14: KEY syntax example Example $KEY$ = $KEYLIST$ Result $<keyfield1>$ = key1 AND $<keyfield2>$ = key2 KEYLIST This is a special syntax for data key queries. it requests a list of data values from the external data store for the key fields that are defined on the Primary Key Mapping tab of the respective mapping console for AR.BMC Atrium Integration Engine 7. The value is placed in the query before it is used to limit the data used in the data exchange. $KEYLIST$ is usually supported by any adapter.00 Value option in the query syntax (<value>) This is a special syntax for data key queries. CMDB and Relationship data exchange.1. 58 Administrator’s Guide . $KEYLIST$ xxxxxxx Any other value is treated as a constant and passed to AR System server for handling. An example is defined in Table 3-14. Indicates that all keys from the target database are to be placed in the query before it is used to limit the data in the data exchange. It is especially useful when trying to specify a query for all keys in a key list. The External data store list is either all key values in the thirdparty data store or a subset of keys based on the query defined in the External Data Store Query field on the Data Key Query sub tab of the Query tab on the Mapping Information window. KEY syntax ($KEY$) This is a special syntax for data key queries.

tbl and . and deletion row-level queries. You use the adapter rule helpers to create field menus for external data store tables.Using the adapter rule helper utilities The operators IN. response. NOT IN. and SQL Server rule helpers are used through the Database Field Menus Console. Chapter 3 Defining rules and queries 59 . Row-level queries are defined on the Update Query sub tab of the Query tab on the EIE:ARMappingInfo form. NOTE All helper binaries are available in the <AIE install directory>\bin directories. Table 3-15: KEYLIST syntax examples Example $KEY$ = $KEYLIST$ $KEY$ != $KEYLIST$ Result Indicates that all records matching the keys in the $KEYLIST$ are to be returned. Row-level query syntax You can only use the syntax described in this section in the query syntax for a rowlevel query. The DB2. The query is applied to the target row rather than the source and target rows. XML Helper and File Helper are used through workflows. or != can precede $KEYLIST$. Table 3-16: SRC syntax examples Example $LastModified$ < $SRC|LastMod$ Result $LastModified$ < 05/23/07 (if LastMod is a field in the source database with a value of 05/23/07) Using the adapter rule helper utilities The Database Field Menus Console is used for populating field menus which are used when you create data mappings. and != is the same as NOT IN. (For the $KEYLIST$ syntax. They can also be run from a command line to populate fields in . The field menus allow you to choose the fields from your external data store from a list instead of typing them manually. = is the same as IN.) $KEYLIST$ is expanded with a series of <$field$> <operator> <value> statements as shown in Table 3-15. Oracle.xsd in the EIE:VendorFieldNames form. Examples are defined in Table 3-16. =. SRC syntax ($SRC| <fieldname>$) SRC (source) syntax is a special syntax for row-level queries. It allows you to have values from the source row substituted into the query before the query is compared against the target row. Indicates that all records not matching the keys in the $KEYLIST$ are to be returned. Integration Engine supports update.

type the user (owner) name.1. login name. you can use the command-line procedure instead. To populate DB2 field information for multiple external data tables 1 From the Integration Engine console. click Configuration > Database Field Menus. 2 Type your database instance. Figure 3-1: Database Field Menus Console The DB2 tab appears by default. If the list does not populate using the console. 60 Administrator’s Guide . 3 In the Limit tables and views for owner field. database alias. You can also populate multiple external data tables by adding the DB2 tables and views to the rule menus using the Integration Engine console. 4 Click Load Table & View Names.BMC Atrium Integration Engine 7. Populating DB2 field information for multiple external data tables The following steps describe how you populate DB2 fields for multiple external data tables. The Database Field Menus Console appears. and password in the respective fields. All the tables and views from the user database are populated in the Available Tables and Views list.00 Using the DB2 Adapter Rule Helper utility You can populate field information for a single external data table or multiple external data tables using commands.

6 Click Update Columns. 3 From the Available Tables and Views list. click Refresh Table List on the Database Field Menus Console window. 4 After the Selected Tables and Views list is populated with table names. To populate DB2 field information for multiple external data tables using a command line 1 Type the following command: db2helper -ax <ARServername>-ar 0 -al <Demo> -ap <> -da <DB2Alias> dl<DB2Login> -dp <DB2Password> -to <DB2User or DB2Owner> -di <DB2InstanceName> -d 2 After you execute the command. select the table or view. -to -tn (Table Name)—Valid table name owned by the table owner mentioned in the -to parameter. and click Add. and click Add. The rule menus with your table and view names are populated into the EIE:VendorFieldNames form. Chapter 3 Defining rules and queries 61 . Populating DB2 field information for external data tables using a command line The following steps describe how you populate DB2 fields for multiple external data tables and single external data tables using a command line. then use the following command to populate the table fields in the EIE:VendorFieldnames form: db2helper -ax <ARServername>-ar 0 -al <Demo> -ap <> -da <DB2Alias> dl<DB2Login> -dp <DB2Password> -di <DB2InstanceName> -c To populate DB2 field information for single external data tables using a command line Type the following command: db2helper -ax <ARServername>-ar 0 -al <Demo> -ap <> -da <DB2Alias> dl<DB2Login> -dp <DB2Password> -di <DB2InstanceName> -to <Table Owner> tn <Table Name> -c You must use three additional parameters: -c (Create menu to EIE:VendorFieldNames form) (Table Owner)—Valid table name in capital letters. This form provides the field names to the rule menus in the data mapping windows.Using the adapter rule helper utilities 5 From the Available Tables and Views list. The Available Tables and Views list should now be populated. The table or view is added to the Selected Tables and Views list. select the table or view. The table or view is added to the Selected Tables and Views list.

click Configuration > Database Field Menus. type the Oracle home directory where you will execute 62 Administrator’s Guide . The DB2 tab appears by default. 4 In the DB Directory field. The Oracle Adapter Rule Helper Utility window appears.BMC Atrium Integration Engine 7. Populating Oracle field information for multiple external data tables The following steps describe how you populate Oracle fields for multiple external data store tables. You can also populate multiple external data store tables by adding the Oracle tables and views to the rule menus using the Integration Engine console. Figure 3-2: Oracle Adapter Rule Helper Utility window 3 Type your SID. The Database Field Menus Console window appears. 2 Click the Oracle tab. login name.00 Using the Oracle Adapter Rule Helper utility You can populate field information for a single external data store table or multiple external data store tables using commands. To populate Oracle field information for multiple external data tables 1 From the Integration Engine console. If the list does not populate using the console. database alias. database directory. Oracle helper. and password in the respective fields.1. you can use the command-line procedure instead.

To populate Oracle field information for multiple external data tables using a command line 1 Type the following command: rlohelper -ax <ARServername>-ar <ARPort> -al <ARUser> -ap <ARPassword> os <SID> -ol <DBUser> -op <DBPassword> -oh <OracleDBDirectory> -oa <SID> -to <DBOwner> -d 2 After you execute the command. The Available Tables and Views list should now be populated. click Refresh Table List on the Database Field Menus Console window. The table or view is added to the Selected Tables and Views list. type the user (owner) name. 4 After the Selected Tables and Views list is populated with table names. The table or view is added to the Selected Tables and Views list. 7 From the Available Tables and Views list. The rule menus with your table and view names are populated into the EIE:VendorFieldNames form. This form provides the field names to the rule menus in the data mapping windows. select the table or view. 8 Click Update Columns. All the tables and views from the user database are populated in the Available Tables and Views list. and click Add. 3 From the Available Tables and Views list. Populating Oracle field information for external data tables using a command line The following steps describe how you populate Oracle fields for multiple external data tables and single external data tables using a command line.Using the adapter rule helper utilities 5 In the Limit tables and views for owner field. then use the following command to populate the table fields in the EIE:VendorFieldnames form: rlohelper -ax <ARServername>-ar <ARPort> -al <ARUser> -ap <ARPassword> os <SID> -ol <DBUser> -op <DBPassword> -oh <OracleDBDirectory> -oa <SID> -c -d Chapter 3 Defining rules and queries 63 . 6 Click Load Table & View Names. select the table or view. and click Add.

64 Administrator’s Guide . you can use the command-line procedure instead. If the list does not populate using the console.00 To populate Oracle field information for single external data tables using a command line Type the following command: rlohelper -ax <ARServername>-ar <ARPort> -al <ARUser> -ap <ARPassword> os <SID> -ol <DBUser> -op <DBPassword> -oh <OracleDBDirectory> -oa <SID> -c -d -to <Table Owner> -tn <Table Name> You must use three additional parameters: -c (Create menu to EIE:VendorFieldNames form) (Table Owner)—Valid table name in capital letters.1.BMC Atrium Integration Engine 7. Populating SQL field information for multiple external data tables The following steps describe how you populate SQL fields for multiple external data tables. -to -tn (Table Name)—Valid table name owned by the table owner mentioned in the -to parameter. Using the SQL Adapter Rule Helper utility You can add SQL Server tables and views to rule menus using the Integration Engine console.

The Database Field Menus Console window appears. If you select this option.Using the adapter rule helper utilities To populate SQL field information for multiple external data tables 1 From the Integration Engine console. 2 Click the SQL Server tab. click Configuration > Database Field Menus. Chapter 3 Defining rules and queries 65 . The SQL Adapter Rule Helper Utility window appears. 4 In the Database Name field. type the name of your SQL Server database. you do not need to type a login name or password. If you use Windows authentication for your database. complete one of the following actions: Leave this field blank to have Integration Engine retrieve all tables and views. 5 Complete one of the following actions: Type your user name in the Login Name field and the password in the Password field. Figure 3-3: SQL Adapter Rule Helper Utility window 3 In the Server Name field. type the name of your SQL Server. 6 Click Save. 7 In the Limit tables and views for owner field. The DB2 tab appears by default. click the Enable Windows Authentication check box. Type a user (owner) name in this field to retrieve only the tables and views owned by that user.

exe. and click Add. NOTE The utility is located at <AIE_install_dir>\bin\rlshelper. <AIE_install_dir>\bin\rlshelper. 10 Click Update Columns. The Main tab appears by default. The rule menus with your table and view names are populated into the EIE:VendorFieldNames form.exe. The Run dialog box appears. 2 In the Open field.00 8 Click Load Table & View Names. All the tables and views from the user database are populated in the Available Tables and Views list. This form provides the field names to the rule menus in the data mapping windows. 9 From the Available Tables and Views list. The Rule Helper window appears. 66 Administrator’s Guide . For example. browse to select the path for running the Rule Helper utility. Populating SQL field information for multiple external data tables using a Windows-based application The following steps describe how you populate SQL fields for multiple external data tables using a Windows-based application.BMC Atrium Integration Engine 7.1. select the table or view. The table or view is added to the Selected Tables and Views list. To populate SQL field information for multiple external data tables using a Windows-based application 1 Choose Start > Run from the Windows start menu.

e To enable Windows authentication for database connection. type the user name for connecting to the SQL Server The user must have privileges to read the system catalog to obtain the definition of the database objects used in the exchange. The database login information appears. the user who is logged on to Integration Engine. type the name of the Windows host where the SQL Server database is installed. Chapter 3 Defining rules and queries 67 . c In the User Name field. 4 In the Microsoft SQL Server Connection area. database. For example. The user must also have access to the objects used in the data exchange. d In the Password field. do the following tasks: a In the Database Server field. type the password associated with the user name used to connect to the SQL Server database. select the Enable Windows Authentication check box. b In the Database Name field. will be considered for database authentication. type the name of the SQL Server database from which the Rule Helper utility obtains table and view definitions. Figure 3-4: Database Connection tab You use the Database Connection tab to define connection information to locate the SQL Server database (used as a rule source) and the AR System server where the Data Exchange application is installed.Using the adapter rule helper utilities 3 Click the Database Connection tab.

and click Add to add them to the EIE Data Exchange menu list on the right. 68 Administrator’s Guide . do the following tasks: a In the AR Server field. The list on the left is updated with the tables and views from the SQL Server database. 6 Click the Main tab. b In the RPC Port field.BMC Atrium Integration Engine 7. 9 Click Create Menu. Figure 3-5: Main tab 7 Click Load Table/View Names. d In the Password field. The SQL Server database tables and views information appears. type the password for the AR System administrator. 10 Click Close.1. c In the User Name field. 8 Select the tables and views you want to add from the list on the left. type the port number of the AR System server.00 5 In the AR System Server Connection area. type the user name for the AR System administrator. type the host name of the AR System server.

sh script to set the DB2 client installation directory. These scripts are located in the <arserver_installation>/bin directory.1. rlohelper. if you have AR server installed on Oracle. To edit the script for DB2 1 Open <arserver_installation>/bin/db2helper. NOTE For DB2 rule helper. Type the following command: xmlhelper -ax <ARServerName> -al Login -ap Password -ar port -xp <Path to the xml schema> -xr <xml row identifier>-d Using the File Adapter Rule Helper utility You must run the File Adapter Rule Helper utility from a command line. 2 Append the line. These scripts internally invoke the respective Rulehelper utilities for both Oracle and DB2.Using the adapter rule helper utilities Using the XML Adapter Rule Helper utility You must run the XML Adapter Rule Helper utility from a command line.sh.to read as follows: AIE_DB2_LIB_DIR=/opt/IBM/db2/V9. Type the following command: filehelper -ax <ARServerName> -al Login -ap Password -ar port -fn <Path to the file on the local machine> -d Using the the adapter rule helper utilities on UNIX platforms For UNIX platforms. Chapter 3 Defining rules and queries 69 . NOTE You must enter the path to the parent of the lib/lib32 directory only. AIE_DB2_LIB_DIR=. For Oracle.sh and db2helper. you must change the db2helper.sh are the two scripts that are executed. the path derives from the command line parameter.

BMC Atrium Integration Engine 7. Customizing this control helps you add rules and functions that you often use. To populate the rule control 1 Log on to BMC Remedy User as an administrator. Delete. and Query tabs of the EIE:ARMappingInfo form by using the EIE:Rules form. Table 3-17 shows how this control is implemented on each tab. The Object List window appears.00 Populating the rule control You can append rules to the rule control on the Field Mapping. 70 Administrator’s Guide .1. 2 Choose File > Open > Object List. Figure 3-6: Object List window 3 Select EIE:Rules. Table 3-17: Rule control implementation Tab Data Field Mapping Response Field Mapping Delete Field Mapping Query Implementation Rules list Rules list Rules list Rules list For example. Response. the following procedure describes how you can add a customized rule that concatenates the first and last name fields.

Populating the rule control 4 Click New. For example. For this example. select Field Rule. $LastName$) to generate a first name followed by a space and then a last name. The choices are: Field Rule Populates the selections from the Rule control for data mappings. 7 In the Category drop-down list. type the item that you want to append to the list. The EIE:Rules window appears. " ". type First & Last Name. Query Rule Populates the selections from the Rule control for queries. Figure 3-7: EIE:Rules window 5 In the EIE Keyword field. type concat($FirstName$. type the syntax of the field or rule. This is the actual text that is placed into the field in the EIE:ARMappingInfo form. This is just a text identifier for the field or rule. Delete Rule Populates the selections from the Rule control for deletions. It need not be the exact syntax of the rule. 6 In the Syntax field. Chapter 3 Defining rules and queries 71 . For example. select a category that represents the fields to populate with your item.

00 8 In the Prefix Syntax drop-down list.$FirstName$) function that you just created is available from the selection list that is accessed from the Rule control located on the Field Mapping tab. If it does. 9 In the Rule Owner field. NOTE Currently function | is the only valid prefix. which is the value defined in the External Data Store field on the EIE:DataExchange form. type the name of the rule as you would like it displayed. the prefix is placed at the start of a line followed by the syntax field contents. 11 Click Save. workflow verifies that the field receiving the keyword starts with a prefix. The concat($LastName$. select function|.BMC Atrium Integration Engine 7. such as functions. For this example. To limit the use of this field or rule to a particular external data store.".". type the data store for which this rule is valid.1. 72 Administrator’s Guide . type the name of the adapter. If this field is left blank. all Integration Engine services can use this field or rule. If a prefix is present. select the syntax of a prefix that is required for the category of a command. This is intended for items with prefixes. 10 In the Rule Display field.

or creating AR System workflow that does either of these.Chapter 4 Activating event-driven data exchanges You can create an event-driven data exchange request by using the Application Pending form. invoking the eiexfer utility. The following topics are provided: Creating a request on the Application Pending form (page 74) Creating a request using the eiexfer utility (page 78) Activating an event-driven data exchange through workflow (page 83) Chapter 4 Activating event-driven data exchanges 73 .

you must use its key. NOTE You cannot identify a record by its AR System request ID if you are running a data exchange between an external data store and BMC Atrium CMDB classes. Alternatively. You can identify a record that you want to transfer either by its key or its AR System request ID. The Integration Engine service processes requests on the Application Pending form on a scheduled interval that is configured in the eie.cfg file (the AsyncInterval parameter). you must delete old entries manually to keep the database from getting too large. From time to time. you can write workflow that periodically deletes entries automatically. all event-driven requests are written to the Application Pending form. you can include all records configured for exchange by running a bulk exchange.BMC Atrium Integration Engine 7. 74 Administrator’s Guide .00 Creating a request on the Application Pending form Whether you create requests using the Application Pending form or the eiexfer utility. Alternatively.1. In this case. NOTE The Integration Engine service has no mechanism for clearing entries on the Application Pending form.

4 Click New. The Application Pending window appears. The Object List window appears. Chapter 4 Activating event-driven data exchanges 75 . 2 Choose File > Open > Object List. Figure 4-1: Object List window 3 Select the Application Pending form. type EIE.Creating a request on the Application Pending form To create a request on the Application Pending form 1 Log in to BMC Remedy User. Figure 4-2: Application Pending window 5 In the Category field.

Table 4-1: Status values Status New In Progress Completed Error Description The request has been submitted but has not been processed. Table 4-1 shows the list of status values. enter one of the following types of event driven exchange: Immediate Request On Schedule Interval 76 Administrator’s Guide . The Source ID field indicates the status of the request. 7 In the Form field. the you can write workflow to send a notification to the submitter to indicate if an error has occurred. type the name of the data exchange that you want to use. type the instance name. As with log messages. The request is currently being processed.1. Failed The request for data transfer was attempted and failed. The most common problem is an error in the syntax in the Other Short field or an unrecognized data exchange name.BMC Atrium Integration Engine 7. The text in the Other Long field indicates the cause of the error. The text in the Other Long field indicates the cause of the error. 9 In the Tag field. The request completed successfully. type New. 8 In the Source ID field.00 6 In the Command field. The data exchange name is the value you typed in the Exchange Name field on the Main tab of the EIE:DataExchange form. The request for a data transfer did not take place because there was a problem.

or invoke all records configured for a data exchange using one or more of the parameters in Table 4-2. -r 0000001472 -r 0000003742). how many records were inserted or updated. Note: The -r parameter is not supported for data exchanges between an external data store and BMC Atrium CMDB classes. You can use this parameter to request a record only if your data exchange already contains a data mapping for the form to which this record is transferred. 12 Click Save.Creating a request on the Application Pending form 10 In the Other Short field. Note: If you want a space to be recognized as a space. Note: You can specify one or more request IDs (for example: -b <data_exchange_name> Specifies that a bulk data transfer of all data defined for a data exchange is to occur. If the -b parameter is used to invoke the exchange of all records. 11 In the Status options. -s <data_exchange_name> Specifies the data exchange to use. This field enables printing of the final exchange completion statistics. select Pending. to enter the last name Van Arc as a single value. For example. type the key or the AR System request ID for the record that you want to include in the data exchange. Chapter 4 Activating event-driven data exchanges 77 . NOTE The -k or -r parameter is used to select individual records for exchange and must be accompanied by the -s parameter. Every key value that you enter must have a corresponding entry on the Primary Key Mapping tab of the EIE:ARMappingInfo form. For example. You must enter multiple key values if multiple key fields are defined on the Primary Key Mapping tab. -r <request_id> Specifies the AR System request ID of the record you want to transfer. This parameter is mandatory if you want to specify individual records for exchange rather than invoking a bulk transfer. enclose it in quotation marks: -k ‘Van Arc’ Vicki. the -s parameter is not used. The data exchange name -k <key_value> Specifies the key value of the record you want to transfer. Table 4-2: Data Exchange parameters Parameter Description is the value you typed in the Exchange Name field on the Main tab of the EIE:DataExchange form. add single quotes around the value. The Other Long field is completed by Integration Engine after the completion of the data exchange.

type your request into the Application Pending form rather than invoking the eiexfer utility to improve performance. The Integration Engine service processes requests on the Application Pending form on a scheduled interval that is configured in the eie. you can also configure the Integration Engine service to process individual event requests immediately if you enter them through the eiexfer utility.cfg file (the AsyncInterval parameter). <eie_install_dir>\service\bin\eiexfer. Use this method if you have a distributed environment and are submitting a request from a machine other than the one running the Data Exchange application and the AR System server. the eiexfer utility for Windows is installed in the following directory: <eie_install_dir>\service\bin\eiexfer. To create a request using the eiexfer utility 1 Navigate to the command line of the machine where you installed AR System and the Data Exchange application. according to the parameters specified on the command line.00 Creating a request using the eiexfer utility The eiexfer utility is an AR System client that opens a connection to AR System and sets up the conditions for the transfer of data on an event-driven basis. 2 Type the following command using the AR System parameters in Table 4-3. By default. In addition to the scheduled interval. NOTE If your event-driven data exchange does not need to occur immediately. you can manually move the eiexfer utility (and its supporting DLL files on Windows) to another machine.exe.1. the Data Exchange parameters in Table 4-4. and the optional immediate parameters in Table 4-5 (if you want to run the data exchange request immediately). all event-driven requests are written to the Application Pending form.BMC Atrium Integration Engine 7.exe 78 Administrator’s Guide . Whether you create requests using the Application Pending form or the eiexfer utility. However.

to enter the last name Van Arc as a single value. Specifies the AR System server login name for connecting to the AR System server. -r <request_id> Specifies the AR System request ID of the record you want to transfer. Table 4-4: Data Exchange parameters Parameter -s <data_exchange_name> Description Specifies the data exchange to use. For example. you must have a corresponding entry on the Primary key Mapping tab of the EIE:ARMappingInfo form. Specifies the password associated with the AR System server login name. Note: The -r parameter is not supported for data exchanges between an external data store and BMC Atrium classes. Table 4-3: AR System parameters Parameter -x <arserver_name> -rpcport <port_number> -l <login_name> -p <password> Description Specifies the name of the AR System server where the Application Pending form resides. Specifies the key value of the record you want to transfer. Note: You can specify one or more request IDs (for example: Chapter 4 Activating event-driven data exchanges 79 . rpcport 4500).Creating a request using the eiexfer utility Table 4-3 lists the AR System parameters you must use with the eiexfer utility. The data exchange name is the value you typed in the Data Exchange Name field on the Main tab of the EIE:DataExchange form. Note: If you want a space to be recognized as a space. You must enter multiple key values if multiple key fields are defined on the Primary Key Mapping tab. You can use this parameter to request a record only if your data exchange already contains a data mapping for the form to which this record is transferred. For every key value that you enter. add -k <key_value> single quotation marks around the value. -r 0000001472 -r 0000003742). Table 4-4 lists the Data Exchange parameters you can use when using the eiexfer utility. This parameter is mandatory if you want to specify individual records for exchange rather than invoking a bulk transfer. enclose it in quotation marks: -k ‘Van Arc’ Vicki. Specifies the port of the AR System server (for example.

Specifies the instance associated with this data exchange. To specify an event-driven request to transfer a record for an employee named Smith from the employees’ data exchange: eiexfer -x myserver -l jdoe -p password -s employees -k Smith -n <instance name> To specify an event-driven request for a bulk exchange of all employee records: eiexfer -x myserver -l jdoe -p password -b employees -n <instance name> 80 Administrator’s Guide . Examples of the event-driven request command syntax The following examples assume an AR System server name of myserver. the -s parameter is not used. If the -b parameter is used to invoke the exchange of all records. Specifies the number of times the program checks for a response before ending. Table 4-5: Optional immediate parameters Parameter -i -w <no. of seconds before checking for a response> -c Description Specifies that the request should be processed immediately. NOTE The -i parameter is required for immediate handling.1. NOTE The -k or -r parameter is used to select individual records for exchange and must be accompanied by the -s parameter. a login name of jdoe. the number of times defaults to three. The -w and -c parameters are optional. If you do not specify a value for the -w parameter. the number of seconds defaults to five. If you do not specify a value for the -c parameter.00 Table 4-4: Data Exchange parameters Parameter -b <data_exchange_name> -n <instance_name> Description Specifies that a bulk data transfer of all data defined for a data exchange is to occur.BMC Atrium Integration Engine 7. Table 4-5 lists the optional immediate parameters you can use when using the eiexfer utility. and a password of password. Specifies the number of seconds to wait before checking for the completion status of the request.

Table 4-7: eiexfer completion code messages ID Number 0 Message Request completed successfully.Creating a request using the eiexfer utility To specify an immediate event-driven request for an employee whose record is identified by the AR System server ID number 23456 from the employees’ data exchange using a wait interval of 10 seconds and a retry count of 20: eiexfer -x myserver -l jdoe -p password -s employees -r 23456 -i -w 10 -c 20 -n <instance name> To specify an immediate event-driven request for a bulk exchange of all employee records using the default wait time of 5 seconds and a retry count of 20: eiexfer -x myserver -l jdoe -p password -b employees -i -c 20 -n <instance name> To specify an event-driven request to transfer a record for an employee named Tom Smith from the employees’ data exchange: eiexfer -x myserver -l jdoe -p password -s employees -k “Smith Tom” -n <instance name> Completion codes returned by eiexfer Data exchange requests that are submitted through the eiexfer utility return completion codes that indicate the status of a request. One or more required parameters are missing from the event-driven request. The completion codes are listed in Table 4-7. but the completion status could not be obtained. These codes fall into several categories. -101 Required parameters are missing. The event-driven request is complete and no errors were encountered during the data transfer. Table 4-6: eiexfer completion code categories Category 0 100-199 200-299 300-399 400-499 Description Request completed successfully. A brief definition follows each message in the table. The request in the Application Pending form contains the error message indicating the cause of the failure. Request was submitted and the Integration Engine service was notified to handle the request. Chapter 4 Activating event-driven data exchanges 81 . but the data failed to transfer. which are listed in Table 4-6. Request was submitted. but the Integration Engine service could not be notified to handle the request. Request was not submitted to event-driven request queue. Request was handled by the Integration Engine service. The request was not submitted for processing.

BMC Atrium Integration Engine 7.1.00

Table 4-7: eiexfer completion code messages ID Number -102 Message
Unable to create buffer for the event request.

The event-driven interface ran out of available memory and was unable to create a request block to transmit the request. The processing cannot continue. This is a fatal error. -103
AR Initialization failed. Verify login information is correct.

The event-driven interface was unable to connect to the AR System server identified by the parameters. Verify the AR System server login parameters. If the parameters are correct, verify that the AR System server is running. -104
Failed to submit event request. ARCreateEntry returns error.

The event-driven request could not be submitted to the Application Pending form on the AR System server. Verify that the AR System server identified in the startup parameters has the Data Exchange application installed. -201
Unable to retrieve host name and port for EIE service. Make sure the AR System user name and password are correct.

The event-driven request has been submitted, but the Integration Engine service could not be notified to handle the request. The Integration Engine service sets the wakeup port information in the EIE:BackupLoadFlag form. If the values are not set, no active Integration Engine service exists to handle the request at this time. -202
EIE service wakeup port not set in EIE:BackupLoadFlag form.

The event-driven request has been submitted, but the Integration Engine service could not be notified to handle the request. The Integration Engine service sets the wakeup port information in the EIE:BackupLoadFlag form. If the values are not set, no active Integration Engine service exists to handle the request at this time. -203 -204
Unable to create socket. Unable to establish socket connection to EIE service.

The event-driven request has been submitted, but the Integration Engine service could not be notified to handle the request. A socket connection to the Integration Engine service has been identified in the EIE:BackupLoadFlag form, but the socket connection could not be established. -205
Unable to send immediate request to EIE service.

The event-driven request has been submitted, but the Integration Engine service could not be notified to handle the request. A socket connection to the Integration Engine service has been established, but the wakeup request could not be sent. -301
Unable to access Event Request form to obtain response.

The event-driven request has been submitted, and the Integration Engine service has been notified to handle the request. The Application Pending form could not be accessed to obtain the completion status.

82

Administrator’s Guide

Activating an event-driven data exchange through workflow

Table 4-7: eiexfer completion code messages ID Number -302 Message
Request has not completed in time interval allowed.

The event-driven request has been submitted, and the Integration Engine service has been notified to handle the request. The request has not completed within the time interval allotted to check for a request. The event-driven interface makes three attempts to check for the completion status. Each request is tried after waiting the number of minutes in the -w parameter specified in eiexfer. -401
Transfer failed when handled by EIE service.

The event-driven request is complete and the Integration Engine service has returned an error indicating the data transfer failed. For detailed information about the error, check the debug file associated with the data exchange used in the data transfer.

Activating an event-driven data exchange through workflow
You can enter a request for an event-driven data exchange from an active link or filter. The active link or filter can either write a request directly in the Application Pending form or run the eiexfer utility. See BMC Remedy Action Request System 7.1.00 Workflow Objects for instructions on how to create active links or filters on your AR System form.

Chapter 4

Activating event-driven data exchanges

83

BMC Atrium Integration Engine 7.1.00

84

Administrator’s Guide

you run the Integration Engine service from a command line in your terminal’s foreground or as a daemon. On UNIX.cfg). The Integration Engine service parameters are defined in the configuration file (eie. On Windows. The following topics are provided: Running the Integration Engine service on Windows (page 86) Running the Integration Engine service on UNIX (page 87) Understanding the configuration file and its parameters (page 88) Managing instances (page 93) Changing Integration Engine AR System password (page 95) Chapter 5 Running and configuring the Integration Engine service 85 . you run the Integration Engine service from a command line or as a Windows service.Chapter 5 Running and configuring the Integration Engine service You can run the Integration Engine service on Windows and UNIX.

then stop and restart the service to continue. Port number for AR. then this message appears: The engine is running and has detected n active data exchanges on AR System: STUDIO If Integration Engine is not able execute the data exchanges then the following message appears: Failed to retrieve any active data exchange defined on AR System: STUDIO There could be three reasons for this to occur: You did not select any data exchange as active. The AR System user assigned to Integration Engine in the Integration Engine Application console does not have administrator privileges. Instance name which user wants to run. You did not select a data mapping for the active data exchange definition. To run the Integration Engine service from a command line Type the following parameters on the command line in the directory where the Integration Engine executable is located (for example. Selecting manual mode prevents the Integration Engine service from starting automatically before you are ready to run in production mode.exe -x <AR Server name> -p <port number> -n <instance name> -m Table 5-1: EIE service command-line parameters for Windows Parameter -m -x -n -p Description Indicates that the Integration Engine service is running from the command line. NOTE If you change the eie. One of the following messages appear: If Integration Engine was able to execute the data exchanges. <eie_install_dir>\service\bin) using the parameters in Table 5-1: eie.BMC Atrium Integration Engine 7. you can choose to start the Integration Engine service in automatic or manual mode. 86 Administrator’s Guide .cfg file to solve the problem. AR server name on which Integration Engine is installed. This parameter is required for both Windows and UNIX.00 Running the Integration Engine service on Windows When installing Integration Engine.1.

check the data exchange debug or log files for details about individual data exchanges. you would type . Integration Engine services are created as batch files based on the number of Integration Engine instances you install. The message is refreshed at an interval configured in the eie.Running the Integration Engine service on UNIX Running the Integration Engine service on UNIX You can run the Integration Engine on UNIX. In the service bin directory there are different start up script files are created to start different instance. To determine whether the data exchange ran successfully. debug files are located in the <eie_install_dir>\service\debug directory. By default. if you wanted to run a data exchange for the second instance. 2 Change to the directory where the Integration Engine service is installed (or include the full path): /usr/bmc/apps/aie/{ServerName-Port}/service/bin 3 Start the Integration Engine service. and aie003. and log files are located in the <eie_install_dir>\service\log directory. During startup./aie002 start on the command line. then three Integration Engine Service batch files are created named aie001. if you install three instances of Integration Engine. NOTE On UNIX. the Integration Engine service displays a message telling how many active data exchanges are running. In this case. 4 Do one of the following actions: stop. Stop a particular instance by using its script and parameter as stop: . Chapter 5 Running and configuring the Integration Engine service 87 . You then create your data exchanges based on these instances./aie002 Restart a particular instance by using its script and parameter restart: .cfg file. To run the Integration Engine service in the foreground 1 Open a terminal window. You can access them at: . aie002. However. this information does not indicate whether the active data exchanges are running successfully./aie002 restart. For example./aie001 start.

1. b Replace the ". 2 To set the variable inside the script file.BMC Atrium Integration Engine 7. To change any of these settings.cfg by opening it in a text editor and making the necessary changes." indicates that the database path is not being provided. For DB2. The rest are set with default values at installation. To load the adapters 1 Do either of the following tasks: For Oracle. you can either set the environment variable AIE_DB2_LIB_DIR or open the startup script file and provide the appropriate value for AIE_DB2_LIB_DIR which points to the DB2 32 bit lib folder located inside the DB2 client/database installation folder. It also contains global logging and debugging information. Some of the parameters in the configuration file are generated during installation based on the values you enter at that time. The ". you can either set the environment variable AIE_ORACLE_LIB_DIR or open the startup script file and provide the appropriate value for AIE_ORACLE_LIB_DIR which points to the Oracle 32 bit lib folder located inside the oracle client/database installation folder. either of the following warning messages will appear if you try to start the aie instance. you can edit eie. WARNING: Please make sure that AIE_ORACLE_LIB_DIR is set to point to Oracle client directory if you are going to use Oracle Adapter. 88 Administrator’s Guide .cfg) is used by the Integration Engine service to locate the AR System server where the Data Exchange application is installed. WARNING: Please make sure that AIE_DB2_LIB_DIR variable is set to point to DB2 client directory if you are going to use DB2 Adapter.00 Loading the adapters If you installed Integration Engine in custom mode and did not provide the Oracle directory or the DB2 directory or if you chose the express setup. do the following tasks: a Locate the script file: {start_instance() { [ ! "$AIE_ORACLE_LIB_DIR" ] && AIE_ORACLE_LIB_DIR=." with the appropriate database path indicated in the following example for DB2: [ ! "$AIE_DB2_LIB_DIR" ] && AIE_DB2_LIB_DIR=/opt/IBM/DB2/V9.1 Understanding the configuration file and its parameters The configuration file (eie.

For production. the engine checks for activated # and deactivated data exchanges one time each day. This form can quickly become populated with a large # number of records. For data exchanges that have # become deactivated. See “Configuration file parameters” on page 90 for more information about eie. it removes their threads. lines beginning with the pound (#) symbol are comments. in the # EIE:Log form for each record transferred during each data # exchange. Also defines the location of the log # file and whether it is active or inactive. DebugOn: Yes DebugPath: C:\Program Files\BMC Software\BMC Atrium Integration Engine\human resources\service\debug # Debug option: Stack trace for the engine: Yes/No. in minutes. StackTrace:No [AR System Info] # AR System Server connection information for engine-owned # AR System resources. Default is # set to 5 minutes for debugging.dbg) files MaxDebugSize: 102400 # Timestamp option adds a timestamp on each debug message: # Yes/No. eie.Understanding the configuration file and its parameters Sample configuration file If you installed Integration Engine in the default location. # Integration Engine Configuration Parameters [Log] # Adds one record. TimestampDebug: Yes # DebugOn option activates a debug file for eiemain. Chapter 5 Running and configuring the Integration Engine service 89 . If you give 1440 # as the value for the parameter. ARServerName: humanresources ARLogin: Demo ARPassword: ARPort: 0 Unicode: No [Data Exchange Info] # Defines. Logging: Yes LogPath: C:\Program Files\BMC Software\BMC Atrium Integration Engine\human resources\service\log # Size of the file in bytes. indicating status and other details. how often the engine checks for data # exchanges that have become active or inactive since the last # poll interval. set it to # 60 minutes or greater.cfg is located in: <eie_install_dir>\service\conf\eie. For data exchanges that have become # activated. it creates new threads.cfg In the sample eie. (Yes/No) Can # also be specified on the command line to activate a debug file # prior to the config file being read.cfg file that follows. MaxLogSize: 102400 [Debug] # Max size for debug(. so do not leave the Logging parameter set to # Yes for extended periods.cfg parameters.

if you are not planning to submit event-driven requests to the Integration Engine service. add.00 ConfigInterval: 5 # Defines how many times the data exchange definitions are read # before the engine stops. Indicates the password associated with the login for access to this server. set this parameter to zero so that the Integration Engine service ignores it. the Integration Engine service checks for entries on the Application Pending form requesting an asynchronous transfer of data. If this # parameter is left blank (or set as 0) it will be set to a # default value of 5 minutes. This is for production use. The number of minutes the async thread waits before looking for new async requests. Indicates the name of the AR System server to which this service connects. and delete the requests for the forms and fields it accesses.1. Set to 0 to run the engine without # ending. AsyncInterval: 5 Configuration file parameters Table 5-2 provides an alphabetical list of all the standard configuration parameters used by the Integration Engine service. the value entered for the AR System server is recorded here. are indicated in the description. it processes all requests on the form. ARPassword ARServerName AsyncInterval 90 Administrator’s Guide . It enables you to comment out any line in the configuration file so that the program bypasses the line. Can be used for debugging. The Integration Engine service ignores any unrecognized or misspelled parameters. and can also be modified from the Integration Engine Application console. this field is encrypted. and then checks again after <x> minutes. Table 5-2: Integration Engine service configuration parameters Parameter # ARLogin Description A comment character. This account must be an AR System administrator account so that you can modify. Set to 1 or more to run the # engine for 1 or more passes. The value is specified during installation. During installation. Every <x> minutes. For security.BMC Atrium Integration Engine 7. Indicates the AR System account that the Integration Engine service uses for accessing the server. The default is five minutes. If it finds such entries. ConfigPassCount: 0 # Defines how often the async event queue is read. You can change this parameter to another server name. if any. For better performance. Default values.

A value of 0 results in continuous activity. MaxDebugSize Indicates the maximum size in bytes that the debug file reaches before it closes the current file and copies it to a . ConfigPassCount Number of passes that the Integration Engine service makes looking for active data exchanges.Understanding the configuration file and its parameters Table 5-2: Integration Engine service configuration parameters Parameter ConfigInterval Description Defines.bak version is overwritten. This parameter works with the settings on the Schedule tab of the EIE:DataExchange form. in minutes. The default setting is Yes.bak version is overwritten. “Logging and debugging” for more information. how often the Integration Engine service waits between checking for data exchanges that have become active or inactive since the last poll interval. which is appropriate for debugging. Indicates the maximum size in bytes that the log file reaches before it closes the current file and copies it to a . The default is one pass. The previous . This parameter is useful for testing. “Logging and debugging” to view a list of log file messages. The Integration Engine service creates new threads for active data exchanges and removes the associated threads for data exchanges that have become deactivated. The ConfigInterval parameter determines how often the Integration Engine service checks the status of the data exchanges. See Chapter 6. The default value is 102400.bak version. The settings on the Schedule tab initiate the data exchanges at the interval or time specified. A value of 1440 results in the Integration Engine service checking for activated and deactivated data exchanges once a day. Logging Enables or disables logging of messages to the local log file and to the EIE:Events form. it does not become active again until it is stopped and restarted. See Chapter 6. Enables the Integration Engine service to record details and problems with the Integration Engine service in the eiemain. After the Integration Engine service has completed the designated number of passes. The default value is 102400. Valid values are: Yes (enable logging) No (disable logging) DebugOn The default setting is Yes. The default is five minutes. The previous . MaxLogSize Chapter 5 Running and configuring the Integration Engine service 91 .dbg file.bak version.

the ARPassword parameter appears in plain text in eie. Valid values are: Yes (enable stack trace) No (disable stack trace) The default setting is No. IMPORTANT 92 Administrator’s Guide .cfg.dbg and in every <exchange_name>. increasing the maximum log size).dbg file and in each data exchange debug file. ARPassword. The default value is Yes.1.BMC Atrium Integration Engine 7. rather than being encrypted. This can pose a security risk.00 Table 5-2: Integration Engine service configuration parameters Parameter StackTrace Description Stores a line-by-line account of the activity of the Integration Engine service in the eiemain. ARServerName) The AR System parameters in the configuration file (ARLogin. To change any of these settings (for example.cfg. Use only when necessary as the debug files can become large.cfg by opening it in a text editor and making the necessary changes. Editing the configuration file Most of the parameters in the configuration file are set with default values at installation. If you edit the configuration file with a text editor. You can use the eiecfedit utility to edit the ARPassword parameter while maintaining encryption for your AR System password in eie. and are set based on values that you enter during installation. you can edit these settings using a text editor.dbg file. As with the other configuration file parameters. you can edit eie. TimeStampDebug Adds a timestamp at the beginning of each line in eiemain.

Figure 5-1: Instances Console Chapter 5 Running and configuring the Integration Engine service 93 . click Configuration > Instances.exe -x <arsystem_name> -s <arserver_name> -l <login_name>-p <password> Table 5-3: eiecfedit parameters Parameter -x -s Description Indicates the server name that goes in eie. Indicates the login password for a given login name. Indicates the login name used to login to the AR System server. you can view and edit information about Integration Engine instances. The Instances Console appears.cfg. To modify an Integration Engine instance 1 On the navigation panel. Indicates the server name specified during installation when you are installing multiple instances on different AR System servers.Managing instances To edit and encrypt a password in the configuration file Type the following command on the command line using the parameters in Table 5-3: <eie_install_dir>\service\bin\eiecfedit. -l -p Managing instances In the Instances Console.

4 Click Save.BMC Atrium Integration Engine 7. AIE Version—The version of Integration Engine you are running. Integration Engine uses the character set you specify at the data exchange level.1. 94 Administrator’s Guide . the service is ready to start. type the name you want to see when selecting this instance in other areas of the Integration Engine interface. 5 You can view. but not modify. the remaining instance information: Internal Instance Name—The name created by the installer for this instance Host—The name of the server where Integration Engine is installed Port—The port on which Integration Engine communicates. The default value is 3021. set.00 2 In the Instance Name field. you select whether the instance uses the Unicode character If you select No. 3 In the Unicode field. If this value is Yes. Engine Load—The readiness of the Integration Engine service.

you must also change it in Integration Engine console and the eie.Changing Integration Engine AR System password Changing Integration Engine AR System password If you have changed your password in AR System. type the administrator login name you used for AR System. 3 In the Admin Password field. Using this method keeps the password encrypted. type the administrator password you used for AR 4 Click Save. select Configuration > Integration Engine App.cfg file. System. To change your AR System password on the Integration Engine console 1 From Integration Engine navigation bar. The Integration Engine Application Console appears. Chapter 5 Running and configuring the Integration Engine service 95 . Figure 5-2: Integration Engine Application Console 2 In the Admin Login Name field.

1. This utility helps set the encrypted password in the eie. you must set a library path. NOTE To run this utility on UNIX.cfg file -1 <user name> is the logon name used to log on to the AR System server -p <password> is the user’s password 2 Change the user name and password.cfg file and ensures the utility can be run on UNIX as well.cfg file 1 Run the eiecfedit command line utility located in $AIE_HOME/service/bin. The following prompt appears: usage: -s <AR server(During Installation)> -n <Port Number (During Installation)> -x <AR Server> -l <user name> -p <password> where: -s <AR Server> Server name given during EIE Installation (mandatory) -n <Port Number> Port given during EIE Installation (default 0) -x <AR System> Server name which goes in eie. 96 Administrator’s Guide .00 To change your AR System password in the eie.BMC Atrium Integration Engine 7.

Chapter 6 Logging and debugging You can diagnose errors and verify the completion of data exchanges using the logging and debugging facilities in Integration Engine. The debugging files provide detailed operational information to diagnose errors in a data exchange.cfg file. The logging facility aids in long-term management of data exchanges. The following topics are provided: Log messages (page 98) Debug messages (page 102) Debug logging settings (page 106) Chapter 6 Logging and debugging 97 . You can configure and test data exchanges by using the debug facility. The logging of events is controlled by the logging parameter in the eie.

cfg file are explained in greater detail in Chapter 5.cfg. Provides statistics about the number of records processed for the main mapping of a data exchange. For example. such as data truncated to fit a field. or not transferred due to an error.dll file not in the correct path. The key of the request is provided in the message text. You can use the log message categories to determine what kind of workflow to generate.00 Log messages Log messages record all major events about data exchanges and individual record transfers. Indicates that the adapter could not be used by Integration Engine. Table 6-1: Log message event categories Category Service Status Session Statistics Description Indicates when a data exchange starts and when it ends. Logging is controlled by the Logging parameter in eie. updated.” Log messages are sorted into several event categories. Transfer Error Indicates that a transfer was not made due to a problem. such as a data conversion error. More detailed information about why a record was not transferred is recorded in the debug file (if debugging is activated). “Running and configuring the Integration Engine service. The count includes records added. you might want to write workflow to send notifications based on log message numbers or categories to the individuals in your company who are responsible for managing various parts of the data exchanges. The error message indicates the key of the record that failed and any associated AR System server error messages.1. All log events are recorded both in the Integration Engine log file and the EIE:Log form. Both the Logging parameter and the eie. and so on. Table 6-1 shows the supported log message event categories. This could be the result of an invalid registry entry. Adapter Error 98 Administrator’s Guide . Service Error Transfer Warning Indicates that a transfer was made despite a possible problem. you should also use the log of debug events to assist you in understanding the nature of problems that you encounter and how to correct them. Log messages are useful but provide only broad information about events and errors. For more detailed information. Indicates an error with a data exchange that prevents the data exchange from taking place. Each category has both informational messages and error messages.BMC Atrium Integration Engine 7. a .

cfg. Some messages contain placeholders. is a brief description of what caused the message to appear. Add or correct the entry in eie. %2. These placeholders represent text that is completed during run time. Table 6-2: Log file messages ID Number 3301 Message BMC Remedy Link starting to process requests <%1>. Required configuration parameter is missing — <%1>. and so on. 3311 Chapter 6 Logging and debugging 99 . After rules are defined. No Field Mapping entries defined for VendorApp: <%1>. No requests exist on the Data Field Mapping tab of the EIE:ARMappingInfo form for the Integration Engine service to use. The Integration Engine service ran out of available memory and cannot continue. The Integration Engine service received an error while trying to add a unique identifier to the specified form. An additional error message precedes this error. Next to each message in Table 6-2. The Integration Engine service received an error from the AR System server that was trying to create a request in the specified form. The Integration Engine service does not process requests without field mapping rules defined. The Integration Engine service received an error while trying to process the specified form and request ID. such as %1. field mapping definition ignored. 3306 3307 Failed to create request in form <%1>. 3308 Failed to add request <%1> to form <%2>. Failed to update form <%1> request-id <%2>. 3302 3303 3304 Malloc failed. Verify that the configuration file exists and is accessible. The specified configuration parameter was missing or typed incorrectly. The Integration Engine service ignores this request and continues. indicating which calls to the AR System server failed. The Integration Engine service could not find or open eie. Description The Integration Engine service started a data exchange session at the time indicated.cfg. 3305 No Rules defined for field mapping <%1>. Additional errors precede this one. No rules were defined for the specified field mapping. This is a fatal error.Log messages Table 6-2 lists log messages that you might receive during a data exchange. indicating that a call to the AR System server failed. BMC Remedy Link Terminating <%1>. 3310 Failed to open configuration file <%1>. the Integration Engine service uses this request. An error condition caused the Integration Engine service to terminate at the indicated time.

The Integration Engine service completed setup and will begin a data exchange. Failed to load message DLL — <%1>.1. 3322 No data was returned using field mapping definition <%1> for request <%2>. or create valid rules. service cannot run until it is corrected. A previous message indicates what is wrong.00 Table 6-2: Log file messages ID Number 3312 Message Form <%1> does not exist or is not accessible. the service will try again at its next scheduled time. The Integration Engine service deletes requests that do not have a matching primary form request. Failed to update form <%1> request <%2>. The Integration Engine service could not load the indicated message . Correct the existing requests’ rules. Previous messages indicate what is wrong. Failed to delete request <%1> for form <%2>. starting to process requests. A recoverable error occurred while the Integration Engine service was being set up to process requests. 3319 3320 3321 Could not find the field The Integration Engine service was unable mapping name <%1> for to locate the indicated field mapping name request <%2> in form <%3>. 3317 A fatal setup error A nonrecoverable error occurred while the Integration Engine service was being set occurred. The Integration Engine service could not delete the specified request in the form. up to process requests. in the specified form for the indicated request. Use the respective Mapping Information windows for AR System forms. The specified form is missing one or more required fields. No valid requests exist in the corresponding mapping consoles for AR and CMDB. The Integration Engine service received an error from the AR System server while trying to update the indicated request in the specified form. Indicates that the Integration Engine service completed a data exchange at the indicated time. 3314 3315 3316 One or more required fields are missing from form <%1>. 3323 100 Administrator’s Guide . and relationship classes to create or modify all the field mappings. daemon cannot run. Setup completed successfully. Make sure that the account being used by the Integration Engine service has permission to delete requests. The request will not be updated. CI classes. Description The specified form does not exist or is not accessible. 3318 A setup error occurred.dll file. 3313 No valid field mapping rules are defined. Verify that the form exists and that the login used by the Integration Engine service has permission to create. BMC Remedy Link finished processing requests <%1>.BMC Atrium Integration Engine 7. The Integration Engine service did not receive data from the AR System server for the indicated request. modify. and delete requests.

Adapter <%1>: GetProcAddress() failed. Adapter library failed to load. Failed to initialize adapter object. Please check dependencies. Adapter <%1>: Failed to load adapter <%2>. Adapter <%1>: Failed to initialize adapter: <%2>. Adapter <%1>: Cannot find adapter file at<%2>. 3325 3326 Session <%1> statistics: Requests added: <%2>. Description Indicates that the Integration Engine service does not have a license. and cannot be run. 3327 Session <%1>: Request <%2> error: record ignored due to error. <%3> — Number of external data store keys processed. Failure during adapter close connection and release resources. errors: <%4>. The record was not exchanged for the named session ID tag and the named data key. <%3> — Number of requests updated. Adapter <%1>: Failed to terminate the adapter: <%2>. Vendor requests: <%3>. Unable to get function address in adapter library. <%2> — Number of AR System keys processed. warnings: <%5>. 3328 3329 3330 3331 3332 3333 3334 3336 Chapter 6 Logging and debugging 101 . Session <%1> statistics: AR System requests: <%2>. <%5> — Number of requests updated and added. Adapter <%1>: Failed to open connection to data source: <%2>. Verify that the session ID tag and the data key are correct in the field mapping. but some fields were ignored due to an error.Log messages Table 6-2: Log file messages ID Number 3324 Message BMC Remedy Link does not have a license. Session <%1>: Request <%2> warning: one or more fields not processed. Indicates the following statistics: <%1> — Name of the session ID tag from the EIE:DataExchange form. <%2> — Number of requests added. Indicates the following statistics: <%1> — Name of the session ID tag from the EIE:FieldMapping form. Adapter <%1>: Failed to create adapter object: <%2>. Failure during adapter open connection with data store. updated: <%3>. Please check external data store configuration parameters. Please check adapter installation directory. Adapter is not present at mentioned path. <%4> — Number of requests ignored due to an error. The fields were not processed for the named session ID tag and the named data key. Verify that the session ID tag and the data key are correct in the field mapping. Failed to allocate memory for adapter object.

engine exit.dbg debug file When you start the Integration Engine service. engine exit. Using the <instance name>_eiemain. high-level debug file that records details and problems with Integration Engine service. Integration Engine generates two types of debug files: <instance_name>_eiemain. the Integration Engine service creates a unique debug file for it.1. 3339 3340 Debug messages Debug messages help you detect errors and events in the data exchange process. <exchange_name>. depending on whether you specify the debug startup parameters on the command line. 102 Administrator’s Guide .dbg After each data exchange starts.dbg.BMC Atrium Integration Engine 7. Adapter cannot obtain a license as the maximum number of exchanges for a Demo license has exceeded. you have the option of running it with debugging enabled or not. %s adapter cannot obtain a license as the maximum number of exchange for a Demo license has exceeded.dbg file is a special.dbg file is not created. the Integration Engine service creates the <instance name>_eiemain. The data exchange is activated with improper configuration.dbg The eiemain. It does not record events that occur for individual data exchanges. Active event request without a configured data exchange. If you specify the debug startup parameters. useful diagnostic information about the initialization errors is not recorded. Description Another Integration Engine process is running on this machine. Data exchanges using that adapter cannot run. Debug files created to record debug events for individual data exchanges follow this naming convention: <exchange_name>. If the <instance name>_eiemain. Data exchange: <%1>.00 Table 6-2: Log file messages ID Number 3337 Message There is another Atrium Integration Engine process running on this machine.dbg file on startup.

the debug file will have the name GetDiskDetail.dbg file is created. and event requests. or relationship classes. Adapter Version: 7.dbg debug file For detailed information about the problems that occur in specific data exchanges. the <instance name>_eiemain. The debug file also indicates on which tabs of the forms these rules are entered. For example. the debug file names are getdiskdetail_1.cfg. EIE:CMDBDataMapping.dbg file records high-level information about data exchanges found. Chapter 6 Logging and debugging 103 .1. You should consult <instance name>_eiemain. the Integration Engine service creates a unique debug file for it.Debug messages In addition to startup information. or if an event request fails to run.00 Thread started to manage exchange: SamplePullExchange_2 Starting threads to manage event driven requests Immediate async thread started. Event Request cleanup thread started. assigning it the name of the data exchange. NOTE EIE:DataMapping. if the data exchange is named GetDiskDetail. CI classes. Using the example in the previous paragraph. NOTE Only one <instance name>_eiemain. Each data exchange debug file provides a list of all rules entered in the Data Exchange application in the order that they are entered on the respective Mapping Information window for AR System forms.dbg. if two concurrent data exchanges are configured. You cannot interact directly with these forms.dbg debug file is created regardless of how many data exchanges are configured. licenses absent. and EIE:CMDBRelMapping are backend forms used to store information.dbg. If you enable the logging of debug events.dbg if your data exchange fails to start and no <exchange_name>. NOTE If you configure multiple concurrent data exchanges on the Main tab of the EIE:DataExchange. Using an <exchange_name>. when a data exchange starts. Waiting for 5 minutes to look for changes to data exchange definitions.dbg and getdiskdetail_2. The following text is an example of <instance name>_eiemain.dbg: Starting to look for changes to data exchange definitions Service has detected 1 active data exchanges on AR System Location of 'FlatFile' adapter obtained License granded to FlatFile. licenses issued. you should enable the log of debug events in eie. the Integration Engine service debug files are assigned the name of the data exchange with a sequence number appended to it.

104 Administrator’s Guide .00 Each data exchange debug file records events as they take place when a data exchange is run. created. the debug file shows all rules retrieved from the Data Exchange application and the page of the respective Mapping Information window for AR System forms. or deleted Errors or warnings Initialization phase During the initialization phase.BMC Atrium Integration Engine 7. and the data type of the data defined by the rule. >>>Vendor Rules: Field mappings in: 'FlatFileSamplePull' Rule 1: <FNAME> Set to data type: 4 (Character) Rule 2: <SALARY> Set to data type: 3 (Real) Rule 3: <GENDER> Set to data type: 2 (Integer) >>>Vendor Keys: Key Rule 1: <LNAME> Set to data type: 4 (Character) >>>Vendor Query: No query defined: All entries will be processed.1. Events recorded are: Data retrieved Any values generated by rule syntax Data conversions performed Data updated. or relationship classes from which it was retrieved. CI classes. StopDataHandlers: Disconnected from both AR/CMDB and Vendor applications Processing phase During the processing phase. All entries will be processed. StartDataHandlers: Connection established to both AR/CMDB and vendor >>>ARS Form Fields: Field mappings in: 'FlatFileSamplePull' Rule 1: <First Name (id: 536870914)> Set to data type: 4 (Character) Rule 2: <Salary (id: 536870916)> Set to data type: 3 (Real) Rule 3: <Gender (id: 536870917)> Set to data type: 6 (Enum) >>>ARS Form Key Fields: Key Rule 1: <Last Name (id: 536870913)> Set to data type: 4 (Character) >>>ARS System Query: No query defined. the Integration Engine debug facilities record all data exchange and data handling rules.

Number of AR System Keys obtained 0. When a data exchange stops. Value: '0' Key Rule 1: 'LNAME'. Value: 'Tom' Rule 2: 'SALARY'. errors: 0. Value: '1' Key Rule 1: 'LNAME'. Value: 'Poulos' Setting field values of Target for mappings 'FlatFileSamplePull' Rule 1: <First Name (id: 536870914)> set to 'Mary' Rule 2: <Salary (id: 536870916)> set to '135' Rule 3: <Gender (id: 536870917)> set to '1' Key Rule 1: <Last Name (id: 536870913)> set to 'Poulos' Adding entry Poulos to form 'EIE:FlatFileSample' Data obtained from Source for mappings: 'FlatFileSamplePull' Rule 1: 'FNAME'. If any Integration Engine service or AR System errors occur. Start comparing list of records on Mon Jul 02 16:29:21 2007 SessionID=SamplePullExchange direction=VendorDataIntoAR updateType=Both New and Changed AR System Data Server Data obtained from Source for mappings: 'FlatFileSamplePull' Rule 1: 'FNAME'. Value: '234' Rule 3: 'GENDER'. deleted: 0. When a data exchange starts. only the statistics for the main mapping are recorded in the debug file. the Integration Engine service debug file shows a detailed error message. the <exchange_name>.dbg file records the number of records obtained from each data store. Value: 'Mary' Rule 2: 'SALARY'. Value: '135' Rule 3: 'GENDER'. Statistics for other data mappings are not recorded. Chapter 6 Logging and debugging 105 . Number of Vendor Keys obtained 0. Vendor requests: 5 Session statistics: Requests added: 5.dbg file shows statistics of the number of records actually transferred. the <exchange_name>. warning Sleep until next poll interval or scheduled time for data transfer StopDataHandlers: Disconnected from both AR/CMDB and Vendor application. Value: 'Smith' Setting field values of Target for mappings 'FlatFileSamplePull' Rule 1: <First Name (id: 536870914)> set to 'Tom' Rule 2: <Salary (id: 536870916)> set to '234' Rule 3: <Gender (id: 536870917)> set to '0' Key Rule 1: <Last Name (id: 536870913)> set to 'Smith' Adding entry Smith to form 'EIE:FlatFileSample' Final Statistics The Integration Engine service debug file also lists statistics. updated: 0. Session statistics: AR requests: 0. For each data exchange.Debug messages The debug file identifies the success or failure of the data transfer.

5 In the Max Debug Size field. NOTE The log file size cannot be set to less than 4096 because that could be the length of a single log line. overwriting the old information.bak file. To enable debug logging 1 On the Data Exchanges Information window. 4 In the Debug File Creation area. then the log is written to the default debug path you specified during installation of Integration Engine. New information is appended to the existing file or is wrapped to the top of the file. 3 In the Debug File Path. type the maximum size (in bytes) for the log file. click Yes. depending upon the Log-File Creation settings either the backup file is created or the new information wraps to the top of the file. click the Advance Settings tab.BMC Atrium Integration Engine 7.00 Debug logging settings From the Data Exchanges Information window. do one of the following: Click Create Backup to create new log files and write the contents of the previous log files to the <DataExchangeName>_<TimeStamp>.1. Click Append To Existing to preserve the log files and their contents. Figure 6-1: Debug Settings window--Advance Settings tab 2 In the Enable Debug Logging field. The Debug Settings window appears. browse to select the location of the debug files. When the log file reaches the maximum limit. you can now log various levels of debug information. 106 Administrator’s Guide . If the Debug File Path field is blank and you have clicked Yes to enable debug logging.

or deleted. select any of the the check boxes to do the following: API Calls—Logs information about all API calls made by Integration Engine. Record Summary—Logs summary information for each record. or deleted. how it is getting converted to the Destination field after applying any rules. updated. 7 In the Debug Level area. click Yes to create thread-based log files. Information can include the value for each Source field. including a time stamp. and whether the record is getting successfully added.dbg. 9 Click Save.Debug logging settings 6 In the Enable Thread Based Logging field. updated. Information is logged for each SQL command issued. The name of the log file would be formatted as follows: <DataExchangeName>_T<ThreadNumber>. Summary information includes whether the record is getting added. Chapter 6 Logging and debugging 107 . Details are provided at the field level. Information is logged on entry and exit of every API call. updated. 8 Click Apply To All Exchanges. SQL Statements—Logs SQL commands sent to the database. Record Details—Logs detailed level information for each record. or deleted and then if it was successfully added. The Debug settings are applied to all other Exchanges which are in the Active state.

1.BMC Atrium Integration Engine 7.00 108 Administrator’s Guide .

Chapter 7 Troubleshooting Integration Engine Troubleshooting information can help you diagnose problems that you might encounter when running the Integration Engine service and configuring data exchanges and data mappings. The following topics are provided: Running the Integration Engine service (page 110) Troubleshooting data exchanges (page 111) Export exchange and mapping configuration (page 112) Handling data types (page 114) Using date functions in AR System Date/Time fields (page 114) Using character string comparisons (page 115) Determining if a record has an out-of-range error (page 115) Stopping the AR System server accidentally when stopping the Integration Engine service on UNIX (page 115) Adding missing items in the AR System field drop-down lists (page 116) Chapter 7 Troubleshooting Integration Engine 109 .

Are 8-bit characters used in the external data store user name and password? You must use only 8-bit characters in English strings. To estimate memory if transferring records for the first time Number of data keys per exchange * 1.000 records in your external data store: 3 * 1. Are your field mappings correct? TIP Please verify that Data Exchange can be used to validate the data exchange configuration and field mappings. before you execute exchange. make sure your system has adequate memory. “Estimating memory usage when running a data exchange” on page 110. it might fail if it is not configured correctly. then all other adapter license checks are bypassed.00 Running the Integration Engine service The first time you run the Integration Engine service. But if either of these licenses are not present. Did you enter the correct external data store connection information? Did you enter the correct AR System user name and password? Do you have enough memory? For information about estimating memory usage.2 KB * 10.BMC Atrium Integration Engine 7. Estimating memory usage when running a data exchange Before you activate your data exchange.000 = 36000 KB or 36 MB 110 Administrator’s Guide .2 KB * Number of records in vendor data For example. see the next section. Ask yourself the following questions: Did you set the data exchange to run in debug mode so that it would generate a debug file? Was the debug file created? If not. you have three data keys in your exchange and 10. These formulas are guidelines only. then the Integration Engine service will check for an adapter-specific license (RLS and RLO) and will work accordingly. did you disable debugging by selecting “No” for the Enable Debug Logging option on the Advance Settings tab of the Data Exchange Information window? Did you license Integration Engine? If you have a license for Enterprise Integration Engine or BMC Atrium Integration Engine.1.

000 records in your AR System target form: (3 x 1. Have you accidentally selected any <system generated > numbered fields for your data mappings? When set to Yes.000) = 49200 KB or 49. such as 0001-001-AA-01.2 KB * Number of records in vendor data + Number of records in AR target form For example.000 records in your external data store. some fields on this page generate a drop-down list. you have three data keys in your exchange. unused. 10. the following options on the corresponding console forms for AR generate a numbered field when you select <system generated> from the drop-down list: Maintain Change History for Fields Update Record Only if Checksum for Mapped Field Has Changed NOTE Chapter 7 Troubleshooting Integration Engine 111 .2 KB * 11. or you receive error messages. and Integration Engine core fields? Are you using the correct data key. Are default values set for required. You must use EIE:MappingInfo where the Primary Key tab can be referred.2 KB * 10. Did you make sure that the fields you selected on the Options tab of the of the respective mapping console for AR.2 MB Troubleshooting data exchanges If your data exchange does not run. CMDB and Relationship data exchange? EIE:DataMapping and EIE:CMDBDataMapping are backend forms used to store data. and 11. the size of that field must be at least the size of the largest possible value. in Integration Engine. which is specified on the Primary Key Mapping tab of the respective mapping console for AR.000) + (1. CMDB and Relationship data exchange are being added to your AR System data forms as expected? When you select Yes for the fields on the Options tab.Troubleshooting data exchanges To estimate memory if updating records Number of data keys per exchange * 1. if a field is created to hold the contents of a functional location number. ask yourself the following questions: Are data field sizes large enough to accommodate the data? For example.

BMC Atrium Integration Engine 7.arx) file which contains data from the following forms: EIE:ApplicationPending EIE:ApplicationSettings EIE:BackUpLoadFlag EIE:CMDBDataMapping EIE:CMDBRelationshipData EIE:CMDBRelMapping EIE:Data EIE:DataExchange EIE:DataExgLookup EIE:DataMapping EIE:RelContainerHolder EIE:Trigger_DE EIE:VendorParamLookup EIE:VendorConfiguration 112 Administrator’s Guide .1.00 Export exchange and mapping configuration You no longer need to back up your data for exchange and manually map to find the root cause of an issue. You can now export the configuration into a text (.

AIE. The Export Configuration Utility window appears. type the valid directory path. Relationship Class Mappings. D:\. Figure 7-2: Export Configuration Utility window 3 In the Output Directory field. and AR System Form Mappings. 4 Click Export. click the Integration Objects drop-down menu and select Data Exchanges.Export exchange and mapping configuration To export exchange and mapping configuration 1 On the Integration Engine console. For example.arx AIE_Configuration. contains configuration information of all data exchanges as well as mappings. NOTE The AIE menu is not available for the other integration objects consoles: CI Class Mappings. A new menu item.arx is created in the directory path you specified. Chapter 7 Troubleshooting Integration Engine 113 . Figure 7-1: Export Configuration menu item 2 Choose AIE > Export Configuration. AIE_Configuration. appears on the menu bar.

and yyyymmdd Using date functions in AR System Date/Time fields When date information is mapped to an AR System Date/Time field. if the decimal value is 5. which includes both the date and the time. If it is a valid AR System date.00 Handling data types Decimal values brought into an integer field lose their decimal positions. use the following function: currenttime() You can also use Date/Time fields in an update query to compare attributes in the external data store and AR System or CI classes as dates rather than as internal values. the AR System attempts to convert the date information into an AR System Date/ Time value. use the round() function. Some Integration Engine functions return partial date information. To round a value. 114 Administrator’s Guide . the date transfers correctly.mm. If you are using an AR System Date/Time field for date values exchanged with the data store. The AR System Date/Time field holds dates from 1/1/1970 to mm/dd/2036. use the following function: currentdate() returns mm/dd/yy returns hh:mm:ss To return the time only. When the Integration Engine service encounters a date type field with a string value. see the date format information in Table 7-1. it is rounded to an integer value of 5. it attempts to treat it as an AR System date.9. dd. The string value can be any of the AR System supported date formats.4 or less.BMC Atrium Integration Engine 7. In this case. Table 7-1: Date formats Date Within AR System Date Limits? Yes No Allowed Date Formats Required AR System Field Type Char only Any of the AR System date formats Date/Time or Char mm/dd/yyyy. To make sure that dates transfer correctly.1. you must use an AR System Character field.5 to 5. it is rounded to an integer value of 6. If it is 5.yyyy. To return a date only.

suppose you had an attribute in your external data store called DATETIME and an attribute in a CI class called DateTime. In other words. Determining if a record has an out-of-range error The AR System server workflow allows you to put a range limit on certain fields. when character string comparisons are run. then Integration Engine replaces the DATETIME attribute with a value and passes the query to the target to qualify the update operation on a record-by-record basis. which does not match the 0000000011 in the external data store. If you define the update query in a CI class data mapping as g. a external data store might add zeroes to a character field. the Integration Engine service assumes that 0000000011 is 11. you must not map a character field in the external data store as a number field in the AR System. the AR System server is stopped. AR System searches for 11. if the value in the source for an enumerated field is out of range. Using character string comparisons In some cases. Integration Engine cannot transfer a particular record when one of the mapped fields contains an out-of-range error.Using character string comparisons For example. In this case.fatal error encountered Chapter 7 Troubleshooting Integration Engine 115 . For example. and the system displays the following error message when you enter the command (Ctrl+C) to stop the Integration Engine service: 390600: Another copy of the server is already running on the same RPC socket 390600: AR System server terminated -. When an external character field that pads numbers is used as a key field. the entire record fails during the transfer. In this case. and it cannot be left empty. the AR System cannot locate it. If this occurs. any record that satisfies the qualifer will be updated in the target. Stopping the AR System server accidentally when stopping the Integration Engine service on UNIX If you use the same terminal window to start the AR System server as you do to start and stop the Integration Engine service. Integration Engine cannot transfer the data for the other fields and ignores the enumerated field because an enumerated field always has a default choice (unknown to Integration Engine).

temporary fields and names with symbols that affect the data exchange process do not appear in the menu lists for AR System fields. Precedence rules use curly brackets ({}) to delimit a single rule in a precedence sequence. (NOT ( 'Field Name' LIKE "%}%" )) 116 Administrator’s Guide . NOTE Integration Engine should not map or populate these fields. However. you might need to remove this restriction to expose fields that are needed in a field mapping. If you do not follow this convention. when you want to stop the Integration Engine service. Start and run the Integration Engine service in the background by typing: . however. type: . Table 7-2: Drop-down list restrictions Restriction (NOT ( 'Field Name' LIKE "zTmp%" )) Description Integration Engine has a naming convention for temporary fields that are used for workflow processing./eie001start <parameters> Then.00 There are two solutions: Use different terminal windows to start the AR System server and Integration Engine service. be mapped to populate other fields not related to Integration Engine. Fields starting with zTmp are considered working variables on the form and should not be used in a data mapping because their content is not fixed. One of the rules allowed in a data mapping is a precedence rule.1. They can./eie001 is a script associated with a particular instance./eie001stop NOTE . Adding missing items in the AR System field drop-down lists By design. you can remove some of these restrictions.BMC Atrium Integration Engine 7. This restriction prevents fields with brackets from appearing in the dropdown list.

(NOT ( 'Field Name' LIKE "%. This restriction prevents any fields with commas from appearing in the drop-down list. However.%" )) Chapter 7 Troubleshooting Integration Engine 117 . Field names cannot have embedded commas. This restriction prevents any fields with the pipe from appearing in the drop-down list. a field name with a comma cannot be used in a function.Adding missing items in the AR System field drop-down lists Table 7-2: Drop-down list restrictions Restriction (NOT ( 'Field Name' LIKE "%|%" )) Description Several rules used in a data mapping use the syntax <category>|<value>. The pipe terminates the category and starts the actual value that is supplied by the rule. If this restriction is removed. The category represents the category of a rule (such as function or constant). a field name with a comma can be used in other rule formats. If this restriction is removed. the field name preceding the pipe must not be a keyword.

BMC Atrium Integration Engine 7.1.00 118 Administrator’s Guide .

contacting 2 A Adapter Development Kit interface 19 adapter licenses 19 adapter rule helper utility DB2 60 file 69 Oracle 62 SQL 64 using 59 XML 69 adding restricted items in AR System field drop-down lists 116 AR System adding missing items to field menus 116 adding restricted drop-down list items 116 API documentation 19 date formats 114 date functions 114 query syntax 55–57 range limits on fields 115 removing menu restrictions 116 stopping server when stopping Integration Engine service 115 ARLogin parameter 90 ARPassword parameter 90 ARServerName parameter 90 AsyncInterval parameter 90 audience for this book 9 C character string comparisons 115 command-line parameter 86 ConfigInterval parameter 91 ConfigPassCount parameter 91 configuration file editing 92 location 89 parameters 90 sample file 89 constant syntax 46. estimating 110 running on UNIX 87 data key queries 57–59 data mappings defining queries 55–59 data transfer. direction of 16 data types. handling 114 date formats 114 Index 119 . 47 customer support 3 D Data Exchange application 18 data exchange debug files overview 102 statistics 105 timestamp 92 data exchange definitions importing and exporting 112 data exchanges definitions 18 memory usage.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Index Symbols # parameter 90 $field$ option for AR System query syntax 56 B Best Practice icon 10 BMC Atrium Integration Engine installation overview 26 introduction to 16 BMC Software.

adding restricted AR System fields 116 Event Request interface activating requests through workflow 83 definition of 19 invoking requests through eiexfer 78–83 exporting data exchange definitions 112 F field option for data key query syntax 57 formats for dates 114 function syntax AR System queries 57 rules 46. installing on Windows 39 I icons Best Practice 10 New 10 importing data exchange definitions 112 initialization phase 104 overview 20 installation log error 116 installing criteria for installing components 26 installation prerequisites for UNIX 28 for Windows 28 Windows online help system 39 integer fields 114 Integration Engine service 18 command-line parameter 86 debug file (eiemain. 48–52 H handling data types 114 help.dbg) disabling 91 enabling 91 overview 102 parameters 91 timestamp 92 using 102–103 rule syntax 46–54 running on UNIX from a command line 87 stopping without disrupting AR System server 115 E eie.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z date functions in AR System 114 debugging data exchange debug files overview 102 statistics 105 timestamp 92 Integration Engine service debug file (eiemain.dbg) disabling 91 enabling 91 overview 102 parameters 91 timestamp 92 using 102–103 maximum debug file size 91 DebugOn parameter 91 decimal values in integer fields 114 defining queries 55–59 rules 46–54 direction of data transfer 16 disabling debugging 91 logging 91 drop-down list items.dbg file overview 102 parameters 91 timestamp 92 using 102–103 eiexfer utility command syntax examples 80 completion code messages 81 completion codes returned by 81 definition of 19 enabling debugging 91 logging 91 error messages of log files 99 120 Administrator’s Guide .cfg file editing 92 location 89 parameters 90 sample file 89 eiemain.

98 MaxDebugSize 91 MaxLogSize 91 StackTrace 92 . 104 product support 3 Q queries. 52 stmt command syntax 54 target process command syntax 46.cfg # (pound sign) 90 ARLogin 90 ARPassword 90 ARServerName 90 AsyncInterval 90 ConfigInterval 91 ConfigPassCount 91 DebugOn 91 logging 91. 98 parameters (continued) eie. 54 process command syntax 46. overview 98 logging parameter 91.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z K KEY syntax for data key queries 58 KEYLIST syntax for data key queries 58–59 L licenses adapter 19 log files disabling 91 enabling 91 maximum size 91 log messages. 54 Index 121 P parameters command line 86 debug file 91 debug timestamp 92 eie. 53 processing phase 21. 48–52 precedence syntax 46. 47. defining 55–59 query syntax AR System syntax $field$ option 56 function syntax 57 syntax statement 55 value option 56 data key syntax field option 57 KEY syntax 58 KEYLIST syntax 58–59 value option 58 row-level syntax SRC syntax 59 M MaxDebugSize parameter 91 maximum file size debug 91 log 91 MaxLogSize parameter 91 N New icon 10 O out-of-range error 115 R range limits on fields 115 records not transferred during exchange 115 row-level queries 59 rule helper utility DB2 60 file 69 Oracle 62 SQL 64 using 59 XML 69 rules constant syntax 46.cfg TimeStampDebug 92 populating SQL field information 66 precedence syntax 46. 47. 54 prerequisites for installing BMC Atrium Integration Engine on UNIX 28 on Windows 28 process command syntax 46. 53 SQL command syntax 46. 47 defining 46–54 function syntax 46.

populating 66 SRC syntax for row-level queries 59 StackTrace parameter 92 stmt command syntax 54 support. customer 3 syntax ($KEYLIST$) 58 syntax statement for AR System queries 55 T target process command syntax 46. 54 target SQL command syntax 46. 53 technical support 3 timestamp parameters for debug files 92 TimeStampDebug parameter 92 U UNIX installation prerequisites 28 running the Integration Engine service from a command line 87 untransferred records 115 utilities adapter rule helper 59 V value option AR System query syntax 56 data key query syntax 58 vendor rules 46 W Windows installation prerequisites 28 installing online help system 39 122 Administrator’s Guide .A B C D E F G H I J K L M N O P Q R S T U V W X Y Z rules (continued) target SQL command syntax 46. 52 SQL field information. 53 vendor rules 46 running the Integration service on UNIX from a command line 87 S security 92 source syntax 59 SQL command syntax 46.

.

*69247* *69247* *69247* *69247* *69247* .