Advanced SOAP Settings

For each operation, you can specify advanced configuration options. To access the advanced configuration options, perform the following:

Procedure 

  1. Click the Endpoint Bindings Tab.

  2. Select the desired endpoint and click the SOAP Details sub-tab.

  3. Select the operation in the Operations field.

  4. Click the Advanced button next to the operation name.

The Advanced SOAP Settings dialog appears. The following sections describe the tabs on this dialog.

Input Attachments

For more information about message attachments, see Messages With Attachments.

The Input Attachments tab has the following fields.

Field

Description

Mime Content Type

The table containing this column allows you to specify the mime content type of each message part. This is especially useful for describing parts that contain attachments. For more information on the valid syntax of the content type, see the mime specification .

If specified, the content type appears in the WSDL for the specified part.

Use the X, +, and arrow keys to delete, add, and move parts in the list.

Message Part

The message part that you would like to specify the content type for. This field is a drop down list of message parts.

Write to File

Checking this field specifies that incoming messages whose attachments exceed the specified threshold size should be written to a file instead of stored in memory. This allows you to accept large incoming attachments without consuming a great deal of memory. When this field is checked, the Directory and Threshold Size fields appear.

Leaving this field unchecked specifies that attachments of incoming messages should be kept in memory.

Once written, the files created by using this option are not deleted automatically. You must manage the storage used by these files and delete them when they are no longer used.

Although Write to File exists for SwA and MTOM, Soap over JMS completely depends on the heap size configuration as JMS specifications do not support writing JMS messages in parts as is the case with Soap over HTTP, which can be written over wire in parts. Hence, writing large JMS messages to JMS after configuring Write to File, completely depends on the Heap size.

Directory

This field only appears when the Write to File field is checked.

The directory to write attachments that are above the specified threshold. The process engine does not attempt to create the directory if the specified directory does not exist. Therefore, create the directory before starting the process engine.

Threshold Data Size (bytes)

This field only appears when the Write to File field is checked.

The maximum size (in bytes) of an incoming message attachment that can be kept in memory. Attachments larger than the specified size are written to a file in the specified directory. The file’s name is output so that subsequent activities in the process definition can access the file and read its contents.

Specifying zero (0) in this field causes all incoming messages to be saved to a file.

Input Headers

The Input Headers tab allows you to specify a SOAP message parts used for any SOAP headers expected in the incoming request. The specified input headers are also included in the concrete bindings in the generated WSDL file.

Use the +, X, and arrow keys to add, delete and move the input header messages in the list.

The Input Headers tab has the following fields.

Field

Description

Message Name

The message in a WSDL file to use as the input header for the incoming SOAP request. This WSDL file does not have to be the same as the file used for output headers or the file used to configure the port type and operation of the incoming request.

Use the Browse button in this field to search for valid WSDL File resources and to select the desired message in the WSDL File.

Part Name

This field contains a drop down list with all parts of the specified SOAP message. You can specify a namespace or encoding for the part, if applicable.

Namespace

Namespace for the selected input header message.

Encoding

Encoding to use for the selected input header message.

Undescribed

Select this check box to declare the header as Undescribed header.

Cardinality

This field contains a drop-down list with two options: Repeating and Optional.

Output Attachments

For more information about message attachments, see Messages With Attachments.

The Output Attachments tab has the following fields.

Field

Description

Attachment Style

This field allows you to choose the attachment style for the outbound/response messages. Two attachment styles are available: SwA and MTOM.

Attachments

Mime Content Type

The table containing this column allows you to specify the mime content type of each message part. This is especially useful for parts that contain attachments. For more information on the valid syntax of the content type, see the mime specification.

If specified, the content type appears in the WSDL for the specified part.

Use the X, +, and arrow keys to delete, add, and move parts in the list.

Message Part

The message part that you would like to specify the content type for. This field is a drop down list of message parts.

Output Headers

The Output Headers tab allows you to specify a SOAP message parts used for any SOAP headers expected in the outgoing reply. The specified output headers are also included in the concrete bindings in the generated WSDL file.

Use the +, X, and arrow keys to add, delete and move the input header messages in the list.

The Output Headers tab has the following fields.

Field

Description

Message Name

The message in a WSDL file to use as the output header for the SOAP request. This WSDL file does not have to be the same as the file used for input headers or the file used to configure the port type and operation of the incoming request.

Use the Browse button in this field to search for valid WSDL File resources and to select the desired message in the WSDL File.

Part Name

This field contains a drop-down list with all parts of the specified SOAP message. You can specify a namespace or encoding for the part, if applicable.

Encoding

Encoding to use for the selected output header message.

Undescribed

Select this check box to declare the header as Undescribed header.

Cardinality

This field contains a drop-down list with two options: Repeating and Optional.

Fault Headers

This Fault Headers tab enables the user to configure headers for declared faults. With this you are able to configure different schemas to be mapped to the headers for different Fault messages.

This Fault Headers tab has the following fields.

Field

Description

soapFaults

The Faults available for configuration are listed in the soapFaults drop-down.

Part Name

This field contains a drop-down list with all parts of the specified soapFault message.

Message Name

The message in a WSDL file to use as the fault header for the incoming soapFault request.

Use the Browse button in this field to search for valid WSDL File resources and to select the desired fault message in the WSDL File.

Input Context

The Input Context tab allows you to specify a Context Resource that contains transport-specific data. The data you provide to the context resource is available to the process definition that implements the operation.

The Input Context tab has the following fields.

Field

Description

Shared Context

The Context Resource that specifies the schema you want to use. The schema of this resource should include elements for each data element from the transport information you want to provide to a process definition that implements the operation.

Expose Security Context

This field is available for either HTTP or JMS transports. This field is only available when a Context resource is specified in the Shared Context field.

Places the information from the user’s security context (either authentication or SSL certificate information) into the Context/SecurityContext element of the Input Context.

This is a fairly expensive operation and SSL certificates can consume memory resources, so check this option only if you require information from the user’s security context for later use in your process definition.

Mapping Panel

The mapping panel is similar to the mapping panel provided in the Input tab of activities. This panel allows you to map transport-specific information from the incoming request to the data elements of the specified Context Resource. The mapping panel appears only when a Context resource is specified in the Shared Context field.

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

When the Expose Security Context field is checked, the following schema is available in the Mapping Panel field.

Element

Datatype

Description

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.

Output Context

The Output Context tab allows you to specify a Context Resource that contains data the process definition implementing the operation has provided. The data can then be mapped to Headers of the output message returned to the client.

The Output Context tab has the following fields.

Field

Description

Shared Context

The Context Resource that specifies the schema you want to use. The schema of this resource should include elements for each data element you want to provide to the output Headers for the message.

Mapping Panel

The mapping panel is similar to the mapping panel provided in the Input tab of activities. This panel allows you to map data provided by the implementation of the operation to the transport-specific headers of the reply message sent to the client. The mapping panel appears only when a Context resource is specified in the Shared Context field.

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

Fault Context

The Fault Context tab allows you to select a fault context resource that is set with SOAP fault attributes. The data can then be mapped to Fault Elements of the Fault message returned to the client.

The Fault Context tab has the following fields.

Field

Description

Shared Context

The Context Resource that specifies the SOAP fault schema you want to use for mapping with the Fault Elements.

Mapping Panel

The mapping panel is similar to the mapping panel provided in the Input tab of activities. This panel allows you to map data provided by the implementation of the operation to the transport-specific Fault Elements of the fault message sent to the client. The mapping panel appears only when a Context resource is specified in the Shared Context field.

The Context Data shows the Context resource element.