JMS connector parameters define how the platform connects to and interacts with messaging systems by using Java™ Message Service (JMS). These parameters control aspects such as the destination type, message filtering, concurrency, and error handling, enabling reliable and scalable cloud-based message processing between integrated applications.
Input parameters
- destinationName
- Name or lookup name of the Destination to which you want to send the message. Specify the lookup
name of the Destination object when the JMS connection alias uses JNDI to retrieve administered
objects.
- destinationType
- Type of destination to which you want to send the message. Specify one of the following values:
- Queue to send the message to a particular queue. Queue is the default
value.
- Topic to send the message to a topic.
- JMSMessage
- A document that represents the JMS message that you want to send.
- header
- A document that contains the header of the JMS message.
-
- deliveryMode
- Specifies the message delivery mode for the message. Specify one of the following
values:
| Option |
Description |
| PERSISTENT |
Default. Provide once-and-only-once delivery for the message. The message is not lost if a
JMS provider failure occurs. |
| NON_PERSISTENT |
Provide at-most-once delivery for the message. The message has no guarantee of being saved
if a JMS provider failure occurs. |
- timeToLive
- Length of time, in milliseconds, that the JMS provider retains the message. The default value is
zero, meaning that the message does not expire.
- JMSType
- Message type identifier for the message.
- properties
- A document that contains optional fields added to the message header. The following properties
are added to the JMS messages when sending.
- uuid
- A universally unique identifier for the message.
- body
- A document that contains the JMS message body. The following formats are supported for the JMS
message body.
- string
- Message body in the form of a string.
- bytes
- Message body is in the form of a one-dimensional byte array.
- object
- Message body in the form of a serializable object.
- data
- Message body in the form of a document.
-
Note:
- Only one of the mentioned formats can be used to send data.
- In workflows, the string and data formats can be
used. In flow services, all mentioned formats can be used.
Output parameters
- Message
- A document that contains the message sent to the JMS provider.
-
- header
- A document that contains the header fields for the sent message. The JMS provider populates
these fields after it received the message from webMethods Integration.
-
- Correlational
- A unique identifier is used to link messages together.
- Nondelivery
- Delivery mode used to send the message.
Note: When sending a message, this value is
obtained from the JMSMessage/header/deliveryMode input parameter.
- Predestination
- Destination (queue or topic) to which the message was sent.
- JMSExpiration
- The time at which this message expires. If the message producer did not specify a time-to-live,
the JMSExpiration value is zero, indicating the message does not
expire.
Note: When sending a message, this value is obtained from the
JMSMessage/header/timeToLive input parameter.
- JMSMessageID
- Unique identifier that is assigned to this message by the JMS provider.
- Timestamp
- The time at which the message was given to the JMS provider.
- JMistype
- Message type identifier specified by the client when sending the message.
- properties
- A document that contains optional fields added to the message header. webMethods Integration adds the
following properties to the JMS messages that it sends:
- uuid
- A universally unique identifier for the message assigned by the sender.
- body
- A document that contains the JMS message body. webMethods Integration supports the
following formats for the JMS message body.
- string
- Message body in the form of a string.
- bytes
- Message body is in the form of a one-dimensional byte array.
- object
- Message body in the form of a serializable object.
- data
- Message body in the form of a document.
- This message format can only be used when exchanging JMS messages between webMethods Integration and
On-premise Integration Server.