Contents

About this document
Audience
Typographic conventions
Related documents
New in this release
New in release 6.0
New in release 4.2.2 Second Edition
New in release 4.2.2
Customizing WebSphere Partner Gateway: user exits
User exits overview
Receiving a document
Processing a document
Fixed inbound workflow
Variable workflow
Fixed outbound workflow
Sending a document
Customizing receivers
Overview for creating new receivers
Receiver flow
Receiver types
Multiple box deployment
Overview for creating new receiver handlers
Development and deployment
Development environment
Deployment and packaging (receivers)
Descriptor file definition for a receiver transport
Descriptor file definition for a receiver transport handler
Reserved attribute names
APIs and example code for receivers and receiver handlers
ReceiverInterface
ReceiverDocumentInterface
ReceiverFrameworkInterface
Asynchronous request
Blocking synchronous request
Nonblocking synchronous request
ReceiverConfig
ResponseCorrelation
BCGReceiverException
ReceiverPreProcessHandlerInterface
ReceiverSyncCheckHandlerInterface
ReceiverPostProcessHandlerInterface
BCGReceiverUtil
Events
Informational events
Warning events
Error events
Example receiver implementation outline
Customizing fixed and variable workflow
Overview for creating handlers in fixed inbound workflow
Protocol unpackaging handlers
Protocol processing handlers
Overview for creating actions in variable workflow
Creating steps
Actions supplied by WebSphere Partner Gateway
Overview for creating handlers in fixed outbound workflow
Protocol packaging handlers
Development and deployment
Development environment
Deployment and packaging
APIs and example code for workflow handlers and steps
From com.ibm.bcg.bcgdk.workflow
BusinessProcessFactoryInterface
BusinessProcessInterface
BusinessProcessHandlerInterface
AttachmentInterface
BusinessProcessUtil
From com.ibm.bcg.bcgdk.services
SecurityServiceInterface
MapServiceInterface
SignInfo
BCGSecurityException
From com.ibm.bcg.bcgdk.common
Context
Config
BusinessDocumentInterface
BCGException
BCGUtil
EventInfo
BCGDocumentConstants
Constants used in protocol unpackaging and protocol packaging steps
Constants used in protocol processing and protocol packaging steps
Sender status constants
Document state constants
Receiver constants
Other constants
Events
Events that can be logged from the protocol unpackaging handler
Events that can be logged from the protocol processing handler
Events that can be logged from user-defined actions and steps
Events that can be logged from the protocol packaging handler
Security and other events
Example handlers and steps implementation outline
Protocol processing handler
Protocol unpackaging handler
Transformation step
Customizing senders
Overview for creating new senders
The Sender/Sender Framework flow
Sender architecture
Overview for creating new sender handlers
Development and deployment
Development environment
Deployment and packaging (senders)
APIs and example code for senders and sender handlers
SenderInterface
SenderResult
SenderPreProcessHandlerInterface
SenderPostProcessHandlerInterface
BCGSenderException
Events
Informational events
Warning events
Error events
Implementation outlines for an example sender
Example sender
End-to-end flow: an overview for using user exits
Synchronous and asynchronous flows
Associated document
Troubleshooting user exits
Setting up logging
Common sources of error
File location errors
Handler failure errors
Processing mode errors
File update errors
Customizing WebSphere Partner Gateway: administrative APIs and external event delivery
Using the administrative API
Understanding the administrative API
The administrative API
ParticipantCreate
ParticipantCreateResponse
ParticipantUpdate
ParticipantUpdateResponse
ParticipantSearchByName
ParticipantSearchByNameResponse
ParticipantAddBusinessId
ParticipantAddBusinessIdResponse
ParticipantRemoveBusinessId
ParticipantRemoveBusinessIdResponse
ContactCreate
ContactCreateResponse
ContactUpdate
ContactUpdateResponse
ListParticipantCapabilities
ListParticipantCapabilitiesResponse
ListParticipantConnections
ListParticipantConnectionsResponse
ListTargets
ListTargetsResponse
ListEventDefinitions
ListEventDefinitionsResponse
BCGPublicAPIException
Using external event delivery
The external event delivery process
The structure of delivered events
The basic CBE document structure
CBE event structure for WebSphere Partner Gateway message events and business document events
Appendixes
Index
Notices
Trademarks and service marks

Copyright IBM Corp. 2003, 2005