Information Roadmap

This document provides pointers to information about Business Integration Connect. A table under each heading provides an outline of tasks you perform and a link to a supporting document.

Learning about Business Integration Connect

The following documents provide information you can use to obtain a general understanding of the product:

Learning about Business Integration Connect
Document Information
Product Overview Provides a description of Business Integration Connect and how it fits in the WebSphere family of products. It describes:
  • The trading community
  • Benefits to the Community Manager and participants
  • Components of Business Integration Connect
  • The architecture of Business Integration Connect
  • The documentation set for the product, the code samples that are included with the product, and the RosettaNet PIPs that are supplied.
Release Notes Lists late-breaking information about the product.

Installing and configuring Business Integration Connect

The following documents provide information on installing the product and configuring the hub:

Installing and configuring Business Integration Connect
Document Information
Installation Guide Provides step-by-step instructions for installing Business Integration Connect Enterprise and Advanced Editions.

The book includes the following information:

  • Hardware and software requirements
  • Instructions for verifying pre-requisite software
  • Instructions for installing Business Integration Connect
  • Instructions on starting Business Integration Connect and testing the installation
  • Troubleshooting tips
  • Instructions for uninstalling Business Integration Connect
Hub Configuration Guide

Provides information for the Hub Admin on configuring the system after it is installed. The following information is provided:

  • An overview of the document exchange process, including the points at which you can upload user-written handlers to modify the system-supplied behavior of targets, gateways, actions, and fixed workflows and to provide new transports for defining targets and gateways
  • Instructions on setting up the directory structure for a file-system gateway, configuring an FTP server to receive documents, and creating a directory for and modifying the default JMS configuration
  • Instructions on configuring Community Console Locale information, branding the console, establishing the password policy, and configuring permissions
  • Step-by-step instructions for uploading user-defined handlers, defining targets, configuring document flow definitions, uploading WSDL and RosettaNet packages, configuring fixed workflows, configuring or creating actions, creating and editing XML formats, configuring validation maps, and creating interactions
  • Step-by-step instructions for creating participants and setting up gateways, B2B capabilities, and connections for the participants
  • A description of the types of security you can use with inbound and outbound documents and instructions for managing certificates between the hub and participants
  • Descriptions of the PIP packages that are supplied on the installation medium and information and instructions for setting up for RosettaNet exchanges
  • Descriptions of using Web services and cXML documents with Business Integration Connect

Using Business Integration Connect

The following documents provide information on how to use Business Integration Connect after it has been installed and configured.

Using Business Integration Connect
Document Information
Administrator Guide Provides step-by-step instructions for performing the day-to-day tasks necessary to manage the hub community. The following information is provided:
  • Definitions of the types of users and the tasks that those users perform
  • Instructions for logging in to the Community Console
  • Instructions for modifying the hub (for example, creating targets) after the initial hub configuration
  • Information on managing participants, including setting up or modifying participant gateways, B2B attributes, connections, and the exclusion list
  • Instructions for viewing documents that are queued for delivery
  • Descriptions of the event and document viewers and instructions for viewing event details, message details, and raw documents
  • Descriptions of the document analysis tools and document volume reports
  • Instructions for using the Test Participant Connection tool
  • A description of and instructions for using the Community Participant Simulator
  • Instructions for archiving documents
  • Troubleshooting tips
  • Performance considerations
  • Event code descriptions
  • A list of configurable parameters in the BCG.Properties file
Participant Guide Provides step-by-step instructions for performing tasks through the use of the Community Console. This guide is for Community Participants.

This book provides instructions on performing the following tasks:

  • Setting up the environment, including verifying that your participant profile is correct, setting up gateways and B2B capabilities, obtaining and uploading certificates, creating users and groups, and defining alerts
  • Managing and making changes to the environment
  • Using the viewers and document analysis tools to monitor document exchanges
Enterprise Integration Guide Describes how to integrate several kinds of back-end systems with Business Integration Connect Enterprise and Advanced Editions so that the back-end system can send and receive messages from Business Integration Connect. It describes:
  • An introduction to back-end integration, including:
    • The types of protocols and packaging that can be used to send and receive information
    • The transport-level headers that are added when Backend Integration packaging has been specified
    • An overview of how to plan for the integration process
    • How to configure Business Integration Connect for back-end integration
  • Integration (over the HTTP or JMS transport protocol) with WebSphere InterChange Server, including the use of the Attachment Data Handler
  • Integration (over the HTTP or JMS transport protocol) with WebSphere Business Integration Message Broker
  • Integration with WebSphere Data Interchange
  • Information on how Business Integration Connect routes EDI documents
  • How to configure the JMS protocol with WebSphere MQ
PIP Sample Provides a description of and instructions for using the PIP sample provided with Business Integration Connect. This document describes how to set up Business Integration Connect, WebSphere MQ, and WebSphere Interchange Server. It then shows how to run three scenarios in which PIP documents are exchanged.

Developing method calls and user exits

The following document provides information for developers on constructing method calls and writing user exits.

Extending and automating Business Integration Connect
Document Information
Programmer Guide Provides information and instructions to developers for performing the following tasks:
  • Extending the functionality of Business Integration Connect through plug-ins that do the following:
    • add new transports
    • modify certain configuration points for targets and gateways
    • create and modify actions in variable workflow and handlers in fixed workflow
  • Automating certain common administrative functions in Business Integration Connect so that they can be carried out programmatically. For example, how to create a participant without using the Community Console.
  • Setting up event delivery to an external queue, so that monitoring applications can have access to Connect message and document events.

Copyright IBM Corp. 1997, 2004