Product Overview Guide En

8/14/2019 Product Overview Guide En

1/36

WebSphere IBMWebSphere Partner Gateway Enterprise andAdvanced Editions

Product Overview Guide

Version 6.2


2/36

NoteBefore using this information and the product it supports, read the information in Notices on page 27.

December 2008

This edition applies to version 6.2, release 0, modification 0 of IBM WebSphere Partner Gateway Enterprise Edition(product number 5724-L69) and version 6.2, release 0, modification 0 of Advanced Edition (product number5724-L68) and to all subsequent releases and modifications until otherwise indicated in new editions.

When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in anyway it believes appropriate without incurring any obligation to you.

Copyright International Business Machines Corporation 2007, 2008.US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.


3/36

Contents

Chapter 1. About this book . . . . . . 1Audience . . . . . . . . . . . . . . . 1

Typographic conventions . . . . . . . . . . 1Related documents . . . . . . . . . . . . 2

Chapter 2. New in release 6.2 . . . . . 3

Chapter 3. WebSphere product familyoverview . . . . . . . . . . . . . . 5System requirements. . . . . . . . . . . . 5About WebSphere . . . . . . . . . . . . 5

WebSphere Partner Gateway . . . . . . . . 6

Chapter 4. Key concepts and technicaloverview . . . . . . . . . . . . . . 7

WebSphere Partner Gateway architecture . . . . . 7Receiver component . . . . . . . . . . . 8Document Manager . . . . . . . . . . . 8Community Console. . . . . . . . . . . 9Database . . . . . . . . . . . . . . 10File System . . . . . . . . . . . . . 12Communication using WebSphere PlatformMessaging (WPM) . . . . . . . . . . . 12

Summary of supported protocols . . . . . . . 12

Configuration requirements . . . . . . . . . 13Receiver . . . . . . . . . . . . . . 13

Destination . . . . . . . . . . . . . 14Profile . . . . . . . . . . . . . . . 14Document definition . . . . . . . . . . 14Interaction. . . . . . . . . . . . . . 15B2B capabilities . . . . . . . . . . . . 15Partner connection . . . . . . . . . . . 15

Integration with enterprise systems . . . . . . 16Sample message flow . . . . . . . . . . . 17System configuration options . . . . . . . . 17

Chapter 5. Fast paths . . . . . . . . 21WebSphere Partner Gateway documentation . . . 22Code samples . . . . . . . . . . . . . 23Supported PIPs . . . . . . . . . . . . . 23

Chapter 6. Summary of supportedbusiness and transport protocols . . . 25

Notices . . . . . . . . . . . . . . 27Programming interface information . . . . . . 29Trademarks and service marks . . . . . . . . 29

Copyright IBM Corp. 2007, 2008 iii


4/36

iv IBM WebSphere Partner Gateway Enterprise and Advanced Editions: Product Overview Guide


5/36

Chapter 1. About this book

This document provides an overview of the IBM(R) WebSphere(R) Partner Gatewayproduct family and describes in detail about the WebSphere Partner Gateway

Enterprise and Advanced Editions.

Audience

This document is intended for the reader who wants an overview of theWebSphere Partner Gateway product. Chapter 5, Fast paths, on page 21 identifiesthe documents that provide more detailed information on installing, administering,and using WebSphere Partner Gateway.

Typographic conventions

This document uses the following conventions.

Convention Description

Monospace font Text in this font indicates text that you type,values for arguments or command options,examples and code examples, or informationthat the system prints on the screen(message text or prompts).

Bold Boldface text indicates graphical userinterface controls (for example, online buttonnames, menu names, or menu options) andcolumn headings in tables and text.

Italics Text in italics indicates emphasis, book titles,

new terms and terms that are defined in thetext, variable names, or letters of thealphabet used as letters.

Italic monospace font Text in italic monospace font indicatesvariable names within monospace-font text.

ProductDir ProductDir represents the directory wherethe product is installed. For example, IBMWebSphere Product Gateway will beinstalled in the default directory C:\ProgramFiles\IBM\bcghub-simple (for simple mode)on Windows platform. The defaultdirectories will change for different modesof installation. All WebSphere Business

Integration Adapters product path namesare relative to the directory where theproduct is installed on your system.

%text% and $text Text within percent signs (%) indicates thevalue of the Windows text system variableor user variable. The equivalent notation ina UNIX environment is $text, indicating thevalue of the text UNIX environmentvariable.

Copyright IBM Corp. 2007, 2008 1


6/36

Convention Description

Underlined colored text Underlined colored text indicates across-reference. Click the text to go to theobject of the reference.

Text in a blue outline (In PDF files only) An outline around textindicates a cross-reference. Click the outlined

text to go to the object of the reference. Thisconvention is the equivalent for PDF files ofthe Underlined colored text conventionincluded in this table.

(quotation marks) (In PDF files only) Quotation markssurround cross-references to other sectionsof the document.

{ } In a syntax line, curly braces surround a setof options from which you must choose oneand only one.

[ ] In a syntax line, square brackets surroundoptional parameters.

. . . In a syntax line, ellipses indicate a repetitionof the previous parameter. For example,option [, . . . ] means that you can entermultiple, comma-separated options.

< > Angle brackets surround variable elementsof a name to distinguish them from oneanother. For example,tmp.log.

\ / Backslashes (\) are used as separators indirectory paths in Windows installations. ForUNIX installations, substitute slashes (/) for

backslashes.

Related documents

The complete set of documentation available with this product includescomprehensive information about installing, configuring, administering, and usingWebSphere Partner Gateway Enterprise and Advanced Editions.

You can download this documentation or read it online at the following site:http://www.ibm.com/software/integration/wspartnergateway/library/

Note: Important information about this product might be available in technicalsupport technotes and flashes issued after this document was published. These can

be found on the WebSphere Partner Gateway Support Web site,http://www.ibm.com/software/integration/wspartnergateway/support/. Selectthe component area of interest and browse the Technotes and Flashes sections.

2 IBM WebSphere Partner Gateway Enterprise and Advanced Editions: Product Overview Guide
http://www.ibm.com/software/integration/wspartnergateway/library/http://www.ibm.com/software/integration/wspartnergateway/support/http://www.ibm.com/software/integration/wspartnergateway/support/http://www.ibm.com/software/integration/wspartnergateway/library/


7/36

Chapter 2. New in release 6.2

WebSphere Partner Gateway V6.2 supports the following new features:

v Integration with WebSphere Transformation Extender using WebSphere PartnerGateways extensibility framework

v ISA V4 support for log file collection and transmission

v Certificate upload and configuration enhancements

v Links to error messages with message details

v WebSphere Partner Gateway First Steps page enhancements

v Scripts to update WebSphere Partner Gateway settings for relocation andredeployment

v Ability to run installation verification test (IVT) at the end of WebSphere PartnerGateway component installation

v Ability to export and import complete WebSphere Partner Gatewayconfiguration

v Support for auto-upgrade to minimize manual upgrade effort

v Console based archiver with scheduler

v Ability to federate into an existing WebSphere Application Server cell

v Support for Secure File Transfer Protocol (SFTP)

v CPP/CPA Editor for ebXML Message Service (ebMS)

v Improved archiver performance

v Improved document throughput performance for AS2 and large files

For more details about the new 6.2 features, see http://www-01.ibm.com/software/integration/wspartnergateway/about/

http://www-01.ibm.com/software/integration/wspartnergateway/about/http://www-01.ibm.com/software/integration/wspartnergateway/about/http://www-01.ibm.com/software/integration/wspartnergateway/about/http://www-01.ibm.com/software/integration/wspartnergateway/about/


8/36



9/36

Chapter 3. WebSphere product family overview

This chapter describes how WebSphere Partner Gateway fits into the WebSphereproduct family.

System requirements

For a full listing of system requirements see the WebSphere Partner Gatewaysystem requirements page: http://www-01.ibm.com/software/integration/wspartnergateway/sysreqs/

About WebSphere

IBM WebSphere is the leading software platform for e-business. It includes morethan 150 Internet infrastructure software or middleware products designed to help

businesses become on demand e-businesses. The WebSphere product family

featuresbroad support for open standards. Its products include application servers,messaging software, business integration tools, portal creation tools, and integrateddevelopment environments for creating Web-based business applications.

The WebSphere platform can help you to:

v Accelerate the delivery of products and services.

v Respond quickly to market changes and customer demand.

v Integrate and automate business processes.

v Create portals to simplify access to information and applications.

v Reuse existing and legacy assets.

Figure1. HowWebSpherePartnerGateway fits into theWebSphereproduct family

http://www.ibm.com/software/integration/wspartnergateway/sysreqs/http://www.ibm.com/software/integration/wspartnergateway/sysreqs/http://www.ibm.com/software/integration/wspartnergateway/sysreqs/http://www.ibm.com/software/integration/wspartnergateway/sysreqs/


10/36

WebSphere Partner GatewayWebSphere Partner Gateway is layered with other WebSphere products to buildcomprehensive, flexible business integration solutions to enable enterprises andtheir trading partners to exchange business documents. Through the use of

back-end systems such as WebSphere Process Server, WebSphere Message Brokeror WebSphere InterChange Server, business information contained in the

exchanged documents is easily integrated with business-critical applications.



11/36

Chapter 4. Key concepts and technical overview

This chapter provides a brief technical overview of WebSphere Partner Gateway, itsmain components, and its architecture.

It consists of the following topics:

v WebSphere Partner Gateway architecture gives an overview of the architectureof WebSphere Partner Gateway and its major run-time components.

v Summary of supported protocols on page 12 lists the transport, messaging,and business protocols supported by WebSphere Partner Gateway. Otherprotocols can be supported through customization.

v Configuration requirements on page 13 provides an overview of theWebSphere Partner Gateway components you need to configure when youestablish a trading community.

v Integration with enterprise systems on page 16 discusses the different optionsfor integrating WebSphere Partner Gateway with a back-end system.

v Sample message flow on page 17 describes the sequence of steps involved in asample exchange of documents between an external partner and the InternalPartner.

v System configuration options on page 17 discusses the different ways toconfigure WebSphere Partner Gateway for scalability, performance, and fail-oversupport.

WebSphere Partner Gateway architecture

The runtime environment of WebSphere Partner Gateway consists of the followingcomponents:

v

The Receiver handles secure and reliable receipt of documents over thesupported transport protocols.

v The Community Console provides user interface for internal and externalpartners to access WebSphere Partner Gateway console. The internal partner canview the entire community. External partners have a more limited view, whichallows them to modify their profiles and monitor the flow of their documents.

v The Document Manager, consisting of one or more routing and processingsubcomponents. These components implement the reliable routing, validation,translation services, and document delivery within WebSphere Partner Gateway.

v Messaging infrastructure is used to route messages and events to other internalcomponents within the system.

Figure 2 on page 8 shows how the components work together:



12/36

The sections that follow describe in more detail the runtime components as well asother key elements of WebSphere Partner Gateway.

Receiver componentThe Receiver component accepts and stores documents from external partners andfrom back-end systems. Specifically, the Receiver does the following:

v Receives a document over a transport protocol.

v Writes the document and meta data including transport data relating to thedocument to shared file services.

v Completes any transport-specific technical acknowledgment (for example,

sending a 200 response to an HTTP POST).v If synchronous response is configured, the receiver sends synchronous response

to the sender.

Document ManagerThe Document Manager retrieves stored data, processes it, and routes it, both toexternal partners and to enterprise back-end systems (the Internal Partner).Specifically, it:

1. Reads the raw document and metadata and allows for the option of saving theinbound document to the non-repudiation directory on shared storage

Externalpartner

Externalpartner

Externalpartner

WebSphere PartnerGateway

SMTPSFTP / FTP SFTP

Internet

ReceiverDocumentManager

High availabilitynetwork attached stroage

Console DB2database

Back-end system

SFTPHTTPJMSFile-based

HTTP(S)

SFTPHTTPJMSFile-based

HTTP(S)

Figure2. WebSpherePartnerGateway runtimecomponents



13/36

2. Processes the data to the destination format (performing tasks such asvalidation and transformation, if specified) and allows for the option of savingthe destination document to the non-repudiation directory on shared storage

3. Delivers data to its intended destination, which could be a JMS queue, adirectory, or a URL.

The following sections describe how the subcomponents of the Document Managerperform the tasks presented in the previous list.

Document Processing EngineThe Document Processing Engine performs all of the processing of documents. TheDocument Processing Engine is responsible for:

v Unpacking documents, including decompression, decryption, and signatureverification.

v Ensuring that the source of the document is authorized

v Filtering out duplicate documents

v Validating the structure and content of the document

v Translating the document into the format required by the destination

v Packaging the document for the destination, including signing, encryption, andcompression, if required.

v Storing both the original inbound document and the final outbound documentin the non-repudiation repository

v Passing the packaged document to the outbound transport engine

State EngineThe State Engine encapsulates the business rules on a per-protocolbasis andexecutes instructions based on those rules. For example, the State Engine initiates aretry if no acknowledgment is received in the defined interval.

Alert Engine

The Alert Engine monitors activity and generates e-mail notifications. You canconfigure the Alert Engine to specify which alerts are generated, to whom thealerts are sent, and when the alerts are delivered.

Delivery ManagerThe Delivery Manager component is responsible for transporting documents tospecific destinations, maintaining a separate queue of documents for eachdestination. A dedicated transport mechanism exists for each destination, soproblems delivering to one destination should not affect transport to otherdestinations.

Community ConsoleThe Community Console is the user interface for configuring, administering, and

monitoring trading community activities, and responding to events. Its users areprimarily: the Hub Administrator, the internal partners, and external partners. Theconsole provides role-based access control to the various features and views.

The features of the console include:

v Administration of system configuration data.

v Screens for configuring the hub community and for managing partners.

v Tools for monitoring business-process events and exceptions

v Detailed reports and analysis on business process, trend, and exception activity

Chapter 4. Key concepts and technical overview 9


14/36

v Tools to troubleshoot document processing

v An interface that allows you to drill down to events and raw documents

v A command-line interface for migrating certain partner and hub configurationdata from one system to another

ProfileThe changes to partner profile information occur only when profiles are added ordeleted, or when an existing profile is updated. See Profile on page 14 for moreinformation.

DestinationA destination is an exit point out of WebSphere Partner Gateway. It is used byWebSphere Partner Gateway to deliver documents to a back-end system or atrading partner. For example, when sending a document to a partner, yourWebSphere Partner Gateway server needs a destination that points to a URLconfigured on your partners server. In this case, the destination points to a remotetarget on the partners server. However, a destination can also point to a resourcein an internal network, such as a JMS queue configured as the input queue forWebSphere Message Broker.

A destination is defined by a destination definition, which includes a destinationURI, optional login information, and transport-level settings for the destination.

Partner connectionConnections define valid connections between an external and internal partner.They include information about the document protocol, document type, sendingpartner, receiving partner, connection type, and source and destination. TheDocument Manager uses the information in the connection to determine iftranslation is required and to determine the destination information. See Partnerconnection on page 15 for more information.

DatabaseA prerequisite DB2 Universal Database Enterprise or Oracle database is used as thedata repository. BDO (Business Document Object) contains the VMD and VHDdata (Meta data, and Transport header data), and is run-time stored into thedatabase. It is used to store data that can be classified in three broad categories:

v System configuration settings

v Profile information

v State management information

The database stores system-wide configuration settings that are accessed by theindividual system components, as well as partner profile information and eventlogs. A single document exchange results in the logging of many events to capturethe state transitions of the document.

All information configured through the Community Console is stored in thedatabase.

The data repository is also where guidelines and maps (for validation andtranslation) are stored, where the state of various processes is recorded, and wheretrading activity is tracked.

The information stored in the data repository is used by WebSphere PartnerGateway to provide the administrator with visibility into the entire tradingcommunity.



15/36

Note that some information (for example, the raw message data in thenon-repudiation and message stores) is kept on the shared file system, as describedin File System on page 12.

The database is used to store the following types of information.

Certificates and IP addresses

The following security information is stored:v Certificate information used to authenticate the sending External Partner based

on the client certificate used during the SSL connection

v Certificates used for encryption, digital signature and SSL/TLS.

v IP addresses used to confirm that the source IP address is correct and thatdocuments can be posted from that address.

Alerts configurationAlerts are defined at a partner level and consist of a variety of attributes todescribe event-based alerts or volume alerts.

You can define event-based alerts so that they will be triggered each time the event

occurs or so that they will batched, based on an interval. You can also configurethe alert with a contact list for notification based on a defined schedule.

Document definitions and connectionsThe part of the database that stores the document definitions known to WebSpherePartner Gateway and the allowed document interactionsbetween the External andInternal partners.

Document activityWebSphere Partner Gateway logs information to describe documents as they arerouted. Details are logged about the document as it was received and as it wastransmitted. The following types of information are logged:

v The format of the document, including the source partner, destination partner,

source protocol, destination protocol, source document type, and destinationdocument type.

v Metrics for the size of the document, the time it was received, and transmitted.

v The state that is logged against a document, describing whether it wastransmitted to the partner.

Document eventsWebSphere Partner Gateway uses events to track activities and logs the events in acentral event log. The events, which are classified as Informational, Warning, orCritical Errors, can be generated by different components in WebSphere PartnerGateway.

Events can be tied back to document activity when they are in relation to adocument that was routed by WebSphere Partner Gateway. The events can alsotrack non-document related activities, such as logging into the system.

Summary dataWebSphere Partner Gateway summarizes key metrics, which can be displayed inthe console. The information that is summarized includes:

v The number of documents received, sent, and failed. These counts aresummarized by certain attributes by hour.



16/36

v The number of events generated. These counts are summarized by certain detailattributes by hour.

These counts are rolled up by hour and canbe correlated back to the documentactivity logs.

File SystemThe following information is stored in the shared file system:

Non-Repudiation dataDocuments are stored on a disk that has shared access from all components ofWebSphere Partner Gateway (Receiver, Console, and Document Manager). Both theoriginal document (as it was received) and the final document (as it was sent) arestored.

Message dataDocuments are stored for displaying to the console. This disk also has sharedaccess from all components of WebSphere Partner Gateway (Receiver, Console, andDocument Manager).

Security artifactsThe Certificate Revocation List (CRL), Virtual Trading Partner (VTP) certificate andkey are stored in the file system.

Communication using WebSphere Platform Messaging (WPM)Communication between some components is done using WPM. WPM queueswith reliable storage allow the flexibility of locating components on differentmachines while still maintaining a standard inter-component communicationmethod.

Summary of supported protocols

WebSphere Partner Gateway includes built-in support for the following transport,messaging, and business protocols. However, with customization, WebSpherePartner Gateway can support virtually any customer-required protocol.

v Transport protocols: documents can be exchanged with partners over any of thefollowing transports:

HTTP or HTTPS

FTP or FTPS

FTP scripting

JMS

SMTP

File-directory-based

SFTP

Custom.

v Business protocols:

AS1, AS2 and AS3

RosettaNet 1.1 and 2.0

SOAP 1.1 (Web services)

SOAP with Attachments

cXML 1.2.009



17/36

CIDX 4.0

ebMS 2.0

Custom.

v Data types:

EDI X12 and EDIFACT

XML

cXML 1.2.009

Custom XML

Flat files

Binary format

Custom.

The following illustration shows the numerous supported transports for integratingtrading partners with WebSphere Partner Gateway, and WebSphere PartnerGateway with a back-end system.

Configuration requirements

The configuration process defines the particular transports, messaging protocols,and business protocols the trading community will support. It also defines thetrading external partners, as well as the specific types of documents and protocolsvalid for each partner to send and receive. To make configuration easier,

WebSphere Partner Gateway comes with predefined configuration elements for allof the industry-standard protocols and formats it supports.

The following elements need tobe configured. For detailed configurationinformation, see the WebSphere Partner Gateway Hub Configuration Guide.

ReceiverA receiver is an entry point into WebSphere Partner Gateway. It is an instance of atransport configuration configured for a particular deployment. You may havemultiple receivers configured. For example, you may configure multiple JMS

Figure3. Supportedtransports for integrating tradingpartnerswithWebSpherePartnerGateway, andWebSpherePartnerGatewaywitha back-endsystem.



18/36

receivers. Each JMS receiver can be configured to poll for inbound documents onseparate inbound queues. Each receivers configuration specifies which inboundqueue the target polls.

A receiver listens or polls for new documents to be processed by WebSpherePartner Gateway. For example, it can poll a folder on the file system, a JMS queue,or listen on an HTTP URL for incoming documents from business partners or from

a back-end system. A receiver is used for both inbound and outbound flows.Inbound are coming into WebSphere Partner Gateway and outbound are leavingWebSphere Partner Gateway.

DestinationA destination is an exit point out of WebSphere Partner Gateway. It is used byWebSphere Partner Gateway to deliver documents to a back-end system or atrading partner. For example, when sending a document to a partner, yourWebSphere Partner Gateway server needs a destination that points to a URLconfigured on your partners server. In this case, the destination points to a remotetarget on the partners server. However, a destination can also point to a resourcein an internal network, such as a JMS queue configured as the input queue for

WebSphere Message Broker.

A destination is defined by a destination definition, which includes a destinationURI, optional login information, and transport-level settings for the destination.

ProfileA profile is required for each trading external partner as well as the InternalPartner. The profile holds partner data, routing information, and console-accessauthorizations. The partner profile consists of partner information, configurationdata for document routing, and console access authorizations. The profile includesinformation such as:

v Partner data

v Usersv Contacts.

The partner data includes partner names and business identifiers such as DUNSnumbers. A single partner can have one or more business identifiers.

Users are accounts that have access to the WebSphere Partner Gateway console. Auser account gets its permissions to interact with the console based on groupmembership.

Contacts are similar to users; however, they cannot interact with the console, andthey can only be configured to receive notifications from the alert system.

Document definitionA document definition must be defined for each type of document tobe processed

by WebSphere Partner Gateway. The document definition gives information to thehub about how to process the document:

v The packaging that surrounds the document

v The business protocol that defines the document

v The document type

v Activity



19/36

v Action.

There are several parts to a document definition. A package defines how adocument is to be packaged per a specification for the transport, such as AS2. Aprotocol describes the general standard that a document adheres to, such asEDI-X12. The term document type describes the specific document such as apurchase order or invoice. All of these parts have attributes that may apply,

providing the runtime the information required to help process the document.

InteractionAn interaction specifies how the document is processed through WebSpherePartner Gateway independent of any partners.

The interaction defines for a received document (package, protocol, and ordocument type) :

v The document to send (package, protocol, and or document type)

v The actions to be performed on a document and, optionally, the Transformationmap to use.

B2B capabilitiesB2B capabilities identify to WebSphere Partner Gateway the specific documenttypes each trading external partner and internal partner is authorized to send andreceive. Depending on the document type, some characteristics can be set on howthe Internal Partner wants to send or receive the document (as pertains to thepartner). A partners B2B capabilities are defined as:

v The valid document definitions for documents to be sent by the partner

v The valid document definitions for documents to be received by the partner.

v Any document attributes specific to the partner.

Note: Attribute values set in the B2B capabilities take precedence over the

document definition attribute values.

You need to specify the B2B capabilities for each partner by selecting the applicabledocument definitions from the pool that has been defined for the tradingcommunity.

Partner connectionA partner connection specifies a valid type of document exchange between externalpartner to internal partner and internal partner to external partners. The partnerconnection is an interaction that has been associated with specific sending andreceiving partners. A partner connection also specifies the gateways and otherrouting information necessary for that exchange.

WebSphere Partner Gateway derives a list of valid partner connections fordocument exchange between the partner and the Internal Partner using the definedInteractions and partner B2B capabilities.

From the list of valid connections, you need to activate those connections that areactually needed by the partner to send or receive its business documents.



20/36

Integration with enterprise systems

Each edition of WebSphere Partner Gateway provides the ability to connect toWebSphere Data Interchange back-end integration systems. WebSphere PartnerGateway - Express provides file-based integration, while WebSphere PartnerGateway Enterprise and Advanced Editions provide both file-based integration andintegration over WPM and other internet based transports.

WebSphere Partner Gateway is the entry point for documents coming into theenterprise. It validates, transforms, and otherwise processes the documents, basedon their type, and passes them on to a back-end system that integrates theinformation with other applications. The back-end system can be an integration

broker like one of the following:

v WebSphere Process Server

v WebSphere InterChange Server

v WebSphere Message Broker

The back- end system can also be a customer-developed system.

A document intended for WebSphere Process Server can be sent to WebSpherePartner Gateway by an external partner in a variety of formats such as XML, EDI,

Figure4. Document flowover the internet oraVANthroughWebSpherePartnerGateway toWebSphereProcessServer



21/36

RosettaNet, or binary. WebSphere Partner Gateway can send the document (aftertransformation, if necessary) to ICS through the HTTP or JMS transport protocol.

Integration with back-end systems is described in more detail in the WebSpherePartner Gateway Enterprise Integration Guide.

Sample message flowThe scenariobelow describes the sequence of events in a WebSphere PartnerGateway document exchange scenario.

In this scenario, a partner sends an AS2 packaged XML document payload overHTTP. WebSphere Partner Gateway unpackages the document extracting the XMLpayload, validates the payload and sends the payload to the back-end using JMStransport. The WebSphere Partner Gateway also sends back an Message DataNotification (MDN) receipt to the partner.

1. The AS2 request with the XML document is received by the Receivercomponent of WebSphere Partner Gateway.

2. The Receiver saves the document to persistent shared storage. This is aconfigurable option.

3. The Receiver returns an HTTP 200 response to the external partner.

4. The Document Processing Engine processes the document, which includes:

a. Performing decryption, decompression, and signature verification.

b. Performing authentication and duplicate checks

c. Determines the sending and receiving partners based on the business IDs

d. Determines the payload document type

e. Based on the sending and receiving partners, AS2 packaging and the XMLdocument type for the partner connection is looked up.

f. From the partner connection, the Action, Transformation Map (if specified),

the document type to send, document attribute values, and destinations aredetermined.

g. Performs structural validation per the Action that was specified.

h. Adds packaging information such as back-end integration per the documenttype tobe sent.

i. Saves the final packaged document to the non-repudiation database. This isa configurable option.

5. The Delivery Manager sends the document (in this case, using the JMStransport) to the back-end system

6. A message disposition notification (MDN) is sent to the External Partner.

7. The External Partner acknowledges the receipt of the MDN by sending anHTTP 200.

System configuration options

The component-based structure of WebSphere Partner Gateway means that it canbe configured in variety of ways to meet the needs of your business. You canchoose everything from a single server configuration to a clustered configurationfor high performance or failover support.



22/36

For example, you can install the WebSphere Partner Gateway components on oneserver and the prerequisite programs on another server, or you can divide thecomponents and programs among several servers.

To achieve scalability and high performance, you might divide the componentsand programs among six servers. The following illustration shows such aconfiguration. Two servers contain instances of the Receiver and the Console, two

servers contain the Document Manager and one server contains the DB2 database.Firewalls are set up between the WebSphere Partner Gateway servers and othersystems as illustrated. Note that network-attached storage, while recommended, isnot required.

All of the components in WebSphere Partner Gateway are designed to scale bothhorizontally and vertically, where horizontal scaling is characterized as runningmultiple instances across multiple servers, and vertical scaling is characterized asadding processing power to a single server.

Having the ability to run any of the components on any server allows for greaterflexibility with regard to scaling the system. I/O or compute-intensive componentscan be deployed on servers optimized for their needs. Also, the shared work queuemechanism allows each component to scale independently of other components.

Figure5. A sampleWebSpherePartnerGatewayconfiguration.



23/36

WebSphere Partner Gateway is compliant with FIPS such that it can be run ineither FIPS mode or non-FIPS mode.



24/36


25/36

Chapter 5. Fast paths

This section describes, at a high-level, the tasks involved in setting up and runninga WebSphere Partner Gateway trading community. It also references

documentation, code samples, and PIP information, you might need to help youget started.

The major steps required to establish a WebSphere Partner Gateway tradingcommunity are the following:

1. Analyze the needs of your enterprise and trading partners:

v Identify the types of documents that will be sent and received.

v Examine the content of the documents that will be exchanged and determinehow this data needs to be processed.

v For each document exchange scenario between an external partner and theInternal Partner, identify every action that needs to be performed on thedocument and its contents on its path from the sender, to WebSphere Partner

Gateway, to the back-end system, and finally to the business application.v Identify any documents that will require customized processing and

determine the customization you need to make to support those documents.Explore customization options and decide whether you will need tocustomize any document-handling or workflow.

v If necessary, work with trading partners to modify the formats or protocolsof their business documents to enable their participation in the tradingcommunity.

v Use the Data Interchange Services client to create validation andtransformation maps for document content that requires them.

2. Plan the trading community:

v

Estimate the volume of documents that will be exchangedv Determine the number of WebSphere Partner Gateway instances you need to

deploy.

v Determine your security requirements. Assess whether your installationrequires a reverse proxy server.

v Determine how you will integrate WebSphere Partner Gateway with yourback-end system.

v Define the process you will follow for connecting businesses to the tradingcommunity.

v Consider how you will adjust the community to respond to changingbusiness needs.

3. Install WebSphere Partner Gateway.

4. Configure the hub and define external partners.

5. Perform administrative tasks as needed to maintain the trading community.

The documentation available to help you perform these tasks is listed below.



26/36

WebSphere Partner Gateway documentation

The Information Center for WebSphere Partner Gateway Enterprise and AdvancedEditions includes the following documents:

Table1. Documentationset forWebSpherePartnerGatewayEnterpriseandAdvanced

Editions

Book Description and purpose

WebSpherePartner Gateway6.2 InformationRoadmap

Presents an overview of the documentation set.

WebSpherePartner Gateway6.2 ProductOverview

Presents an overview of WebSphere Partner Gateway Enterprise andAdvanced Editions, and how they fit into the broader WebSphere familyof products.

WebSpherePartner Gateway6.2 InstallationGuide

Leads you through the process of planning for and installing WebSpherePartner Gateway.

WebSpherePartner Gateway6.2 HubConfigurationGuide

Provides step-by-step instructions for configuring the tradingcommunity hub and defining external partners. Once you have installedWebSphere Partner Gateway, proceed to this book.

WebSpherePartner Gateway6.2 AdministratorGuide

Explains how to perform the administrative tasks needed to maintainthe trading community.

WebSpherePartner Gateway6.2 Enterprise

Integration Guide

Describes how to integrate WebSphere Partner Gateway with a back-endsystem such as WebSphere Process Server, WebSphere InterChangeServer or WebSphere Message Broker.

WebSpherePartner Gateway6.2 ProgrammerGuide

Explains how to create user exits to customize document-handling andworkflow processing in WebSphere Partner Gateway.

WebSpherePartner Gateway6.2 MappingGuide

Provides guidance and task-level information about using the DataInterchange Services client to create validation and transformation maps.

WebSpherePartner Gateway6.2 Partner Guide

Covers information an external partner needs to participate in aWebSphere Partner Gateway trading community.

WebSpherePartner Gateway6.2 PIP Samplefor InterChangeServer (ICS)

The PIP Sample demonstrates how to set up WebSphere PartnerGateway and WebSphere InterChange Server to exchange messageswhen you implement WebSphere InterChange Server as the back-endsystem. Supported PIPs are included on the product CD. See SupportedPIPs on page 23 for more information.

WebSpherePartner Gateway6.2 PIP Samplefor WebSphereProcess Server(WPS)

The PIP Sample demonstrates how to set up WebSphere PartnerGateway and WebSphere Process Server to exchange messages whenyou implement WebSphere Process Server as the back-end system.Supported PIPs are included on the product CD. See Supported PIPson page 23 for more information.



27/36

Table1. Documentationset forWebSpherePartnerGatewayEnterpriseandAdvanced

Editions (continued)

Book Description and purpose

Glossary Presents definitions of terms used in the documentation.

Code samplesTo help you configure and customize WebSphere Partner Gateway to meet therequirements of your enterprise, the code samples listed in Table 2 are provided onthe product CD.

Table2. Descriptionand locationof codesamples includedwithWebSpherePartner

Gateway.

Description of sample Location on product CD

Back-end integration with ICS:HTTP Adapter with RNIF.

Integration/WBI/WICS/samples/RosettaNet/HTTP

Back-end integration with ICS:JMS Adapter with RNIF.

Integration/WBI/WICS/samples/RosettaNet/JMS

Back-end integration with ICS:JMS integration with ICS.

Integration/WBI/WICS/samples/JMS

Back-end integration with ICS4.2.2 using the Adapter forHTTP.

Integration/WBI/WICS/samples/HTTP

Back-end integration withWebSphere Message Broker.

Integration/WBI/WBIMB/samples

In-line integration withWebSphere TransformationExtender

Integration/WebSphereTransformationExtender/samples

Use of administrative APIs for

trading partner managementand systems administration.

DevelopmentKits/AdministrativeAPI/samples

Use of user exits to customizeworkflow anddocument-handling.

DevelopmentKits/UserExits/samples

Use of configuration import andexport.

DevelopmentKits/Migration/samples

Back-end integration withWebSphereProcessServer: Using

JMS

Integration/WBI/WebSphereProcessServer/JMS

Back-end integration withWebSphereProcessServer: Using

JMS for RNIF

Integration/WBI/WebSphereProcessServer/PIP

Supported PIPs

Supported PIPs are located in the directory, B2BIntegrate\rosettanet on theproduct CD as well as in the WebSphere Partner GatewayHub Configuration Guide.

The WebSphere Partner Gateway 6.2 PIP Samplefor WebSphere Process Serverdocument gives an example of how to set up WebSphere Partner Gateway andWebSphere Process Server to exchange messages when WebSphere Process Server

Chapter 5. Fast paths 23


28/36

is used as the back-end system and the WebSphere Partner Gateway 6.2 PIP Samplefor InterChange Server document shows and example of how to set up WebSpherePartner Gateway and WebSphere InterChange Server to exchange messages whenWebSphere InterChange Server is used as the back-end system.



29/36

Chapter 6. Summary of supported business and transportprotocols

This appendix summarizes the supported transport and business protocols

included with WebSphere Partner Gateway. Through the use of user exits, theproduct can also be customized to support additional protocols. See theProgrammer Guide for more information about customization options.

Table3. Summaryof support forXML andBinaryprotocolsprovidedbyWebSpherePartnerGateway.

XML Binary

Supported version N/A N/A

Synchronous transactions? Yes No

Support for passthrough only orsupport for protocol and documenttranslation?

Both business protocol and documenttranslation supported for XML (XSLT).

No

Attachments supported? No No

Specific transactions supported? N/A N/A

Security FTP/S, HTTP/S (HTTP Basic authenticationis supported for outbound and receiveddocuments. In case of outbound documents,the user name and password is specified inthe HTTP destination for the documentssent over HTTP.)

No

Communication between hub andpartners

v JMS

v HTTP/S

v FTP/S

v File directory

v SMTP

v SFTP

v JMS

v HTTP/S

v FTP/S

v File directory

v SMTP

v SFTP

Back-end integration optionsv JMS

v HTTP/S

v File directory

v SMTP

v SFTP

v JMS

v HTTP/S

v File directory

v SMTP

v SFTP

Samples provided?Yes. See Code samples on page 23. No

Table4. Summaryof support forAS1, AS2, AS3, RosettaNet, SOAP, andcXML protocolsprovidedbyWebSphere

PartnerGateway.

AS1 AS2 AS3 RosettaNet SOAP ebMS cXML

Supportedversion

N/A N/A N/A RNIF 1.1 and 2.0v SOAP

Version 1.1

v WSDLVersion 1.1

RNIF 1.1 and2.0

Version 1.2.009is preloaded.



30/36

Table4. Summaryof support forAS1, AS2, AS3, RosettaNet, SOAP, andcXML protocolsprovidedbyWebSphere

PartnerGateway. (continued)

AS1 AS2 AS3 RosettaNet SOAP ebMS cXML

Synchronoustransactions?

N/A MessageDispositionNotification(MDN) only.

N/A Yes Both requestonly andrequest-responseoperations are

supported.

Yes Both cXMLasynchronousandrequest-response(synchronous)

are supported.Support forpassthroughonly or supportfor protocol anddocumenttranslation?

Bothbusinessprotocol anddocumenttranslationsupported

Both businessprotocol anddocumenttranslationsupported

Both businessprotocol anddocumenttranslationsupported

Both business protocoland documenttranslation supportedfor RNIF to RNSC andRNSC to RNIF..

Passthroughonly

Both businessprotocol anddocumenttranslationsupported forRNIF to RNSCand RNSC toRNIF, and otherdocument typesare supported.

Passthroughsupport isprimary usage;however,documenttranslation ispossible, butwill change the

behavior forsynchronouscXML.

Attachmentssupported?

No No No Yes Yes Yes Yes

Specifictransactionssupported?

N/A N/A N/A See Supported PIPson page 23.

Support forRPC anddocumentstyles

See SupportedPIPs on page23.

Passthrough-support only isavailable forPunctuatemessages.

Security

Businessencryptionwith tripleDES

Digitalsignaturehashing withSHA-1 orMD5

SSL Connectionwith Server and

ClientAuthentication

Businessencryption withtriple DES

Digitalsignaturehashing withSHA-1 or MD5

SSL Connectionwith Server

and ClientAuthentication

Businessencryption withtriple DES

Digital signaturehashing withSHA-1 or MD5

SSL Connection withServer and

Client Authentication

Business encryptionwith triple DES andRC2-40

Digital signaturehashing with SHA-1 orMD5

SSLConnectionwith Serverand ClientAuthentication

SSL Connectionwith Server andClient

Authentication

Businessencryption withtriple- DES,AES, RC2, andDES.

Digitalsignature

hashing withDSA-SHA 1 orRSA-SHA 1.

SSL Connectionwith Server

and ClientAuthentication

Communicationbetween huband partners

SMTP HTTP/S FTP/S HTTP/S HTTP/S HTTP/S HTTP/S

Back-endintegrationoptions

Payload onlyusing:

v JMS

v HTTP/S

v Filedirectory

v JMS

v HTTP/S

v File directory

v JMS

v HTTP/S

v File directory

v JMS (when usingRNSC)

v HTTP/S

HTTP/Sv JMS (when

using RNSC)

v HTTP/S

HTTP/S

Samplesprovided? No No No Yes. See Code

samples on page 23.No No No



31/36

Notices

IBM may not offer the products, services, or features discussed in this document inall countries. Consult your local IBM representative for information on the

products and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right may

be used instead. However, it is the users responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not give youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM Corporation

North Castle DriveArmonk, NY 10504-1785U.S.A.

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or program(s) described in this publicationat any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Burlingame Laboratory DirectorIBM Burlingame Laboratory



32/36

577 Airport Blvd., Suite 800Burlingame, CA 94010U.S.A

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement, or any equivalent agreement

between us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurement may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not necessarily tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

This information may contain examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples may includethe names of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

All statements regarding IBMs future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

COPYRIGHT LICENSE

This information may contain sample application programs in source language,which illustrates programming techniques on various operating platforms. Youmay copy, modify, and distribute these sample programs in any form withoutpayment to IBM, for the purposes of developing, using, marketing or distributingapplication programs conforming to the application programming interface for theoperating platform for which the sample programs are written. These exampleshave not been thoroughly tested under all conditions. IBM, therefore, cannot

guarantee or imply reliability, serviceability, or function of these programs.

Websphere Partner Gateway contains code named ICU4J which is licensed to youby IBM under the terms of the International Program License Agreement, subjectto its Excluded Components terms. However, IBM is required to provide thefollowing language to you as a notice:

COPYRIGHT AND PERMISSION NOTICE

Copyright (c) 1995-2008 International Business Machines Corporation and others



33/36


34/36

Microsoft, Windows, Windows NT, and the Windows logo are trademarks ofMicrosoft Corporation in the United States, other countries, or both.

MMX, Pentium, and ProShare are trademarks or registered trademarks of IntelCorporation in the United States, other countries, or both.

Solaris, Java, and allJava-based trademarks are trademarks of Sun Microsystems,

Inc. in the United States, other countries, or both.

Linux is a trademark of Linus Torvalds in the United States, other countries, orboth.

Other company, product or service names may be trademarks or service marks ofothers.

WebSphere Partner Gateway Enterprise and Advanced Editions includes softwaredeveloped by the Eclipse Project (www.eclipse.org)

http://www.eclipse.org/http://www.eclipse.org/


35/36


36/36

Printed in USA