Input

For more information about mapping and transforming input data, see TIBCO ActiveMatrix BusinessWorks™ Process Design.

The input for the activity is the following.

Input Item

Datatype

Description

inputMessage or <operationName>

complex

The root class for the input of the SOAP Request Reply activity. This class contains all input items for the activity.

If this is a document request, the input is named inputMessage. If the request is an RPC, the input is the name of the operation.

_configData

complex

Specifies the values to use to override transport-specific configuration values, if desired. The content of the _configData element depends upon the type of transport used.

endpointURL

string

Available only when HTTP is the transport. Specifies the Endpoint URL of the service. Specifying a value in this input item overrides any value specified in the Endpoint URL field on the Configuration tab.

host

string

Available only when HTTP is the transport. Specifies the host machine where the SOAP service resides as host:port. This should be used when sending a message through a tunnel.

Transport Properties - HTTP

Headers

Accept

string

This field specifies media types that are acceptable for response messages for the request. For example, text/*, text/html. Media types are described in the HTTP specification.

If no Accept header field is specified, then the server assumes that all media types are acceptable.

Accept-Charset

string

This field specifies the character sets that are acceptable for response messages for the request. For example, iso-8859-5, unicode-1-1. Character sets are described in the HTTP specification.

If no Accept-Charset header is specified, then the server assumes that any character set is acceptable.

Accept-Encoding

string

This field specifies the content-coding values that are acceptable for response messages. For example, compress, gzip. For more information about this header, see the HTTP specification.

Cookie

string

A name/value pair (also known as a cookie) containing information that the HTTP server may be expecting.

You can set the Cardinality field for this element to Repeating (*) to specify more than one cookie. You can also specify multiple name/value pairs in a single non-repeating element by separating each pair with a comma (for example, "name1=value1, name2=value2").

You set the custom engine property bw.plugin.http.protocol.single-cookie-header to true, multiple name/value pairs are sent as a single header element. For more information about custom engine properties, see TIBCO ActiveMatrix BusinessWorks™ Administration.

Pragma

string

This field is used to include implementation-specific directives that might apply to the receiver. For more information about using this field, see the HTTP specification.

Authentication Credentials

username

string

The username for logging into the HTTP server.

This overrides the value specified in the Identity resource.

Note: You can override the username only if the activity is configured for Basic or NTLM authentication.

password

string

The password for logging into the HTTP server.

This overrides the value specified in the Identity resource.

Note: You can override the password only if the activity is configured for Basic or NTLM authentication.

domain

string

Specify the domain to be used.

This overrides the value specified in the configuration.

Note: You can override the domain name only if the activity is configured for NTLM authentication.

soapAction

string

Specifies the soapAction header for the operation. For more information about soapAction, see the SOAP specification.

Specifying a value in this input item overrides any value specified in the Action field on the Configuration tab.

timeout

number

The time to wait (in seconds) for the operation to complete.

mimeEnvelopeElement

complex

This element contains the message attachments when mime attachments are used. This element contains a repeating element named mimePart that contains each mime attachment.

mimepart

mimeHeaders

complex

This element contains the mime header for each mimePart. Mime headers can contain the following information:

  • content-disposition

  • content-type

  • content-transfer-encoding

  • content-id

  • other mime header information

Note: When the content type is specified as "text/*" (for example, "text/xml"), the attachment content is expected to be in either the textContent input element or the file name storing the attachment is expected to be in the fileName input element. When the content type is anything other than "text/*", the attachment content is expected to be in either the binaryContent input element or the file name storing the attachment is expected to be in the fileName input element.

binaryContent | textContent | fileName

choice

This element contains the mime attachment. The element can be one of the following:

  • binaryContent — content of the attachment when the attachment is binary data.

  • textContent — content of the attachment when the attachment is text data.

  • fileName — the file name of the attachment when the attachment is stored in the file system.

Transport Properties - JMS

JMSTargetDestination

string

Available only when JMS is the transport. Specifies the JMS destination (queue) name used to send messages.

JMSReplyDestination

 

string

Available only when JMS is the transport. Specifies the JMS destination (queue) name used to send the response.

The JMSReplyDestination specified has to be unique for every message. Set the JMSReplyDestination to a non-static variable such as Job-Id to use the same JMSReplyDestination multiple times.

JMSCorrelationID

 

This ID is used to link a response message with its related request message. This property is usually set to the message ID of the message you are replying to, but any value can be used.

Note: This is applicable only when JMSReplyDestination is configured with SOAP over JMS.

The JMSCorrelationID of the reply message is set as follows:

  • When the JMSCorrelationID field is configured with a unique value, the JMSCorrelationID property of the request message is set with the unique value. The same value is also set as the JMSCorrelationID of the corresponding response message.

  • When the JMSCorrelationID input element is not configured, the value of the message ID of the JMS Request message is set as the JMSCorrelationID property of the response message.

JMSPriority

number

Available only when JMS is the transport. Specifies the priority of the message.

JMSExpiration

number

Available only when JMS is the transport. Corresponds to JMSExpiration property that specifies how long the message can remain active (in seconds).