Information Roadmap

This information roadmap provides an overview of the documentation set for WebSphere Partner Gateway, Enterprise and Advanced Editions, version 6.0.0.1. Each heading shown below identifies a high-level task. A table under each heading lists the supporting documents and describes the information they provide.

Learning about Partner Gateway

The following documents provide general information about Partner Gateway:

Document Information provided
Product Overview

Provides a conceptual and technical overview of Partner Gateway. It includes the following information:

  • A description of the enhancements and changes to the product for this release
  • A conceptual introduction to the trading community, how the trading community operates, and the different roles involved
  • The benefits of the trading community to the Community Manager and to trading partners
  • How Partner Gateway fits into the overall WebSphere product family
  • A technical overview of Partner Gateway along with an explanation of key concepts and terms
  • Information about the transport and business protocols supported by Partner Gateway
  • Hardware and software requirements for the product
  • A description of the documentation set for the product
  • Pointers to the code samples and RosettaNet PIPs that are supplied.

Installing Partner Gateway

The following document provides information about installing Partner Gateway:

Document Information provided
Installation Guide

Provides step-by-step instructions for installing Partner Gateway. It includes the following information:

  • Hardware and software requirements
  • Instructions for verifying and configuring pre-requisite software
  • Instructions for installing Partner Gateway
  • Instructions for upgrading Partner Gateway
  • Instructions for starting Partner Gateway and testing the installation
  • Troubleshooting tips
  • Instructions for uninstalling Partner Gateway.

Configuring and customizing Partner Gateway

The following documents provide information about configuring and customizing Partner Gateway:

Document Information provided
Hub Configuration Guide

Provides information for configuring Partner Gateway after it is installed. It includes the following information:

  • 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
    • Provide new transports for defining targets and gateways
  • Instructions for 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 for configuring Community Console Locale information, branding the console, establishing the password policy, and configuring permissions
  • Step-by-step instructions for uploading user-defined handlers and defining targets
  • Step-by-step instructions for configuring fixed workflows and configuring or creating actions
  • Step-by-step instructions for configuring document flow definitions and creating interactions for binary documents, EDI documents that are passed through (no transformation), RosettaNet documents, Web services, and cXML documents and for creating and editing XML formats
  • General information about EDI interchanges and step-by-step instructions for uploading transformation maps from the Data Interchange Services client, configuring document flow definitions, and creating interactions for EDI, XML, and record-oriented data documents
  • Step-by-step instructions for creating the Community Manager's profile and B2B capabilities
  • Step-by-step instructions for creating gateways
  • Step-by-step instructions for creating profiles and B2B capabilities of community 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
  • Step-by-step examples of setting up exchanges
  • Descriptions of the PIP packages that are supplied on the installation medium
  • Descriptions of attributes that can be configured.
Programmer Guide

Provides information about and instructions for customizing document-handling and document flow capabilities using user exits. It also includes information about using APIs to automate certain administrative tasks. It includes the following information:

  • Information about extending and customizing the functionality of Partner Gateway by using user exit plug-ins to:
    • Add new transports
    • Modify certain configuration points for targets and gateways
    • Create and modify actions in variable workflow and handlers in fixed workflow.
  • Instructions for automating certain common administrative functions in Partner Gateway so that they can be carried out programmatically. For example, creating a participant without using the Community Console
  • Information about setting up event delivery to an external queue, so that monitoring applications can have access to Partner Gateway message and document events.
Enterprise Integration Guide

Describes how to integrate several kinds of back-end systems with Partner Gateway so that the back-end system can send and receive messages from Partner Gateway. It includes the following information:

  • 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 back-end integration packaging has been specified
    • An overview of how to plan for the integration process
    • How to configure Partner Gateway 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 with WebSphere Process Server.
  • Integration (over the HTTP or JMS transport protocol) with WebSphere Business Integration Message Broker
  • Integration with WebSphere Data Interchange
  • Information on how Partner Gateway routes EDI documents.
Mapping Guide

Provides information about installing and using Data Interchange Services client. It includes the following information:

  • Instructions for installing Data Interchange Services client
  • Information about using Data Interchange Services client to develop data transformation, validation, and functional acknowledgement maps for Partner Gateway to use when processing EDI documents, XML documents, and proprietary-format documents.
PIP samples

Provide descriptions of and instructions for using PIP samples provided with Partner Gateway.

Using Partner Gateway

The following document provides information about using Partner Gateway after it has been installed and configured.

Document Information provided
Participant Guide

Presents all the information needed by a trading community participant to exchange business documents with the hub using the Community Console. It includes the following information:

  • Instructions for setting up the environment, including verifying that your participant profile is correct, setting up gateways, reviewing B2B capabilities, obtaining and uploading certificates, creating users and groups, and defining alerts
  • Instructions for creating and configuring gateways
  • Information about managing and making changes to the environment
  • Instructions for using the viewers to monitor document exchanges
  • Instructions for using the Document Analysis tool.

Administering Partner Gateway

The following document provides information about administering Partner Gateway after it has been installed and configured.

Document Information provided
Administrator Guide

Provides step-by-step instructions for performing the day-to-day tasks necessary to manage the hub community. It includes the following information:

  • 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 about 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 Community Participant Simulator tool to simulate production traffic
  • Instructions for archiving documents
  • Troubleshooting tips
  • Performance considerations
  • Event code descriptions
  • Information about the contents of the component-specific properties files.

Copyright IBM Corp. 2003, 2005