Copyright © Cloud Software Group, Inc. All Rights Reserved

Send HTTP Response

Activity

Sends a response to a previously received HTTP request. This activity is used in conjunction with the HTTP Receiver process starter or the Wait for HTTP Request activity.

The default status line returned by this activity is "200 OK".

Configuration

The Configuration tab has the following fields.

Field	Description
Name	The name to appear as the label for the activity in the process definition.
Description	Short description of the activity.
Reply For	The Wait for HTTP Request activity or HTTP Receiver process starter that received the request. This is a selection list of available activities that can receive HTTP requests.
Flush Response	Allows you to specify if the response is to be flushed after each Send HTTP Response activity. By default, this property is not checked. This field is useful when there are a large number of Send HTTP Response activities in a job. In such cases, the Close Connection field is checked in the last activity to indicate the response is complete. However, checking the Flush Response field overrides this behavior and causes the response to be flushed after each Send HTTP Response activity.
Close Connection	Specifies that this activity contains the last part of an HTTP response. This field is used when you have more than one Send HTTP Response activity in a process definition, each activity sending a portion of the response to the client. All Send HTTP Response activities in a process definition should have this field unchecked, except the last Send HTTP Response activity. This field should be checked in the last Send HTTP Response activity to indicate the response is complete. If the entire response is sent by only one Send HTTP Response activity in the process definition, this field should be checked.

Input Headers

The Input Headers tab describes the data structure for the headers of the HTTP response. You can use the default structure, or you can alter the structure, if the outgoing response has a specific data structure for the header of the request. This tab uses the same mechanism described Appendix A, Specifying Data Schema to specify the data structure for the headers. See that appendix for more information about creating a customized data structure.

Header structure is defined by the HTTP protocol. See the HTTP Protocol specification for more information about the fields and content of the header of a HTTP request. You can obtain this specification at www.w3.org.

The default header fields are the following.

Header	Datatype	Description
StatusLine	string	This field is the first line of a response message. This consists of the protocol version, a numeric status code, and the text phrase explaining the status code. See the HTTP specification for more information about status codes in HTTP responses.
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. By default this item is set to text/html. If you are using this activity and the Retrieve Resources activity to retrieve a WSDL file, you should set the type to text/xml when specifying values on the Input tab.
Set-Cookie	string	See the HTTP specification for more information about this field.
Pragma	string	This field is used to include implementation-specific directives that might apply to the receiver. See the HTTP specification for more information about using this field.
Location	string	This field is used to redirect the receiver to a location other than the Request-URI for completion of the request or for identification of a new resource.

Input

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
binaryContent	binary	The binary content of the response to the request.
asciiContent	string	The ASCII content of the response to the request.
Headers	complex	The fields of the header specified on the Input Headers tab. See the description of the Input Headers tab for more information about these items. Note: Only the first Send HTTP Response activity in a process definition can set the Headers element. If your process definition contains multiple Send HTTP Response activities, the headers are set by the first activity and this element is ignored for all subsequent activities.
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. Consider the following overriding conditions: • Overrides the value of the 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 will 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.
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 See http://www.faqs.org/rfcs/rfc2045.html for more information about MIME headers and their syntax. 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.

Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
HttpCommunicationException	An HTTP exception occurred when trying to send the response.

Copyright © Cloud Software Group, Inc. All Rights Reserved