Output

The output for the activity is the following.

Output Item

Datatype

Description

Method

string

The method specified in the request. For example, GET or POST.

RequestURI

string

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

HTTPVersion

string

Version field of the HTTP request.

PostData or BinaryContent or FileName

string

The message body of the HTTP request. The content of this element depends upon whether the message body is parsed. Parsing behavior is controlled by the Parse Post Method Data field on the Configuration tab.

For more information, see Special Characters in HTTP Requests.

If the Write to File field is checked on the Advanced tab, this field can also contain the file name of the file containing the message, if the incoming message exceeds the specified threshold size.

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

string

The header of the HTTP request.

DynamicHeaders

complex

The dynamic header is an additional header parameter to add runtime headers to the Outgoing Http Messages. This element is specified in the Input tab. Dynamic header consists of the following information:

  • Name — name of the header.

  • Value — value of the header.

The following overriding conditions can be considered:

  • Overrides the value of HeaderName with the value found in DynamicHeaders if it is a non-repeating header. If more than one occurrence of this header is found under DynamicHeaders, it throws the following exception:

    "The header [ headerName ] is defined as non-Repeating Header in Input Headers. This header cannot have multiple occurences in DynamicHeaders."

  • If it is repeating element, add the respective name value pairs under dynamic headers, which can be added to the existing list maintained for this element.

  • For a repeating element, if the new header name is not found under Headers section declared via TIBCO Designer, following is added into the HTTP Headers.

  • Shows only one value, if found once in DynamicHeaders.

  • Shows array of values, if found repeating in DynamicHeaders.

 

Protocol

string

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

Port

string

Port number on which the request was received. This is the port number configured in the HTTP Connection resource.

mimeEnvelope
Element

complex

This element contains the message attachments. 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 — To suggest a filename for an attachment, use "*;filename=<filename>" in this element.

    Note: HTTP servers may alter or choose to ignore the suggested name.
  • content-type

  • content-transfer-encoding

  • content-id

  • other mime header information

For more information about MIME headers and their syntax, see http://www.faqs.org/rfcs/rfc2045.html.

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 written to the disk.

Headers

complex

The fields of the header specified on the Output Headers tab. For more information about these items, see the description of the Output Headers tab.

parameters

complex

Parameters for the incoming request. These parameters are configured in the Parameters field on the Configuration tab.

When the Parse Post Method Data field on the Configuration tab is checked, the parameters include the parameters in the query string and message body of the incoming HTTP request.

When the Parse Post Method Data field is unchecked, the parameters only include the query string of the incoming request.

Context

complex

Contains information about the client’s environment. For more information, see the description of the following elements contained in the Context element.

RemoteAddress

String

The IP address of the client that submitted the HTTP request.

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.

Username
PasswordToken

complex

The username and password of the HTTP client that made the request. The elements in this element are populated only when the client uses HTTP authentication.

CertificateToken

complex

This element contains the SSL certificate and certain useful information taken from the certificate, such as the CipherSuite, the certificate issuer, and so on.

If the client has more than one certificate in a certificate chain, all certificates are contained in the repeating Certificate element.

RemoteAddress

String

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

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.