Output

The output for the activity is the following.

Output Item

Datatype

Description

inputMessage or <operationName>

depends upon type specified in WSDL

The message parts specified in the WSDL file for the incoming SOAP request.

The incoming request could contain multiple parts and attachments, and each part would be a message defined in the WSDL file.

In case of MTOM attachments, the attachments appear embedded in the message.

mimeEnvelopeElement

complex

This element contains the message attachments when MIME attachments with SwA style are used. This element contains a repeating element named mimePart that contains each MIME attachment.

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 output element or the file name storing the attachment is expected to be in the fileName output element. When the content type is anything other than "text/*", the attachment content is expected to be in either the binaryContent output element or the file name storing the attachment is expected to be in the fileName output 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 Write to File field is checked on the Input Attachment Bindings sub-tab of the Advanced tab.

headers

complex

The header data supplied by the SOAP request. The structure of this input item is defined by the schema on the Input Headers sub-tab of the Advanced tab.

Header.<partName>

complex

Headers can contain multiple parts. The headers element contains all header parts supplied by the incoming SOAP request. These parts are specified on the Input Headers sub-tab of the Advanced tab. The header parts are stored in an element named Header.<partName> where <partName> is the name of the part specified on the Input Headers tab.

Each Header.<partName> element also contains an attribute named @mustUnderstand. This boolean value is set to true in the incoming request if the client specifies that the server must understand the header part.

Context

complex

This element holds the optional SecurityContext element and the RemoteAddress and RemoteHost elements described below.

SecurityContext

complex

This output element is only available when the Expose Security Context field is checked on the Configuration tab. This element contains information about the requestor’s authentication or certificate information, depending upon the security scheme used. For more information, see the description of the following elements contained in the SecurityContext element.

Transport

complex

This element is only available when HTTP is the transport, this element is not available when JMS is the transport.

This element contains the transport-level security context. This includes the following:

  • CertificateToken— complex element containing the subject, issuer, serial number, fingerprint, and X509 certificate.

  • UsernameToken — complex element containing the username, password, and nonce (random number, if one is set by the calling application).

WSSE

complex

This element contains the WSS policy security context. This includes the Authentication and Signature elements. See the description of these elements below.

Authentication

complex

This element contains the authentication information from the client. The type of information in this elements depends upon how the client authenticated. This element can contain one of the following:

  • UsernameToken — complex element containing the username, password, and nonce (random number, if one is set by the calling application).

  • KeyInfo — the client’s public key.

Signature

complex

This element contains information from the user’s digital signature. This element contains the following:

  • Value — this element contains the raw signature sent by the client.

  • Token — either a UsernameToken or a KeyInfo element. A UsernameToken element contains the username, password, and nonce, if available. A KeyInfo element contains information about the client’s digital certificate or public key.

RemoteAddress

string

IP address of the remote host that sent the HTTP request.

This element is only available when HTTP is the specified transport. This element is not available for the JMS transport.

RemoteHost

string

Host name of the remote host that sent the HTTP request. This element is only available when the Enable DNS Lookups field is checked on the Advanced tab of the HTTP Connection used by this activity.

This element is only available when HTTP is the specified transport. This element is not available for the JMS transport.

TransportProperties - HTTP Transport

Method

string

The HTTP method to use for the request. All HTTP 1.1 methods are supported, but the CONNECT method is unnecessary because ActiveMatrix BusinessWorks automatically uses the correct method when connecting by way of a proxy server.

If no method is specified in this element, the GET method is used by default.

RequestURI

string

The address portion of the request. This is the portion of the URI before the question mark (?).

HTTPVersion

string

Version field of the HTTP request.

Command

string

Command portion of the HTTP request.

QueryString

string

The query string portion of the request. This is the portion after the question mark (?).

Header

complex

The header fields to send for the request. This element is specified on the Input Headers tab, and you can use this input item to supply values for the header when sending the request.

Protocol

string

Can be either HTTP or HTTPS depending upon the protocol used by the request.

Port

integer

The port number that the HTTP server uses for incoming requests. Specifying a value for this input item overrides any value specified on the Configuration tab.

Headers

Complex

 

Accept

string

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

If no Accept header field is present, then it is assumed that the client accepts all media types.

Accept-Charset

string

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

If no Accept-Charset header is present, then it is assumed that the client accepts any character set.

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 field, see the HTTP specification.

Content-Type

string

This field indicates the media type of the entity body sent to the receiver. Media types are described in the HTTP specification. An example of the media type is text/html; charset=ISO-8850-4.

Content-Length

string

This field indicates the size of the entity body (in decimal number of OCTETs) sent to the receiver and takes into account the encoding of the message body.

Connection

string

This field allows the requestor to specify options desired for this connection. For example, the option close specifies that the requestor would like the connection to be closed when the request is complete.

Cookie

string

For more information about this field, see the HTTP specification.

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 .

TransportProperties - JMS Transport

JMSHeaders

JMSDestination

string

Destination where a message is sent.

JMSReplyTo

string

The JMS application where the reply message should be sent.

JMSDeliveryMode

string

The delivery mode of the message. Can be one of the following:

  • Persistent: signifies the messages are stored and forwarded.

  • Non-Persistent: messages are not stored and may be lost due to failures in transmission.

  • TIBCO EMS Reliable: using TIBCO Enterprise Message Service, the JMSDeliveryMode header can be TIBCO EMS Reliable. For more information about this mode, see the TIBCO Enterprise Message Service documentation.

JMSMessageID

string

The unique ID of the message.

JMSTimestamp

long

The time a message was handed off to a JMS provider to be sent. The time is expressed as the amount of time, in milliseconds, since midnight, January 1, 1970, UTC.

JMSExpiration

long

The expiration time of the message. The time is expressed as the amount of time, in milliseconds since midnight, January 1, 1970, UTC. If set to 0, the message does not expire.

For outgoing messages, this is set by specifying the JMSExpiration field on the activity’s Advanced tab.

JMSRedelivered

boolean

Typically this item is set when the JMS provider has delivered the message at least once before.

JMSPriority

integer

The priority of the message. Priority is a value from 0-9. Higher numbers signify a higher priority (that is, 9 is a higher priority than 8).

For outgoing messages, the default priority is 4. This is set on the activity’s Advanced tab.

JMSCorrelationID

string

This ID is used to link a response message with its related request message. This is usually the message ID of a request message when this field is found in a reply message.

For more information about JMSCorrelationID, see the following topics:

JMSType

string

The JMS provider-supplied string to describe the type of the message. Some JMS providers use this property to define messages in the provider’s repository. For more information about the use of this field, see your JMS provider documentation.

JMSProperties

JMSXUserID

string

The ID of the user sending the message.

This property is optionally set on incoming messages by the JMS application. This property is not set on outgoing messages.

JMSXAppID

string

The ID of the application sending the message.

This property is optionally set on incoming messages by the JMS application. This property is not set on outgoing messages.

JMSXProducerTIXID

string

The transaction identifier of the transaction where this message was produced.

This property is optionally set on incoming messages by the JMS application. This property is not set on outgoing messages.

JMSXConsumerTXID

string

The transaction identifier of the transaction where this message was consumed.

This property is optionally set on incoming messages by the JMS application. This property is not set on outgoing messages.

JMSXRcvTimestamp

integer

The time the JMS server delivered the message to the consumer. The time is expressed as the amount of time, in milliseconds since midnight, January 1, 1970, UTC.

This property is optionally set on incoming messages by the JMS server. This property is not set on outgoing messages.

JMSXDeliveryCount

integer

The number of delivery attempts for this message.

JMSXGroupID

string

The identity of the message group this message is a part of.

You can set this property on outgoing messages to group messages into a numbered sequence.

JMSXGroupSeq

integer

The sequence number of this message in its group.

You can set this property on outgoing messages to group messages into a numbered sequence.