JMS Binding Reference

JMS Bindings include properties. You can configure most properties, and several properties accept substitution variables.

Binding Node

Property Editable? Accepts Svar? Description
Name Y N Name of JMS Binding.
Description Y N Description of JMS Binding.
Connection Factory Y N The name of a JMS Connection Factory.

Required for MEP:

  • In-Out (Service, Reference)
  • In-Only (Service, Reference)
Configuration for JMS Binding Request Communication
Property Editable? Accepts Svar? Description
Destination Type Y N The Type of JMS destination, Queue, Topic, or JNDI. For Direct Destinations, use Queue or Topic. For JNDI Resource template, use JMS Destination Resource template.

Required for MEP:

  • In-Only (Service, Reference)
  • In-Out (Service, Reference)
Destination Y N
Note: This property is only applicable for JNDI Destination Type.
The name of a JMS Destination in case of JMS Destination resource template.

Required for MEP:

  • In-Only (Service, Reference)
  • In-Out (Service, Reference)
Queue Name Y Y Name of the Queue if Destination Type is selected as Queue.
Topic Name Y Y

Name of the Topic if Destination Type is selected as Topic.

Interface Settings

Configuration for Reply JMS message, applicable for In-Out MEP
Property Editable? Accepts Svar? Description
Destination Type Y N

The Type of JMS destination, Queue, Topic or JNDI. For direct destinations use Queue or Topic. For JNDI resource template, use JMS Destination Resource template.

By default destination type is 'Same as Request Message'.

Note:

The 'Same as Request Message' option indicates that the Reply Message Destination Type is same as the Request Message Destination Type. In CLI script, there is no such option. You must select Queue, Topic, or JNDI.

Required MEP:

  • In-Out (Service, Reference)
Destination Y N
Note: This property is only applicable for JNDI Destination Type.

The name of a JMS Destination in case of JMS Destination resource template. If not specified, temporary destination name derived from value of JMSReplyTo JMS header will be used.

Queue Name Y Y Name of the Queue if Destination Type is selected as Queue.
Topic Name Y Y Name of the Topic if Destination Type is selected as Topic.
Note: In case of In-Out MEP even when Reply Message is configured, priority well be given to JMSReplyTo JMS Message header and reply will be sent on the destination represented by the JMSReplyTo header value. Clients must not set this header field when fixed reply destination is used.
Advanced Settings for JMS Binding
Property Editable? Accepts Svar? Description
Reply Message

NOTE: If Request or Reply message destination type is set to Queue or Topic and JMS Provider does not support dynamic queue or topic creation or the user of provider does not have create permissions, create a queue or topic before deploying the application.

Connection Factory Y N

Name of the JMS Connection Factory resource template.

By default Connection Factory is 'Same as Request Message'.

Note:

The 'Same as Request Message' option indicates that the Reply Message Connection Factory is same as the Request Message Connection Factory. In CLI script, there is no such option.

Required MEP:

  • In-Out (Service, Reference)
Correlation Scheme Y Y

Scheme which identifies the correlation scheme used when sending reply messages.

Required if the reply destination is set. The correlation schemes are:

  • RequestCorrelIDtoCorrelID - Correlation ID of the request message is copied to the Correlation ID of the response message.
  • RequestMsgIDtoCorrelID - Message ID of the request message is copied to the Correlation ID of the response message.

For receiving proper reply messages by the JMS Binding on Promoted Reference in case of In-Out MEP, to pick the message from Request Destination, client must set the JMSCorrelationID header field on the JMS Message according to the Correlation Scheme.

Default: RequestCorrelIDtoCorrelID

Note: RequestMsgIDtoCorrelID correlation scheme is not supported for Topic set as static reply destination.
Operation Selection
Type Y N
Note: Applicable only in case of multiple operations.

Operation selection scheme in case of multiple operations. SCA and Custom are supported. In case of Custom scheme other properties (JMS Property Name and Error Action) are not editable but Message Selector configuration on each operation is mandatory. See "Operation Node" for more details.

JMS Property Name Y Y
Note:

Applicable only in case of multiple operations.

Name of the JMS property to be used for operation selection in case of multiple operation and "SCA" operation selection type. Default property name is "scaOperationName".

Error Action Y N
Note: Applicable only in case of multiple operations.

Action to trigger in case when operation selection from multiple operation fails.

  • Discard Message - This is a default Error Action. When selected, runtime will discard the message when operation selection fails.
  • Send Message To Operation - By selecting this action, user can inform runtime to send the message to a particular configured operation when operation selection fails.
  • Send Message To Error Queue - By selecting this action, user can inform runtime to send the message to a configured error queue when operation selection fails.
  • Retain Message in Service Destination - By selecting this action, user can inform runtime to retain the message in the service request destination configured in Request Message section.
Operation Name Y Y

Displayed when "Send Message to Operation" error action is selected. Operation name to send the message in case of operation selection fails and "Send Message to Operation" is configured.

Error Queue Name Y Y Displayed when "Send Message to Error Queue" error action is selected. Error queue to send the JMS message in case of operation selection fails and "Send Message to Error Queue" error action is configured.
Fault Selection

JMS Property Name

Y Y JMS Property name used to send the fault as a value. Default property name is "faultName".
Property Editable? Accepts Svar? Description

Operation Selection

Message Selector

Y Y

A JMS message selector allows a client to specify, by message header and properties, the messages it’s interested in. Message selector on Interface Settings is configurable when Error Action in Operation Selection is other than "Retain Message in Service Destination" and Operation Selection Type is "SCA".

Request Message
Message Type Y Y

Message type used for request messages. One of:

  • XML Text - A text message carrying XML payload that confirms to specified schema.
  • Bytes - Binary data
  • Text - A text message carrying a payload of type xsd:string.
  • XML Bytes - XML content sent as bytes. (JMS resource instances treat this type as bytes but JMS bindings expect content in XML.)

Default: XML Text.

Durable Subscription Y Y

Configurable only in JMS Binding on Promoted Service.

Specifies a durable subscription. You must specify a name in the Durable Subscription field which gets registered with the JMS application as the durable subscription name.

Note: Applicable only if Request Message Destination type is Topic.
Subscription Name Y Y

Configurable only in JMS Binding on Promoted Service.

The subscription name registered with the JMS application for durable subscriptions. This field is only available when the Durable Subscription field is checked.

Note: Applicable only if Request Message Destination type is Topic.
Delivery Mode Y Y

Configurable only in JMS Binding on Promoted Reference.

The delivery mode of the message. One of the following:

  • Persistent - Messages are stored and forwarded
  • Non-Persistent - Messages are not stored and could be lost due to failures in transmission.
  • TIBCO Enterprise Message Service Reliable - The consumer never sends the provider a receipt confirmation or access denial and the provider does not wait for it. Reliable mode decreases the volume of message traffic, enabling higher message rates.

Default: Non-Persistent.

Message Priority Y Y

Configurable only in JMS Binding on Promoted Reference.

Priority of the message. You can set the priority to a value from 0-9.

Message Expiration Y Y

Configurable only in JMS Binding on Promoted Reference.

The time in milliseconds for which request message is retained by JMS Provider.

Operation Timeout Y Y Configurable only in JMS Binding on Promoted Reference.

The period that the JMS binding waits for the response to arrive.

Default: If the MEP is In-Out, the defaults are 6000 ms at the port type and operation levels. If other values (non-default values) are specified, these values take effect, with the value at the operation level given precedence.

Note:

Operation Timeout is applicable for a Reference only. For a Service, add a thread policy on a component service and set timeout on the thread policy.

Reply Message
Message Type Y Y Message type used for reply messages. One of:
  • XML-Text - A text message carrying XML payload that confirms to specified schema.
  • Bytes - Binary data
  • Text - A text message carrying a payload of type xsd:string.
  • xmlBytes - XML content sent as bytes. (JMS resource instances treat this type as bytes but JMS bindings expect content in XML.)

Default: XML-Text.

Delivery Mode Y Y Configurable only in JMS Binding on Promoted Service.

The delivery mode of the message. One of the following:

  • Persistent - Messages are stored and forwarded
  • Non-Persistent - Messages are not stored and could be lost due to failures in transmission.
  • TIBCO Enterprise Message Service Reliable - The consumer never sends the provider a receipt confirmation or access denial and the provider does not wait for it. Reliable mode decreases the volume of message traffic, enabling higher message rates.

Default: Non-Persistent.

Message Priority Y Y Configurable only in JMS Binding on Promoted Service. Priority of the message. You can set the priority to a value from 0-9.
Message Expiration Y Y Configurable only in JMS Binding on Promoted Service. The time in milliseconds for which reply message are retained by JMS Provider.
Fault Message:

This section is visible only in JMS Binding on Promoted Service and if operation has defined faults. It is applicable only for In-Out-Fault MEP.

Override Reply Message Y N Configuration from Reply Message is INHERITED by default. To "Override Reply Message" configuration in Interface Settings for Fault Message select "Override Reply Message".
Message Type Y Y Message type used for reply messages. One of:
  • XML-Text - A text message carrying XML payload that confirms to specified schema.
  • Bytes - Binary data
  • Text - A text message carrying a payload of type xsd:string.
  • xmlBytes - XML content sent as bytes. (JMS resource instances treat this type as bytes but JMS bindings expect content in XML.)

Default: XML-Text.

Delivery Mode Y Y

The delivery mode of the message. One of the following:

  • Persistent - Messages are stored and forwarded
  • Non-Persistent - Messages are not stored and could be lost due to failures in transmission.
  • TIBCO Enterprise Message Service Reliable - The consumer never sends the provider a receipt confirmation or access denial and the provider does not wait for it. Reliable mode decreases the volume of message traffic, enabling higher message rates.

Default: Non-Persistent.

Message Priority Y Y

Priority of the message. You can set the priority to a value from 0-9.

Message Expiration Y Y The time in milliseconds for which reply message is retained by JMS Provider.

Operation Node

Property Editable? Accepts Svar? Description
Operation Settings
Name N N Operation name.
Description Y N Notes for operation name.

Operation Selection

Note:

Configurable only in JMS Binding on Promoted Service.

Message Selector Y Y

A JMS message selector allows a client to specify, by message header, the messages it’s interested in. Message Selector is displayed only when Operation Selection Type is "Custom" or Operation Selection Error Action is "Retain Message in Service Destination" and is used as a operation selector for the selected operation.

Request Message
Override Request Message Y N Override INHERITED Request Message configuration from Interface Settings for this operation only. If selected Message Type can be overridden.
Message Type Y Y Message type used for request messages. One of:
  • XML Text - A text message carrying XML payload that confirms to specified schema.
  • Bytes - Binary data
  • Text - A text message carrying a payload of type xsd:string.
  • XML Bytes - XML content sent as bytes. (JMS resource instances treat this type as bytes but JMS bindings expect content in XML.)

Default: XML Text.

Durable Subscription Y Y

Specifies a durable subscription. You must specify a name in the Durable Subscription field which gets registered with the JMS application as the durable subscription name. Durable subscription is displayed only when Request Message Destination Type is "Topic" and Operation Selection Type is "Custom" or Operation Selection Error Action is "Retain Message in Service Destination".

Subscription Name Y Y

The subscription name registered with the JMS application for durable subscriptions. This field is only available when the Durable field is checked and Request Message Destination Type is "Topic" and Operation Selection Type is "Custom" or Operation Selection Error Action is "Retain Message in Service Destination".

Delivery Mode Y Y Configurable only in JMS Binding on Promoted Reference.

The delivery mode of the message. One of the following:

  • Persistent - Messages are stored and forwarded
  • Non-Persistent - Messages are not stored and could be lost due to failures in transmission.
  • TIBCO Enterprise Message Service Reliable - The consumer never sends the provider a receipt confirmation or access denial and the provider does not wait for it. Reliable mode decreases the volume of message traffic, enabling higher message rates.

Default: Non-Persistent.

Message Priority Y Y Configurable only in JMS Binding on Promoted Reference.

Priority of the message. You can set the priority to a value from 0-9.

Message Expiration Y Y

Configurable only in JMS Binding on Promoted Reference.

The time in milliseconds for which reply message are retained by JMS Provider.

Operation Timeout Y Y

Configurable only in JMS Binding on Promoted Reference.

The period that the JMS binding waits for the response to arrive.

Default: If the MEP is In-Out, the defaults are 6000 ms at the port type and operation levels. If other values (non-default values) are specified, these values take effect, with the value at the operation level given precedence.

Note:

Operation Timeout is applicable for a Reference only. For a Service, add a thread policy on a component service and set timeout on the thread policy.

Reply Message
Override Reply Message Y N Override INHERITED Reply Message configuration from Interface Settings for this operation only.
Message Type Y Y Message type used for reply messages. One of:
  • XML Text - A text message carrying XML payload that confirms to specified schema.
  • Bytes - Binary data
  • Text - A text message carrying a payload of type xsd:string.
  • XML Bytes - XML content sent as bytes. (JMS resource instances treat this type as bytes but JMS bindings expect content in XML.)

Default: XML Text.

Delivery Mode Y Y

Configurable only in JMS Binding on Promoted Service.

The delivery mode of the message. One of the following:

  • Persistent - Messages are stored and forwarded
  • Non-Persistent - Messages are not stored and could be lost due to failures in transmission.
  • TIBCO Enterprise Message Service Reliable - The consumer never sends the provider a receipt confirmation or access denial and the provider does not wait for it. Reliable mode decreases the volume of message traffic, enabling higher message rates.

Default: Non-Persistent.

Message Priority Y Y Configurable only in JMS Binding on Promoted Service.

Priority of the message. You can set the priority to a value from 0-9.

Message Expiration Y Y Configurable only in JMS Binding on Promoted Reference.

The time in milliseconds for which reply message are retained by JMS Provider.

Fault Message
Note: This section is visible only if faults are configured.
Override Fault Message Y N Override INHERITED fault message configuration from Interface Settings.
Fault Name N N

Name of the fault.

Message Type Y Y Message type used for reply messages. One of:
  • XML Text - A text message carrying XML payload that confirms to specified schema.
  • Bytes - Binary data
  • Text - A text message carrying a payload of type xsd:string.
  • XML Bytes - XML content sent as bytes. (JMS resource instances treat this type as bytes but JMS bindings expect content in XML.)

Default: XML Text.

Delivery Mode Y Y

The delivery mode of the message. One of the following:

  • Persistent - Messages are stored and forwarded
  • Non-Persistent - Messages are not stored and could be lost due to failures in transmission.
  • TIBCO Enterprise Message Service Reliable - The consumer never sends the provider a receipt confirmation or access denial and the provider does not wait for it. Reliable mode decreases the volume of message traffic, enabling higher message rates.

Default: Non-Persistent.

Message Priority Y Y Priority of the message. You can set the priority to a value from 0-9.
Message Expiry Y Y Configurable only in JMS Binding on Promoted Service. The time in milliseconds for which reply message are retained by JMS Provider.

Context Parameter Mapping

The following table shows the context parameter mapping to JMS header parameters or JMS application properties. JMS Header parameters or JMS application properties on JMS message from Request Message can be mapped to a context parameter and vice versa. Context parameters are defined in the General section of the Promoted Service or Promoted Reference. All the parameters defined in Context Parameters are available to Context Parameter Mapping in JMS Binding.

Property Description
Context Parameter Name of the context parameter.
Direction Direction of the flow of parameter.
  • INPUT: JMS Header parameter or JMS Application property is mapped to a Context Parameter.
  • OUTPUT: Context parameter is mapped to a JMS Header parameter or JMS Application property.
Header Source Source of the header parameter.
  • JMS_HEADER: When JMS_HEADER is used, a JMS Header parameter name to map to a context parameter can be selected from Header Name.
  • JMS_APPLICATION_PROPERTIES: Customer JMS Application property name is used for Context Parameter mapping.
Header Name Shows JMS Header parameter names when JMS_Header is selected. Allows custom property value to be set when JMS_APPLICATION_PROPERTIES is set.
Note: JMS Binding supports only Context Parameters of 'Type' Basic.