IBM WebSphere Business Integration Adapter manual Understanding business objects for the connector

Page 21

Chapter 3. Understanding business objects for the connector

This chapter describes the structure of i2 business objects, how the connector processes the business objects, and the assumptions the connector makes about them. Use this information as a guide to modifying existing business objects for i2 or as suggestions for implementing new business objects.

The chapter contains the following sections:

v“Defining connector metadata” on page 11

v“Overview of business object structure” on page 11

v“i2 business object structure” on page 12

v“Specifying business object attribute properties” on page 14

v“Identifying business object application-specific information” on page 15

For information on the Object Discovery Agent (ODA) utility that automates the creation of business objects for the IBM WebSphere Business Integration Adapter for i2, see Chapter 4, “Generating business objects using i2 ODA”, on page 17.

Defining connector metadata

The i2 connector is metadata-driven. In the WebSphere business integration system, metadata is application-specific information that is stored in a business object and that helps the connector interact with the application. A metadata-driven connector handles each business object that it supports based on the metadata encoded in the business object definition rather than on instructions hardcoded in the connector. Business 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-driven, it can handle new or modified business objects without requiring modifications to the connector code.

The connector makes assumptions about the structure of its supported business objects, the relationships between parent and child business objects, and the format of the application-specific information.

Therefore, when you create or modify a business object, your modifications must conform to the rules the connector is designed to follow, or the connector will not be able to process new or modified business objects correctly.

Overview of business object structure

In the WebSphere business integration system, a business object definition consists of a type name, supported verbs, and attributes. An application business object is an instance of a business object definition. It reflects a specific application’s data structure and attribute properties.

Some attributes, instead of containing data point to child business objects or arrays of child business objects that contain the data for these objects. Keys relate the data between the parent record and child records.

WebSphere Business Integration Adapter business objects can be flat or hierarchical. A flat business object only contains simple attributes, that is, attributes that represent a single value (such as a String) and do not point to child business

© Copyright IBM Corp. 2002, 2003

11

Page 20 Page 22
Image 21
Page 20 Page 22
Contents Adapter for i2 User Guide Page Adapter for i2 User Guide 18April2003 Integration broker compatibility Iv Adapter for i2 User Guide Contents Appendix D. Notices Audience About this documentRelated documents Typographic conventionsViii Adapter for i2 User Guide Connector architecture Overview of the connectorComponent Description XML DH Wbia APIHow the connector works Processing subscriptionsEvent detection and notification Status updates Processing service call requestsProcessing verbs operations Event retrievalStatus updates Adapter for i2 User Guide Prerequisites for installing the connector Installing and configuring the connectorInstalling the connector on a Windows or Unix system Step for installing the standard filesConfiguring the connector Installed file structureConnector-specific properties Standard connector propertiesLogAtInterchangeEnd MessageFileNameConfiguring starti2.bat for Windows or starti2.sh for Unix Starting the connectorConfiguring DataHandler Property DescriptionUnderstanding business objects for the connector Defining connector metadataOverview of business object structure Wrapper BO I2 business object structureType=output Configuring metaobjects for pollingAttribute Description Specifying business object attribute propertiesSpecial attribute values Application-specific information at the attribute levelParameter Description Adapter for i2 User Guide Installing i2 ODA Generating business objects using i2 ODASteps for installing i2 ODA Overview of i2 ODALaunching i2 ODA Other installation requirementsWorking with error and trace message files Using i2 ODA in Business Object DesignerTrace Level Description Steps for using i2ODA Configure agent propertiesSelect the Agent Example i2BO Row Property name Property type Description NumberAdapter for i2 User Guide Generating business objects using i2 ODA Property Value Save the business object filesCreate the metaobject for polling I2MOOperation InstanceId DefaultValue= WrapperBONameAdapter for i2 User Guide Troubleshooting and error handling Logging error messagesStructure of error messages Error description Error type Handling by i2 connector Polling-related error messagesService call request processing error messages Tracing Level Tracing messagesTracing Messages ExampleTips for troubleshooting Adapter for i2 User Guide New and deleted properties Appendix A. Standard configuration properties for connectorsAdapter for i2 User Guide Property Name Possible Default Update Values Method CONNECTORNAME/REQUESTQUEUE AdminOutQueue AdminInQueueAgentConnections AgentTraceLevelBrokerType ApplicationNameCharacterEncoding ConcurrentEventTriggeredFlowsContainerManagedEvents ControllerStoreAndForwardModeControllerTraceLevel DeliveryQueue DeliveryTransportWebSphere MQ and IDL DuplicateEventElimination FaultQueueJvmMaxHeapSize JvmMaxNativeStackSizeJvmMinHeapSize Jms.PasswordJms.FactoryClassName Jms.MessageBrokerNameMaxEventCapacity LogAtInterchangeEndMessageFileName OADAutoRestartAgentOADRetryTimeInterval OADMaxNumRetryPollEndTime PollFrequencyResponseQueue RepositoryDirectoryRestartRetryCount RestartRetryIntervalSynchronousRequestTimeout WireFormatTraceFileName Application name Name Possible values Default valueAdminOutQueue AdminInQueueAgentTraceLevel ApplicationNameContainerManagedEvents FaultQueueDeliveryQueue DeliveryTransportJms.FactoryClassName Jms.PasswordJms.MessageBrokerName Jms.NumConcurrentRequestsPollFrequency PollEndTimePollStartTime RepositoryDirectoryRequestQueue SynchronousTimeoutResponseQueue RestartRetryCountWireFormat Adapter for i2 User Guide Appendix B. Connector Configurator Starting Connector Configurator Running Configurator from System ManagerValueenGB/Value Choosing your broker Running Configurator independently of System ManagerCreating a template of connector-specific properties Using a connector-specific property templateSpecifying values Specifying general characteristicsSetting dependencies Completing a configuration file Using Connector Configurator with ICS as the brokerUsing an existing file Setting the configuration file properties ICS Using an existing System Manager projectSetting application-configuration properties ICS Setting standard connector properties ICSUpdate method ICS Encryption for connector properties ICSSpecifying supported business object definitions ICS Business object nameAssociated maps ICS Agent supportMaximum transaction level Resources ICS Setting trace/log file values ICSData handlers Configuring messagingSetting application-configuration properties Setting standard connector propertiesEncryption for connector properties Update methodSpecifying supported business object definitions Configuring data handlers Setting trace/log file valuesCompleting the configuration Event notification features Appendix C. Connector feature listService call request handling features Category Feature SupportGeneral features Appendix C. Connector feature list Adapter for i2 User Guide Appendix D. Notices Programming interface information Trademarks and service marksIBM Adapter for i2 User Guide

WebSphere Business Integration Adapter specifications

IBM WebSphere Business Integration Adapter is an essential component of IBM's integration solutions, providing organizations with a robust framework to connect various systems, applications, and data sources. This versatile solution is particularly designed to streamline the integration of enterprise applications and enhance their interactions.

One of the main features of the WebSphere Business Integration Adapter is its wide range of pre-built adapters. These adapters facilitate seamless connectivity with diverse applications, such as ERP systems, CRM software, databases, and legacy systems. This wide compatibility ensures that organizations can automate processes and share data effortlessly, reducing the time and overhead typically associated with manual integrations.

Another notable feature of the integration adapter is its support for various messaging protocols, including JMS, MQ, and HTTP. This multi-protocol support enables organizations to easily implement message-driven architectures by facilitating reliable and asynchronous communication between disparate systems. As a result, businesses can achieve greater scalability and responsiveness in their operations.

The technology stack behind IBM WebSphere Business Integration Adapter also incorporates standards-based protocols, such as Web Services (SOAP, REST) and XML messaging. This adherence to industry standards ensures that the adapter can easily integrate with modern cloud-based applications and services, providing organizations with the flexibility to adapt to evolving technological landscapes.

In addition to its core integration capabilities, the WebSphere Business Integration Adapter supports comprehensive monitoring and management features. Administrators can easily track the performance of integration flows, monitor message processing, and manage exceptions through an intuitive dashboard. This visibility enables organizations to proactively address issues before they escalate, ensuring smooth and uninterrupted operations.

Another significant characteristic of the IBM WebSphere Business Integration Adapter is its scalability. Organizations can deploy the adapter in various environments, from on-premise data centers to cloud infrastructures. This flexibility allows businesses to scale their integration solutions as needed, accommodating growing data volumes and increasing transaction demands with ease.

Moreover, the adapter's modular architecture makes it easy to customize and extend. Businesses can enhance existing functionalities or integrate additional capabilities to meet specific requirements, ensuring that their integration solutions remain relevant and effective in an ever-changing business landscape.

In conclusion, the IBM WebSphere Business Integration Adapter is a powerful tool for organizations looking to enhance their system integrations. With its extensive features, support for multiple technologies, and capacity for customization, it positions businesses for success in an increasingly interconnected world. By leveraging this adapter, organizations can achieve greater efficiency, agility, and operational excellence in their integration efforts.
Top Page Image Contents