Contents
About this document
Audience
Related documents
WebSphere Business Integration adapters publications
WebSphere message broker publications
System Manager publications
Typographic conventions
Summary of Changes
New with WebSphere Business Integration Adapter Framework v 2.4.0
February 2004
December 2003
New in WebSphere Business Integration Adapters v 2.3.1
New in WebSphere Business Integration Adapters v 2.2.0
New in WebSphere Business Integration Adapters v 2.1.0
New in WebSphere Business Integration Adapters v 2.0.1
Overview and concepts
Overview of WebSphere Business Integration adapters
A note about documents you need
What is the WebSphere business integration system?
What are WebSphere message brokers?
What are WebSphere Business Integration adapters?
How the WebSphere business integration system works
Data flow in the business integration system
Summary of the business integration process
Business objects
Roles of a business object
Event
Request
Response
Structure of a business object
Business object type
Business object verbs
Business object attribute values
Types of business objects
Business object definitions and business objects
Components of a business object definition
Verbs
A closer look at business objects
Attribute organization
Application-specific information
Ways to create or modify business object definitions
Creating business object definitions
Modifying business object definitions
Connectors
Connector startup
Event notification
Setting up the application's event-notification mechanism
Detecting an event
Processing an event
Guaranteed event delivery
Request processing
Verb-based processing
Business object construction and deconstruction
Application-specific information for verbs
Connector configuration
Connector development
Data transport and the integration broker
The role of the integration broker
Asynchronous data transport
Synchronous data transport
Interfaces for message exchange
Message formats
Message queues
For more information
Deployment and administration
Planning your implementation
Developing the business process interfaces
Stages of an implementation
Discovering and assessing business goals
Evaluating existing components and designing new ones
Developing and configuring the business integration system
Validating the business integration system
Deploying the business integration system
Development tools
Installing WebSphere Business Integration adapters
Installing for Windows systems
Software Requirements
Installing the JDK
Installing WebSphere MQ
Installing WebSphere Business Integration adapters
Installing for UNIX systems
Software Requirements
Installing the JDK
Installing WebSphere MQ
Installing WebSphere Business Integration adapters
Administering the business integration system
Starting a connector
From Windows
From UNIX
Stopping a connector
From the connector system
From the broker system
Creating multiple connector instances
Create a new directory
Using Adapter Monitor and Fault Queue Manager
Adapter Monitor perspective
Setting Adapter Monitor preferences
Loading an adapter
Adapter Monitor displays
Change the state of an adapter
Using the Fault Queue Manager Display
Handling failed events
Clearing messages from WebSphere MQ queues
Managing log and trace files
Archival logging of log and trace files
Managing other files
Using Log Viewer to view connector messages
Setting Log Viewer preferences
Changing how messages are viewed
Controlling the Log Viewer display output
Filtering messages
Configuring the WebSphere business integration system
Overview of configuration tasks
Configuring the message broker to work with the connector
Configuring the WebSphere MQ queues
Defining the queue configuration
Creating business object definitions
Creating a message broker project
Specifying importer and workspace paths
Creating a new user project
Deploying to a message broker workspace
Deploying to an integrator broker
Choosing XML Namespace length
Enabling the application for use with the connector
Configuring the connector
Specifying the location of the connector's local repository
Specifying the queues to be used by the connector
Setting the connection mode with the queue manager
Setting configuration properties for synchronous execution
Configuring logging and tracing options
Configuring the connector startup files, shortcuts, and environment variables
Defining message flows
Transaction management
Using Visual Test Connector to verify your interfaces
Appendixes
Appendix A. WebSphere MQ message formats
Message descriptor
Message header
Message body
Appendix B. WebSphere MQ message body formats for administrative messages
Messages from the connector framework to WebSphere message brokers
Messages from WebSphere message brokers to the connector framework
Appendix C. Standard configuration properties for connectors
New and deleted properties
Configuring standard connector properties
Using Connector Configurator
Setting and updating property values
Summary of standard properties
Standard configuration properties
AdminInQueue
AdminOutQueue
AgentConnections
AgentTraceLevel
ApplicationName
BrokerType
CharacterEncoding
ConcurrentEventTriggeredFlows
ContainerManagedEvents
ControllerStoreAndForwardMode
ControllerTraceLevel
DeliveryQueue
DeliveryTransport
DuplicateEventElimination
FaultQueue
JvmMaxHeapSize
JvmMaxNativeStackSize
JvmMinHeapSize
jms.FactoryClassName
jms.MessageBrokerName
jms.NumConcurrentRequests
jms.Password
jms.UserName
ListenerConcurrency
Locale
LogAtInterchangeEnd
MaxEventCapacity
MessageFileName
MonitorQueue
OADAutoRestartAgent
OADMaxNumRetry
OADRetryTimeInterval
PollEndTime
PollFrequency
PollQuantity
PollStartTime
RequestQueue
RepositoryDirectory
ResponseQueue
RestartRetryCount
RestartRetryInterval
RHF2MessageDomain
SourceQueue
SynchronousRequestQueue
SynchronousResponseQueue
SynchronousRequestTimeout
WireFormat
WsifSynchronousRequest Timeout
XMLNameSpaceFormat
Appendix D. Connector startup options
Windows
UNIX
Appendix E. System Manager and the Eclipse Workbench
About System Manager
About the Eclipse Platform
About WSWB and WSADIE
About System Manager
Using System Manager
Starting System Manager
System Manager interface
Working with integration component libraries
Creating integration component libraries
Working with user projects
Configuring integration broker preferences for user projects
Creating user projects
Adding shortcuts to a user project
Working with components in integration component libraries
Launching designer tools
Creating new components
Modifying existing components
Importing components into a library from a package
Working with solutions
Exporting a solution
Importing a solution
Exporting components to a package using System Manager
Dependencies and references
Showing dependencies and references
Standard operations available for multiple workbench resources
Adding projects to the workspace from source code control
Cutting, copying, and pasting resources
Refreshing resources
Deleting resources
Using Eclipse-based workbenches
Opening and closing perspectives
Showing and closing views
Customizing perspectives
Saving perspectives
Setting the default perspective
Configuring System Manager preferences
Troubleshooting problems connecting to the integration broker in System Manager
Appendix F. Using the Connector Script Generator tool
Appendix G. Using Visual Test Connector
Recommended testing procedure
Starting Test Connector
Shutting down Test Connector
Creating and editing connector profiles
Saving the connector definition to a file
Creating a new profile
Editing a profile
Deleting a profile
Emulating a connector
Working with business objects
Working with request business objects
Setting values for business object attributes
Saving a business object
Loading a business object
Deleting a business object
Accepting a request business object
Working with response business objects
Comparing business object instances
Appendix H. Upgrading WebSphere Business Integration adapters
Assumptions
Installing WebSphere Business Integration adapters
Upgrading WebSphere message brokers
WebSphere MQ Integrator Broker
WebSphere MQ Integrator
WebSphere Business Integration Message Broker
Installing service packs for WebSphere MQ
Creating the response queue
Updating the value of the local queue manager's coded character set ID
Upgrading existing adapters
Upgrading business objects
Updates to the connector configuration files
Configuring the new connector startup scripts
Configuring new adapters
Customizing the new WebSphere MQ batch files
Glossary
Index
Notices
Programming interface information
Trademarks and service marks