SOAP Over JMS Binding Details (Consumer)

The following table describes the binding details that are displayed for the selected SOAP over JMS binding, where the shared resource is acting as a consumer.

Restriction: Topic destinations are not supported for SOAP/JMS bindings.
The binding details define the JMS Destination and JNDI Connection resource instances that will be used to contact the web service. For more information about these resource instances and how to create them, see the following topics:
  • Resource Templates > JMS Resource Templates, in the SOA Administration guide (supplied as part of the BPM runtime documentation set)
  • Bindings > JMS Bindings, in the Composite Development guide
Property Description
Inbound Destination (Optional) Logical name to identify a JMS Destination resource instance in the BPM runtime. This resource instance identifies the JMS queue that is used to obtain the output data from the web service.

The default value is amx.bpm.userapp.jmsDestOutbound.

You can bind this logical name to the appropriate JMS Destination resource instance using either of the following methods:

  • Early binding: Replace the name here with the name of a suitable JMS Destination resource instance that already exists on the BPM runtime. (The mapping to the JMS Destination resource instance is then done automatically when you deploy the application to the BPM runtime.)
  • Late binding: Change or create the JMS Destination resource instance to be used when you deploy the application to the BPM runtime. You do this by changing the value assigned to the JmsInboundDestination property on the Property Configuration page of the DAA Deployment Wizard. See Using Pageflow Processes and Business Services for more information about how to do this.

    If you instead export the project to a Distributed Application Archive for subsequent upload to the BPM runtime, a BPM administrator must configure the JMS Destination resource instance to be used. See the Administrator interface documentation for your BPM runtime environment for more information about this.

If an Inbound Destination name is not specified, the service provider must send the response using an internal queue.

Outbound Connection Factory Logical name to identify a JNDI Connection resource instance in the BPM runtime. This resource instance provides the connection details for the JMS server that hosts the inbound and outbound destinations.

The default value is amx.bpm.userapp.jmsDest.

You can bind this logical name to the appropriate JNDI Connection resource instance using either of the following methods:

  • Early binding: Replace the name here with the name of a suitable JNDI Connection resource instance that already exists on the BPM runtime. (The mapping to the JNDI Connection resource instance will then be done automatically when you deploy the application to the BPM runtime.)
  • Late binding: Change or create the JNDI Connection resource instance to be used when you deploy the application to the BPM runtime. You do this by changing the value assigned to the JmsOutboundConnectionFactory property on the Property Configuration page of the DAA Deployment Wizard. See Using Pageflow Processes and Business Services for more information about how to do this.

    If you instead export the project to a Distributed Application Archive for subsequent upload to the BPM runtime, a BPM administrator must configure the JNDI Connection resource instance to be used. See the Administrator interface documentation for your BPM runtime environment for more information about this.

Outbound Destination Logical name to identify a JMS Destination resource instance in the BPM runtime. This resource instance identifies the JMS queue that will be used to send the input data to the web service.

The default value is amx.bpm.userapp.jmsDest.

The name specified here must match the one specified for the provider in the Inbound Destination Configuration. See SOAP over JMS Binding Details (Provider).

You can bind this logical name to the appropriate JMS Destination resource instance using either of the following methods:

  • Early binding: Replace the name here with the name of a suitable JMS Destination resource instance that already exists on the BPM runtime. (The mapping to the JMS Destination resource instance will then be done automatically when you deploy the application to the BPM runtime.)
  • Late binding: Change or create the JMS Destination resource instance to be used when you deploy the application to the BPM runtime. You do this by changing the value assigned to the JmsOuboundDestination property on the Property Configuration page of the DAA Deployment Wizard. See Using Pageflow Processes and Business Services for more information about how to do this.

    If you instead export the project to a Distributed Application Archive for subsequent upload to the BPM runtime, a BPM administrator will need to configure the JMS Destination resource instance to be used. See the Administrator interface documentation for your BPM runtime environment for more information about this.

Security Configuration: This section defines the security configuration to be applied to the binding. You should obtain the required information for the following fields from the web service provider and/or the administrator of your BPM runtime. See Configuring Security on an Outgoing Service Call for more information.
Policy Type Defines the type of security policy required to invoke the service - one of the following values:
  • None - to invoke an unsecured service. (This is the default value.)
  • Username Token, X509 Token or SAML Token - to authenticate the outgoing SOAP request using a Web Services Security (WSS) token of the indicated type.
  • Custom Policy - to apply a custom security policy to the outgoing SOAP request and, if required, to the incoming SOAP response.

    Note: You must use a Custom Policy if the SOAP response message returned by the service contains a security header. The Username Token, X509 Token or SAML Token policies do not handle an incoming SOAP response that contains a security header.

Governance App. Name Defines the name of the identity provider application from which the BPM runtime will obtain the authentication information needed to contact the service.

The BPM runtime will use this information to construct the WSS token (of the specified type) that will be used to authenticate the outgoing SOAP request.

This field must be completed (and is only displayed) if Policy Type is set to Username Token, X509 Token or SAML Token.

Custom Policy Set Defines the name of an external policy set that the BPM runtime will apply to the outgoing SOAP request (and, if appropriate, to the incoming SOAP response).

This field must be completed (and is only displayed if) Policy Type is set to Custom Policy.

The external policy set:

  • must contain the security information required to construct the outgoing SOAP request and, if appropriate, to also handle the resultant incoming SOAP response.
  • must be defined in an XML file (with the extension .policysets) that is available in the same workspace.

Note: TIBCO Business Studio does not validate whether the external policy set is applicable to and correct for the target service. Using an incorrect policy type or a wrongly configured policy will result in an error, either during DAA configuration or at runtime.

The BPM runtime supports a wide range of policies and policy sets that can be used to address different security requirements and scenarios. For more information about external policy sets and how to create them, see the following topics:

  • "Policy Management", in Composite Development
  • "Security Resource Templates", in SOA Administration. (This guide is not included in the TIBCO Business Studio documentation set. You can access it either from the BPM runtime documentation set, or from the Help in the Administrator interface in the BPM runtime.)
Message Configuration: This section defines the message configuration to be applied to the binding - see Configuring SOAP/JMS Message Timeouts on a Request-Response Operation for more information about the use of the timeouts.
Note: If you migrate a pre-4.0 version of a process to this version, default values are not automatically set for these properties. You must set them manually.
Request-Response Timeout Time (in seconds) after which a web service call will time out if a response message has not been received from the web service. If this occurs, a Timeout exception error is thrown by the web service task.

Default value: 6

Request Expiration Timeout Time (in seconds) within which the called web service must pull the request message from the JMS message queue. If this timeout expires, the JMS server will be instructed to purge the request message from the JMS message queue. (This ensures that if the web service call is retried, the JMS message queue does not contain duplicate copies of the same request message for the web service to consume.) The web service call itself does not timeout when this timer expires, so no Timeout exception error is thrown.

Default value: 3

Delivery Mode Delivery mode of the message. One of the following values:
  • Persistent: Messages are stored and forwarded.
  • Non-persistent: Messages are not stored and could be lost due to failures in transmission.

Default value: Persistent

Priority Priority of the message, in the range 0 (lowest) to 9 (highest).

Default value: 4 (Normal)