Custom Payloads tab

JMS, TCP, SAP MII, Microsoft Message Queuing, and WebSphere MQ transport types facilitate custom formats for their payload data.

Assumptions

This pages assumes that you understand how to create a transport and are ready to develop a custom payload format.

Parameter values for the Custom Payloads tab

The following shows a portion of the Transport window that lets you specify a custom payload.

A custom payload format requires the use of a client created java application program that defines method(s) to populate values for each transport input map variable. The following describes the parameters on the Custom Payloads tab:

Allow Custom Payloads

Select the Allow Custom Payloads check box to enable a transport to use a custom payload. You must specify the name of a jar file and class name.

Jar Name

When creating a transport that will use a custom format payload, you must specify a jar file and class name.

Use the Jar Name box to specify the name of the jar file that contains the client java application program. The jar file must be available in staging file system (the Staging Browser tab) on the node that contains the transport.

For more information, click Staging Browser.

Transform Class Name

Use the Transform Class Name box to specify the name of the class where the methods are defined.


For this example, the client java application program is packaged in dwcustom.jar. The class name is DWTransformRequest.

For information on how to create a transport map that uses the custom format, click Adding a custom payload.

The following Related Topics links pertain to tabs available from different transport type windows. For example, a transport window for a TCP transport has Timeout and Custom Payloads tabs; while a WebSphere MQ transport type has a Timeout, Store & Forward, Mapping Log, and Custom Payloads tabs.

Related Topics

Timeout tab

Store & Forward tab

Mapping Log tab

Creating a JMS transport

Creating the MSMQ transport

Defining a TCP transport

Creating the WebSphere MQ transport