toolbox icon

UltraStudio ToolBox JMS Client

Version: 17.07

Features and Capabilities

The JMS client panel provides a JMS client utility which can send JMS messages to ActiveMQ, HornetMQ and IBMMQ JMS queues. The JMS client panel is capable of

  • Sending Text or Byte JMS messages

  • Adding different type of JMS message headers

  • Setting various JMS message properties including Correlation ID, Message ID, Expiration, Time Stamp, Priority etc.

  • Importing requests from file locations

Configuration Parameters

Main Configuration

Table 1. Main Configuration
Configuration Description

Destination Name

Destination queue name that the message should sent to.

Import and Export

Import file content to be sent out or export content in the payload field.


A user can set either Text Message or Byte Message as the request payload.

Connection Configuration


A user can set the type of JMS server from this configuration panel. For Active MQ and HornetMQ servers hostname of the server and port number should be provided as the connection configuration where IBM MQ required two additional configurations, Channel and Queue Manager.

For the case of IBM MQ, the IBM MQ client libraries should be added using the file picker at the right most side of the panel since there is a limitation to ship those libraries.

JMS Header Configuration


Header configuration can be added and removed from the table as header name header value pairs with the header type. int, long, Boolean and String type headers can be added.

Advanced Configuration

Table 2. Advanced Configuration
Configuration Description

Correlation ID

The JMSCorrelationID header field is used for linking one message with another. It typically links a reply message with its requesting message

Message ID

The JMSMessageID header field contains a value that uniquely identifies each message sent by a provider.

Reply To

Destination to which to send a response to this message


The time the message expires, which is the sum of the time-to-live value specified by the client and the GMT at the time of the send

Time Stamp

The JMSTimestamp header field contains the time a message was handed off to a provider to be sent. It is not the time the message was actually transmitted, because the actual send may occur later due to transactions or other client-side queueing of messages.


The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. In addition, clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority


If set Specifies whether this message is being redelivered. This field is set at the time the message is delivered.

Delivery mode

If selected sets the DeliveryMode value for this message as Persistent, else set it as non persistence

In this topic
In this topic
Contact Us