IBM WebSphere Business Integration Adapter User manual

IBM WebSphere Business Integration Adapters
Adapter for i2 User Guide
Adapter Version 1.0.x


IBM WebSphere Business Integration Adapters
Adapter for i2 User Guide
Adapter Version 1.0.x


Note!
Before using this information and the product it supports, read the information in Appendix D, “Notices”, on page 77.
18April2003
This edition of this document applies to IBM WebSphere InterChange Server, version 4.2, WebSphere Business
Integration Adapters, version 2.2.0, and to all subsequent releases and modification until otherwise indicated in new
editions.
To send us your comments about this document, email [email protected]. We look forward to hearing
from you.
When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any
way it believes appropriate without incurring any obligation to you.
© Copyright International Business Machines Corporation 2002, 2003. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.

Integration broker compatibility
Supported on IBM WebSphere Business Integration Adapter Framework versions
2.2.0, IBM WebSphere InterChange Server versions 4.1.1 and 4.2, WebSphere MQ
Integrator version 2.1.0, and WebSphere MQ Integrator Broker, version 2.1.0.
See Release Notes for any exceptions.
© Copyright IBM Corp. 2002, 2003 iii

iv Adapter for i2 User Guide

Contents
Integration broker compatibility .........................iii
About this document .............................vii
Audience ....................................vii
Related documents .................................vii
Typographic conventions ...............................vii
Chapter 1. Overview of the connector .......................1
Connector architecture ................................1
How the connector works ...............................3
Chapter 2. Installing and configuring the connector .................7
Prerequisites for installing the connector ..........................7
Installing the connector on a Windows or UNIX system .....................7
Configuring the connector ...............................8
Starting the connector ................................10
Chapter 3. Understanding business objects for the connector ............11
Defining connector metadata .............................11
Overview of business object structure...........................11
i2 business object structure ..............................12
Specifying business object attribute properties ........................14
Identifying business object application-specific information ...................15
Chapter 4. Generating business objects using i2 ODA ...............17
Overview of i2 ODA ................................17
Installing i2 ODA .................................17
Using i2 ODA in Business Object Designer .........................19
Create the metaobject for polling ............................25
Chapter 5. Troubleshooting and error handling ..................27
Logging error messages ...............................27
Tracing messages .................................30
Tips for troubleshooting ...............................31
Appendix A. Standard configuration properties for connectors ...........33
New and deleted properties ..............................33
Configuring standard connector properties for WebSphere InterChange Server .............34
Configuring standard connector properties for WebSphere MQ Integrator ..............46
Appendix B. Connector Configurator .......................55
Using Connector Configurator in an internationalized environment.................55
Starting Connector Configurator ............................56
Choosing your broker ................................57
Using a connector-specific property template ........................58
Using Connector Configurator with ICS as the broker .....................61
Setting the configuration file properties (ICS) ........................63
Setting the configuration file properties (WebSphere MQ Integrator Broker) ..............68
Using standard and connector-specific properties with Connector Configurator.............71
Completing the configuration .............................72
Appendix C. Connector feature list .......................73
Event notification features ..............................73
© Copyright IBM Corp. 2002, 2003 v

Service call request handling features...........................73
General features ..................................74
Appendix D. Notices ..............................77
Programming interface information ...........................78
Trademarks and service marks .............................78
vi Adapter for i2 User Guide

About this document
IBM(R) WebSphere(R) Business Integration Adapters supply integration
connectivity for leading e-business technologies and enterprise applications.This
document describes the installation, configuration, and business object
development for the adapter for i2..
This document describes the installation, configuration, troubleshooting, and
business object development for the connector component of the IBM WebSphere
Business Integration Adapter for i2.
Audience
This document is for consultants, developers, and system administrators who use
the connector at customer sites.
Related documents
The complete set of documentation available with this product describes the
features and components common to all WebSphere Business Integration Adapter
installations, and includes reference material on specific components.
To access the documentation, go to the directory where you installed the product
and open the documentation subdirectory. If a welcome.html file is present, open it
for hyperlinked access to all documentation. If no documentation is present, you
can install it or read it directly online at one of the following sites:
vIf you are using WebSphere MQIntegrator as your integration broker:
http://www.ibm.com/websphere/integration/wbiadapters/infocenter
vIf you are using InterChange Server as your integration broker:
http://www.ibm.com/websphere/integration/wicserver/infocenter
The documentation set consists primarily of Portable Document Format (PDF) files,
with some additional files in HTML format. To read it, you need an HTML
browser such as Netscape Navigator or Internet Explorer, and Adobe Acrobat
Reader 4.0.5 or higher. For the latest version of Adobe Acrobat Reader for your
platform, go to the Adobe website (www.adobe.com).
Typographic conventions
This document uses the following conventions:
courier font Indicates a literal value, such as a command name, file
name, information that you type, or information that the
system prints on the screen.
italic, italic Indicates a new term the first time that it appears, a variable
name, or a cross-reference.
blue text Blue text, which is visible only when you view the manual
online, indicates a cross-reference hyperlink. Click any blue
text to jump to the object of the reference.
{} In a syntax line, curly braces surround a set of options from
which you must choose one and only one.
© Copyright IBM Corp. 2002, 2003 vii

|In a syntax line, a pipe separates a set of options from which
you must choose one and only one.
[] In a syntax line, square brackets surround an optional
parameter.
... In a syntax line, ellipses indicate a repetition of the previous
parameter. For example, option[,...] means that you can
enter multiple, comma-separated options.
<> Angle brackets surround individual elements of a name to
distinguish them from each other, as in
<server_name><connector_name>tmp.log.
/, \ In this document, backslashes (\) are used as the convention
for directory paths. For UNIX installations, substitute slashes
(/) for backslashes. All product pathnames are relative to the
directory where the connector for i2 is installed on your
system.
%text%and $text Text within percent (%) signs indicates the value of the
Windows text system variable or user variable. The
equivalent notation in a UNIX environment is $text,
indicating the value of the text UNIX environment variable.
viii Adapter for i2 User Guide