IBM WebSphere Business Integration Adapter User Manual Download Page 5

Page: 5 / 92

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.

iii

Summary of Contents for WebSphere Business Integration Adapter

Page 1: ...IBM WebSphere Business Integration Adapters Adapter for i2 User Guide Adapter V ersion 1 0 x...

Page 2: ......

Page 3: ...IBM WebSphere Business Integration Adapters Adapter for i2 User Guide Adapter V ersion 1 0 x...

Page 4: ...wise indicated in new editions To send us your comments about this document email doc comments us ibm com We look forward to hearing from you When you send information to IBM you grant IBM a nonexclus...

Page 5: ...iness 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 Re...

Page 6: ...iv Adapter for i2 User Guide...

Page 7: ...ess 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 Standar...

Page 8: ...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...

Page 9: ...ad it directly online at one of the following sites v If you are using WebSphere MQIntegrator as your integration broker http www ibm com websphere integration wbiadapters infocenter v If you are usin...

Page 10: ...stinguish 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 backsl...

Page 11: ...and sends business objects v Manages the exchange of startup and administrative messages Note This document contains information about both the connector framework and the application specific compon...

Page 12: ...Component Description CIS Common Integration Services provided by i2 to enable connectivity between the external applications and i2 application modules OM Order Management just an example of an i2 a...

Page 13: ...rming incoming business objects into CIS records and using the appropriate CIS Client API calls to execute the operation on the i2 application modules The i2 connector follows the metadata design prin...

Page 14: ...the first poll call the i2 connector tries to register the same operation with the subsequent poll calls 3 With all the poll calls the i2 connector checks on the output of the operations that it has r...

Page 15: ...tility Then the operation is executed using the CIS Client API If the operation sends some output XML message it is converted to an output child business object and the output child business object in...

Page 16: ...6 Adapter for i2 User Guide...

Page 17: ...adapter platforms Windows NT 2000 UNIX Solaris 8 0 or AIX 4 3 Note For instructions on installing the software and installing prerequisites specific to your integration broker see IBM WebSphere Busine...

Page 18: ...adds an icon for the connector file to the IBM WebSphere Business Integration Adapters menu For a fast way to start the connector create a shortcut to this file on the desktop Subdirectory of Product...

Page 19: ...properties for both brokers are relevant to the connector In addition the following supplemental information on standard connector properties applies to i2 LogAtInterchangeEnd Tells whether to log err...

Page 20: ...tart files for CIS SDK and j2ee jar Example The following path information needs to be added to start_i2 bat file set I2_CIS_HOME_DIR C i2 CIS 6 0 cis sdk set J2EE_PATH C J2EE_JAR Note These are just...

Page 21: ...iness object metadata includes the structure of the business object the settings of its attribute properties and the content of its application specific information Because the connector is metadata d...

Page 22: ...ity the relationship between the parent and child business objects is described by the application specific text of the key attribute of the child object i2 business object structure The i2 IBM busine...

Page 23: ...IBM_OptimizationResults Type input IBM_OpParams Type output Verb addBid IBM_OptParams LaneId Price InstanceId MO_Instance IBM_OptimizationResults WinningBid Configuring metaobjects for polling The con...

Page 24: ...ecifies a default value that the connector uses for a simple attribute in the inbound business object if the attribute is not set and is a required attribute Rule You must set and use the default valu...

Page 25: ...Empty double quotation marks in an XML document are used as the PCDATA equivalent of CxBlank Identifying business object application specific information Application specific information provides the...

Page 26: ...16 Adapter for i2 User Guide...

Page 27: ...converting the XML schema to the actual business object for the type 3 Prior to saving the wrapper business object saving to the repository the MO_Instance business object and the business objects th...

Page 28: ...gistered i2 ODA with the Visibroker Object Activation Daemon OAD you do not need to start i2 ODA manually OAD maintains a list of registered ODA names and listens for requests to start the ODA When yo...

Page 29: ...from the i2 ODA application v Logs warnings that require a system administrator s attention 1 Traces all entering and exiting messages for method 2 Traces the ODA s properties and their values 3 Trac...

Page 30: ...machines they are visible in the Business Object Designer by their i2 ODA values If two ODAs have the same i2 value then either of the ODAs can be used with possibly undesirable results You can assign...

Page 31: ...up v TraceFileName File into which i2 ODA writes trace information The command line option for this parameter is t i2ODA names the file according to the naming convention Example If the agent is name...

Page 32: ...t and output types v i2BO_in_persistorder_Order xsd input v i2BO_out_persistorder_Order xsd output The schema files are stored in the directory specified by the SchemaFileLocation property for the ODA...

Page 33: ...file in this step the current Business Object Designer wizard looks at the machine where the agent is running Another pop up window prompts you for a location to save the generated wrapper business ob...

Page 34: ...can concatenate the files together into a single file and copy them to the server Guideline Be sure to run the XML schema ODA prior to saving the wrapper business objects to the server Example Propert...

Page 35: ...ration and check the output from i2 applications for the registered operation The following diagram shows the structure of the i2 metaobject for i2 MO_Operation The diagram shows the attributes of the...

Page 36: ...26 Adapter for i2 User Guide...

Page 37: ...traces for exceptions Error types Error messages are of two types v Errors conditions that the connector can recover from usually by abandoning the current processing v Fatal errors unrecoverable erro...

Page 38: ...gent Fatal error With subsequent poll calls the i2 connector tries to re register the operations that could not be registered with the previous poll call In case registering all the operations fail we...

Page 39: ...ocessing call It logs a fatal error with the status of FAIL in the exception and a detailed exception message stating the cause of the exception set on the exception object No instance ID found in the...

Page 40: ...ance and decrease file size The following table describes the types of tracing messages that the i2 connector outputs at each trace level All the trace messages appear in the file specified by the con...

Page 41: ...one processing the object showing the object the connector returns to the collaboration Tips for troubleshooting Use the following tips for troubleshooting problems v If the CIS agent is running remot...

Page 42: ...32 Adapter for i2 User Guide...

Page 43: ...integration broker 3 Local configuration file 4 Command line Note In this document backslashes are used as the convention for directory paths For UNIX installations substitute slashes for backslashes...

Page 44: ...s adapter guide You configure connector properties from Connector Configurator which you access from System Manager Note Connector Configurator and System Manager run only on the Windows system Even i...

Page 45: ...restart ConcurrentEventTriggeredFlows 1 to 32 767 no value component restart ContainerManagedEvents JMS or no value JMS guaranteed event delivery ControllerStoreAndForwardMode true or false true dyna...

Page 46: ...namic OADMaxNumRetry a positive number 1000 dynamic OADRetryTimeInterval a positive number in minutes 10 dynamic PollEndTime HH MM HH MM component restart PollFrequency a positive integer in milliseco...

Page 47: ...nection This property enhances performance for a multi threaded connector by allowing multiple connections between the connector controller and application specific component When there is a large req...

Page 48: ...1 if you cannot guarantee that only ISO Latin 1 data will be processed The default value is ascii ConcurrentEventTriggeredFlows Determines how many business objects can be concurrently processed by t...

Page 49: ...b will be displayed only if you have set ContainerManagedEvents to JMS 2 When ContainerManagedEvents is set to JMS the connector does not call its pollForEvents method thereby disabling that method s...

Page 50: ...side In optimized mode WebSphere MQ stores only the pointer to an event in the repository database while the actual event remains in the WebSphere MQ queue This saves the overhead of having to write p...

Page 51: ...ronment variable However you must set IPCCBaseAddress to a value of 11 or 12 DuplicateEventElimination Setting this property to true enables a JMS enabled connector with a non JMS event store to ensur...

Page 52: ...at can be sent to a connector at the same time Once that maximum is reached new service calls block and wait for another request to complete before proceeding The default value is 10 jms Password Spec...

Page 53: ...or fatal errors occur As an example when a connector loses its connection to its application if LogAtInterChangeEnd is set to true an email message is sent to the specified message recipient The defau...

Page 54: ...nged PollFrequency The amount of time between polling actions Set PollFrequency to one of the following values v The number of milliseconds between polling actions v The word key which causes the conn...

Page 55: ...en used for a parallel connector specifies the interval at which the master connector application specific component attempts to restart the slave connector application specific component The default...

Page 56: ...rs that use WebSphere MQ Integrator Broker For information specific to a connector see its adapter user guide You configure connector properties from Connector Configurator Note Connector Configurator...

Page 57: ...Name is IBM use crossworlds queue manager If FactoryClassName is Sonic use localhost 2506 crossworlds queue manager jms NumConcurrentRequests 10 jms Password jms UserName Locale en_US ja_JP ko_KR zh_C...

Page 58: ...onnector when you work with the definition for an IBM WebSphere delivered connector the property is also likely to be set to the name of the connector Set the property to a value that suggests the pro...

Page 59: ...ue The queue that is used by the connector to send business objects to the integration broker The default value is CONNECTORNAME DELIVERYQUEUE DeliveryTransport Specifies the transport mechanism for t...

Page 60: ...his property is optional There is no default Locale Specifies the language code country or territory and optionally the associated character code set The value of this property determines such cultura...

Page 61: ...lue for this property The default value is HH MM but must be changed PollFrequency The amount of time between polling actions Set the PollFrequency to one of the following values v The number of milli...

Page 62: ...minute in between its restart attempts SourceQueue Designates the JMS source queue for the connector framework in support of guaranteed event delivery for JMS enabled connectors that use a JMS event s...

Page 63: ...ta format for messages exchanged by the connector The default value CwXML is the only valid value and directs the connector to compose the messages in XML Appendix A Standard configuration properties...

Page 64: ...54 Adapter for i2 User Guide...

Page 65: ...roperty template for configuring your connector v Create a configuration file v Set properties in a configuration file Connector Configurator runs only in a Windows environment If you are running the...

Page 66: ...stem Manager projects If you are using ICS as your broker this is a mandatory step before you deploy your configuration into the ICS Note When you save a configuration file as a component of a System...

Page 67: ...arting point for creating a configuration file that will be used with a different broker However be aware that revising a configuration file for use with a different broker typically involves changing...

Page 68: ...aracteristics and values for those properties and specify any dependencies between the properties Then you ll save the template and use it as the base for creating a new connector configuration file C...

Page 69: ...e maximum length the maximum multiple values a default value or a value range for the property To do so 1 Choose the Value tab The display panel for Value replaces the display panel for General 2 Sele...

Page 70: ...Property display 6 Click Finish Connector Configurator stores the information you have entered as an XML document under data app in the bin directory where you have installed Connector Configurator C...

Page 71: ...ablish here must match the connector configuration file path and name that you supply in the startup file for the connector 5 To complete the connector definition enter values in the fields for each o...

Page 72: ...ve an existing file available in one or more of the following formats v A connector definition file This is a text file that lists properties and applicable default values for a specific connector Som...

Page 73: ...1 Standard Properties 2 Connector Specific Properties 3 Supported Business Objects 4 Associated Maps 5 Resources 6 Trace Log File values 7 Messaging where applicable 8 Data handlers applicable for co...

Page 74: ...nd choose No when prompted to save changes v To enter values for other categories in Connector Configurator choose the tab for the category The values you enter for Standard Properties or other catego...

Page 75: ...or them and have saved both the business object definitions and map definitions into System Manager projects Before you can make use of a connector and before you can bind the connector with a collabo...

Page 76: ...nnector s agent but generic business objects are not To indicate that the business object is supported by the connector agent put a check in the Agent Support box Note that the Connector Configurator...

Page 77: ...tries to automatically bind a map to each supported business object for each connector If more than one map takes as its input the same business object the server attempts to locate and bind one map...

Page 78: ...for configuration only if you have designated a value of JMS for DeliveryTransport and a value of JMS for ContainerManagedEvents See the descriptions under ContainerManagedEvents in Appendix A Standar...

Page 79: ...round indicates an application specific property These properties vary according to specific needs of the application or connector You can change the value and delete these properties v Value fields a...

Page 80: ...e Specifying supported business object definitions The procedures in this section assume that you have already created v Business object definitions v MQ message set files set files The set files cont...

Page 81: ...location that you specify Note Both logging and tracing files are simple text files You can use the file extension that you prefer when you set their file names For tracing files however it is advisa...

Page 82: ...u have created a configuration file for a connector and modified it make sure that the connector can locate the configuration file when the connector starts up To do so open the startup file used for...

Page 83: ...reach the connector for processing CDK method gotApplEvent Full Delta event notification Full An operation needs to be created which handles the same as the connection handles this operation Event seq...

Page 84: ...ithout the operation Verb stability Full General features The following table details the general features supported by the connector Category Feature Support Notes Business object attributes Foreign...

Page 85: ...el 1 Full Trace level 2 Full Trace level 3 N A Trace level 4 Full Trace level 5 Full Misc CDK method LogMsg Full WBIA API methods generateAndTrace and generateAndLogMsgs are used Java Package Names Fu...

Page 86: ...76 Adapter for i2 User Guide...

Page 87: ...R IMPLIED INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF NON INFRINGEMENT MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE Some states do not allow disclaimer of express or implied warranti...

Page 88: ...tions on the capabilities of non IBM products should be addressed to the suppliers of those products This information may contain examples of data and reports used in daily business operations To illu...

Page 89: ...ries or both MMX Pentium and ProShare are trademarks or registered trademarks of Intel Corporation in the United States other countries or both Java and all Java based trademarks are trademarks of Sun...

Page 90: ...80 Adapter for i2 User Guide...

Page 91: ......

Page 92: ...Printed in U S A...

Search results

Summary of Contents for WebSphere Business Integration Adapter

Reviews:

Related manuals for WebSphere Business Integration Adapter

Brands by name

Popular brands

IBM WebSphere Business Integration Adapter, User Manual

Search results

Summary of Contents for WebSphere Business Integration Adapter

Reviews:

Related manuals for WebSphere Business Integration Adapter

Brands by name

Popular brands