IBM WebSphere Business Integration Adapter - Manual

Contents Integration broker compatibility . . . . . . . . . . . . . . . . . . . . . . . . . iii About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Related documents . . . . . . . . . ....

About this document IBM(R) WebSphere(R) Business Integration Adapters supply integrationconnectivity for leading e-business technologies and enterprise applications.Thisdocument describes the installation, configuration, and business objectdevelopment for the adapter for i2.. This document describes...

| In a syntax line, a pipe separates a set of options from whichyou must choose one and only one. [ ] In a syntax line, square brackets surround an optionalparameter. ... In a syntax line, ellipses indicate a repetition of the previousparameter. For example, option[,...] means that you can enter mul...

Chapter 1. Overview of the connector This chapter describes the connector component of the IBM WebSphere BusinessIntegration Adapter for i2 and the relevant business integration systemarchitecture. The i2 connector integrates with i2 application modules through i2’s CommonIntegration Services (CIS) ...

Component Description CIS server Integration container which handles operation invocations. Integrationcontainer and CIS server are used interchangeably in this document. How the connector works The i2 connector is a CIS (Common Integration Services) client. It connects to theCIS client API in a non...

Status updates No status updates are made to the i2 applications. Typically, the event status, forexample, SUCCESS, FAIL, UNSUBSCRIBED, is written to the application’s eventstore. Since no event store is maintained for i2, the status update strategy is notrelevant for the i2 connector. Error message...

metaobject (MO_Instance) and the input and output business objects as itschildren. The verb for the wrapper business object must be a valid operation forthe specified instance. The information about the child business object, whether it is an input or outputtype, is obtained from the Application Spe...

Chapter 2. Installing and configuring the connector This chapter describes how to install and configure the connector component ofIBM WebSphere Business Integration Adapter for i2 and how to configureapplications to work with the connector. It contains the following sections: v “Prerequisites for in...

v Run the Installer utility for IBM WebSphere Business Integration Adapters fromthe product CD and select the IBM WebSphere Business Integration Adapter fori2.The utility allows you to browse and select the directory into which it willinstall the connector subdirectories and files. You must install ...

Tip: Access this tool from the System Manager. v Connector Configurator--if WebSphere MQIntegrator is the integration broker Tip: Access this tool from the IBM WebSphere Business Integration Adapter program folder. For more information about Connector Configurator, see Appendix B,“Connector Configur...

Property Description Possible values ApplicationUserName User name for the i2 connection Not used in this release ApplicationPassword Password for the i2 connection Not used in this release CISAgentHostName Used when the CIS agent is running ona remote machine. If it is not set, thecurrent local hos...

Chapter 3. Understanding business objects for the connector This chapter describes the structure of i2 business objects, how the connectorprocesses the business objects, and the assumptions the connector makes aboutthem. Use this information as a guide to modifying existing business objects for i2or...

objects. A hierarchical business object contains both simple attributes and childbusiness objects or arrays of child business objects that contain the values. A cardinality 1 container object, or single-cardinality relationship, occurs when anattribute in a parent business object contains a single c...

v The operation is set as the verb on the wrapper business object and is associated with a port. i2 does not have standard verbs. If multiple operations have thesame set of input and output types, but are supported on different ports, therewill be two different wrapper business objects for the diffe...

I2MO_AddBid InstanceId=CA_InstanceWrapperBOName=IBM_Bidding_BO Verb=Dummy Specifying business object attribute properties The i2 connector has various properties that you can set on its business objectattributes. This section describes how the connector interprets several of theseproperties and desc...

Attribute Description AppSpecInfo For information on this property, see “Identifying business objectapplication-specific information” on page 15, Cardinality For relationship details between XML elements and cardinality, seeChapter 3, ″ XML data handler, ″ in IBM WebSphere Business Integration Adapt...

Chapter 4. Generating business objects using i2 ODA This chapter describes i2 ODA, an object discovery agent (ODA), which, workingwith XML schema ODA, generates business objects for the IBM WebSphereBusiness Integration Adapter for i2. This chapter contains the following sections: v “Overview of i2 ...

v ODA\i2\start_i2ODA.bat (Windows only) v ODA/i2/start_i2ODA.sh (UNIX only) Notes: 1. Except as otherwise noted, this document uses backslashes (\) as theconvention for directory paths. For UNIX installations, substitute slashes (/) forbackslashes. 2. All product path names are relative to the direc...

Working with error and trace message files Error and trace message files (the default is i2ODAAgent.txt ) are located in \ODA\messages\ , which is under the product directory. These files use the following naming convention: AgentName Agent.txt Example: If the AGENTNAME variable specifies i2ODA1 , t...

5. Complete the business object and generate the business objects for the types. 6. Save the business object files. Details for each step follow. Steps for using i2ODA Before you begin: You need to start the i2 Business Object Designer wizard. 1. Open Business Object Designer. 2. From the File menu,...

Metadata (Top tree node) (Expanding Metadata lists all the port types) PortType1(Child tree nodes) Operation1 Input type Output type Operation..n Input type Output type PortType2 Operation Input type v Select the port, operation, and type for generating the business object. Eachoperation has an inpu...

The following diagram shows the business object that the XML schemaODA generates for i2_order.xsd. The XML data handler uses thecombination of the element next to CISDocument and BOPrefix to get thebusiness object name. SystemId OrderId I2BO_CISDocument_Order I2BO_TLO_CISDocument_Order (1 card) XMLD...

Create the metaobject for polling Once the business objects are created, you need to create the metaobjects forpolling using the CSM. These objects shall have the i2MO prefix followed by theoperation. The attributes need to have a default value. This information is usedduring polling to register the...

Chapter 5. Troubleshooting and error handling This chapter describes how the i2 connector for i2. handles errors. The connectorgenerates logging and tracing messages. The chapter contains the followingsections: v “Logging error messages” on page 27 v “Tracing messages” on page 30 v “Tips for trouble...

Polling-related error messages The following table describes polling-related error messages. These are logged inthe i2 Adapter log file. Notes: 1. In some cases, the connector logs a fatal error (log message type ofXRD_FATAL) so that e-mail notification can be triggered. For logging this errorwith t...

Error description Error type Handling by i2 connector Fail to convert XML messageto IBM business object Error The error that the XML message has asyntax error is logged for the message,The XML message gets dumped to thelog file, and the processing continuesfor other messages. Any error when posting ...

Error description Error type Handling by i2 connector Not able to convert the XMLmessage to the business object. Error The i2 connector logs the message tothe adapter log and sets the status onthe exception to FAIL. It also dumpsthe XML message to the log file alongwith the error message. Execute me...

Tracing Level Tracing Messages Level 5 v Messages that indicate connector initialization, for example,messages showing the value of each configuration propertyretrieved from the integration broker. v Messages that comprise a business object dump. At this tracelevel, the connector outputs a textual r...

Appendix A. Standard configuration properties for connectors Connectors have two types of configuration properties: v Standard configuration properties v Connector-specific configuration properties This chapter describes standard configuration properties, applicable to allconnectors. For information...

Property Name Possiblevalues Defaultvalue Updatemethod Notes SynchronousRequestQueue CONNECTORNAME / SYNCHRONOUSREQUESTQUEUE componentrestart “SynchronousResponseQueue” onpage 52 CONNECTORNAME / SYNCHRONOUSRESPONSEQUEUE componentrestart SynchronousRequestTimeout 0 componentrestart “WireFormat” on pa...

ApplicationName Name that uniquely identifies the connector ’s application. This name is used bythe system administrator to monitor the WebSphere business integration systemenvironment. This property must have a value before you can run the connector. BrokerType Identifies the integration broker typ...

multi-threaded, or be capable of using Connector Agent Parallelism and beconfigured for multiple processes (setting the Parallel Process Degree configuration property greater than 1 ). Important: To determine whether a specific connector is single- or multi-threaded,see the installing and configurin...

DeliveryQueue The queue that is used by the connector to send business objects to the integrationbroker. The default value is DELIVERYQUEUE . DeliveryTransport Specifies the transport mechanism for the delivery of events. Possible values are MQ for WebSphere MQ, IDL for CORBA IIOP, or JMS for Java M...

In this environment, you may experience difficulty starting the both the connectorcontroller (on the server side) and the connector (on the client side) due to memoryuse within the WebSphere MQ client. If your installation uses less than 768M ofprocess heap size, IBM recommends that you set: v The L...

JvmMinHeapSize The minimum heap size for the agent (in megabytes). This property is applicableonly if the RepositoryDirectory value is <REMOTE>. The default value is 1m. jms.FactoryClassName Specifies the class name to instantiate for a JMS provider. You must set this connector property when y...

TT a two-letter country or territory code (usually inupper case) codeset the name of the associated character code set; thisportion of the name is often optional. The default is en_US . Important: By default only a subset of supported locales display in the drop list.To add other supported values to...

SynchronousRequestTimeout Specifies the time in minutes that the connector waits for a response to asynchronous request. If the response is not received within the specified time thenthe connector moves the original synchronous request message into the fault queuealong with an error message. The def...

manually modify the \Data\Std\stdConnProps.xml file in the product directory. For more information, see the appendix on ConnectorConfigurator. Attention: Do not run a non-internationalized connector against InterChange Server version 4.1.1 if you cannot guarantee that only ISO Latin-1 data will bepr...

Attention: v WebSphere MQ Integrator supports only one locale at a time. Ensure that everycomponent of the installation (for example, all adapters, applications, and theintegration broker itself) is set to the same locale. v If the connector has not been internationalized, the only valid value for t...

Appendix B. Connector Configurator Before you can use a connector, you must create a connector configuration file thatsets the properties for the connector, designates the business objects and anymeta-objects that it supports, and sets logging and tracing values that theconnector will use at runtime...

For example, to add the locale en_GB to the list of values for the Locale property, open the stdConnProps.xml file and add the line in boldface type below: <Property name="Locale" isRequired="true" updateMethod="component restart"> <ValidType>String</ValidType&...

After you have completed the configuration file and set its properties, it will needto be deployed to the appropriate location for your connector. v If you are using ICS as your broker, save the configuration in a System Managerproject, and use System Manager to load the file into InterChange Server...

Specifying general characteristics The Properties - Connector-Specific Property Template dialog appears. The dialoghas tabs for General characteristics of the defined properties and for Valuerestrictions. The General display has the following fields: v Edit propertiesUse the buttons provided (or rig...

Setting dependencies After you have finished making changes in both the General and the Value tabs,choose Next. The Dependencies dialog appears. A dependent property is a property that is included in the template and used inthe configuration file only if the value of another property meets a specifi...

display. When you select a name in the Template Name display, the PropertyTemplate Preview display shows the connector-specific properties that havebeen defined in that template.After you have chosen the template you want to use, choose OK. 3. A configuration screen will display for the connector th...

appropriate type for your broker--either ICS or WebSphere MQ Integrator Broker(for WMQI). If it does not, change the broker value before you configure theconnector. To do so: 1. Under the Standard Properties tab, select the value field for the BrokerTypeproperty. In the drop-down menu, select the va...

default values and some do not; you can modify some of the default values. Theinstallation and configuration chapter of each adapter guide describes theapplication-specific properties and the recommended values. The fields for Standard Properties and Connector-Specific Properties arecolor-coded to s...

Encryption for connector properties (ICS) Application-specific properties can be encrypted by clicking the Encrypt check boxin the Edit Property window. To decrypt a value, click to clear the Encrypt checkbox, enter the correct value in the Verification dialog box, and choose OK. If theentered value...

4. In the File menu of the Connector Configurator window, choose Save to Project.The revised connector definition, including designated support for the addedbusiness object definition, is saved to the project in System Manager. To delete a business object from the supported list: 1. To select a busi...

Important: Connector Configurator accepts property values in either English ornon-English character sets. However, the names of both standard andconnector-specific properties, and the names of supported businessobjects, must use the English character set only. Standard properties differ from connect...

2. Enter a name or value. 3. To encrypt a property, click the Encrypt box. 4. Choose to save or discard changes, as described for Setting Standard ConnectorProperties. The Update Method displayed for each property indicates whether a component oragent restart is necessary to activatechanged values. ...

For connector-specific properties, however, you will need to both define theproperties and set their values. Connector Configurator provides the interface forperforming both of these tasks. Completing the configuration After you have created a configuration file for a connector and modified it, make...

Appendix C. Connector feature list This appendix details the features supported by the i2 connector. For descriptionsof these features, see “Appendix A: Connector feature checklist” in IBM WebSphere Business Integration Adapters Connector Development Guide . Event notification features The following...

Category Feature Support Notes Logical delete N/A Exist Exist verb No Misc Attribute names Partial MO_Instance is the standard used torepresent the metaobject containing theinstance ID in any wrapper business object. Business object names Full Retrieve Ignore missing child object N/A RetrieveByConte...