The number of configuration points available and the number of associated handlers for those configuration points vary, depending on the type of target you are setting up. For example, the SyncCheck configuration point is available only with HTTP/S and JMS targets.
For certain business protocols (RosettaNet, cXML, SOAP, and AS2) involved in synchronous exchanges, you must specify a handler for that protocol in the SyncCheck configuration point. You can also modify the way targets process documents by applying an uploaded user-defined handler (or a system-supplied process) to the Preprocess and Postprocess points of the target.
To apply a user-written handler for these configuration points, you must first upload the handler, as described in Uploading user-defined handlers. You can also use a system-supplied handler, which is already available and does not have to be uploaded.
The Preprocess configuration handler is available on all types of targets but is not applicable to SMTP targets.
Table 3 describes the attributes you can set for a Preprocess handler and lists the splitter handlers to which the attributes apply.
The ROD attributes used as examples in this table correspond to those used in ROD to EDI example. In the example, the ROD attributes are contained in the map S_DT_ROD_TO_EDI.eif, which includes the following document flow definition:
The ROD metadictionary and metadocument associated with this flow are ROD_TO_EDI_DICT and DTROD-TO-EDI_ROD.
Attribute | Description | Splitter Handler |
---|---|---|
Encoding | The character encoding of the document. The default is ASCII. | ROD
Generic XML EDI |
BATCHDOCS | When BCG_BATCHDOCS is on, the splitter adds batch IDs to the documents after the documents are split. If the documents are transformed into EDI transactions to be enveloped, the Enveloper uses the batch IDs to make sure that the transactions are put into the same EDI interchange (if possible) before being delivered. Note that the Enveloper must have the batching attribute set to On (the default value). See Batch mode. | ROD
Generic XML |
From Packaging Name | The packaging associated with the document. This value must match the packaging specified in the document flow definition. For example, for a document that has a packaging of None, this value should be None. | ROD
Generic |
From Packaging Version | The version of the packaging specified in From Packaging Name. For example, if the document has a packaging of None, this value would be N/A. | ROD
Generic |
From Protocol Name | The protocol associated with the document. This value must match the protocol specified in the document flow definition. For example, for a ROD document, this value could be ROD-TO-EDI_DICT. | ROD
Generic |
From Protocol Version | The version of the protocol specified in From Protocol Name. For example, for the ROD-TO-EDI_DICT protocol, the value would be ALL. | ROD
Generic |
From Process Code | The process (document flow) associated with this document. This value must match the document flow in the document flow definition. For example, for a ROD document, this value could be DTROD-TO-EDI_ROD. | ROD
Generic |
From Process Version | The version of the process specified in From Process Code. For example, for DTROD-TO-EDI_ROD, this value would be ALL. | ROD
Generic |
Metadictionary | The metadictionary provides information that lets WebSphere Partner Gateway interpret the data. For example, for a ROD document, this value could be ROD-TO-EDI_DICT. | ROD
Generic |
Metadocument | The metadocument provides information that lets WebSphere Partner Gateway interpret the data. For example, for a ROD document, this value could be DTROD-TO-EDI_ROD. | ROD
Generic |
Metasyntax | The metasyntax describes the format of the document being split. The default value is rod. | ROD
Generic |
To modify the Preprocess configuration point, perform the following steps:
Four preprocessing handlers are provided (by default) and are shown in the Available List.
Remember that for targets, the handlers are called in the order in which they appear on the Configured List. The first available handler processes the request, and subsequent handlers on the list are not called.
The SyncCheck configuration point is available for HTTP/S and JMS targets only.
To specify a handler for a business protocol involved in a synchronous exchange, perform the following steps:
Six SyncCheck handlers are provided (by default) for an HTTP/S target. These handlers are shown in the Available List:
For example, if you are configuring an HTTP/S target, the Available List looks like this:
As you can see from the naming convention, the first four handlers are specific to the four document types that can be used for synchronous transactions. Any request that uses the DefaultAsynchronousSyncCheckHandler will be treated as an asynchronous request. Any request that uses the DefaultSynchronousSyncCheckHandler will be treated as a synchronous request.
The DefaultAsynchronousSyncCheckHandler and DefaultSynchronousSyncCheckHandler can be used with other targets (such as a JMS target).
For HTTP and HTTPS targets, it is a good practice to list the specific SyncCheck handler (for example, com.ibm.bcg.server.sync.As2SyncHdlr for AS2 transactions) before listing the default SyncCheck handlers.
No handlers are provided by default for the Postprocess step, and, therefore, no handlers are listed by default in the Available List. You can, however, upload a handler for this configuration point for all types of targets that support synchronous communication. The available handler types for the postprocessing step are:
You add a Postprocessing handler by uploading a handler that conforms to one of these handler types. You use the Import choice of the Handlers List page to upload a user-defined handler. When you upload a user-defined target handler, the handler is added to the Handlers List. It also appears on the Available List for the type of configuration point to which it pertains.
To modify the Postprocess configuration point, perform the following steps:
If you need to change the order of the handlers, delete a handler, or configure attributes for the handler, perform the appropriate step: