connectionAlias Name | String Name of the JMS connection alias that you want to use to send the message. The JMS connection alias indicates how Integration Server connects to the JMS provider. A JMS connection alias can specify that Integration Server use a JNDI provider to look up administered objects (connection factories and destinations) and then use the connection factory to create a connection. Alternatively, a JMS connection alias can specify that Integration Server uses the native webMethods API to create the connection directly on the webMethods Broker. | ||
destinationName | String 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. Specify the provider-specific name of the Destination when the JMS connection alias uses the native webMethods API to connect directly to the webMethods Broker. | ||
destinationType | String. Optional. Type of destination to which you want to send the message. Specify one of the following: QUEUE to send the message to a particular queue. This is the default. TOPIC to send the message to a topic. Note: You need to specify destinationType only if you specified a connectionAliasName that uses the native webMethods API. | ||
JMSMessage | Document A document representing the JMS message you want to send. | ||
Key | Description | ||
header | Document. Optional. A document containing the header of the JMS message. | ||
Key | Description | ||
deliveryMode | String. Optional. Specifies the message delivery mode for the message. Specify one of the following: PERSISTENT Default. Provide once-and-only-once delivery for the message. The message will not be 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. | ||
priority | java.lang.Integer. Optional. Specifies the message priority. The JMS standard defines priority levels from 0 to 9, with 0 as the lowest priority and 9 as the highest. The default is 4. | ||
replyTo | String. Optional. Name or lookup name of the destination to which you want a reply message sent. If the JMS connection alias used by the pub.jms:send service connects to the JMS provider using JNDI, set replyTo to be the lookup name of the destination lookup object name. If the JMS connection alias used by the pub.jms:send service connects to the JMS provider using a native Broker connection, set replyTo to the Broker queue name. That is, if the JMS connection alias specifies the Broker as the JMS provider and uses the native webMethods API to connect directly to the webMethods Broker, specify the name of the queue on the Broker that should receive replies to the message. Note: When using the native webMethods API to connect to the Broker, the replyTo destination must be a queue. Topics are not supported | ||
timeToLive | java.lang.Long. Optional. Length of time, in milliseconds, that the JMS provider retains the message. The default is 0, meaning that the message does not expire. | ||
JMSType | Optional. Message type identifier for the message. | ||
properties | Document. Optional. A Document containing optional fields added to the message header. Integration Server adds the following properties to JMS messages it sends. | ||
Key | Description | ||
JMS_WMCluster Nodes | String. Optional. Name of the Broker in a Broker cluster that you want to receive the message. The specified Broker effectively overrides the policy applied to the cluster connection factory used by the JMS connection alias. If the applied policy is multisend guaranteed or multisend best effort, the JMS_WMClusterNodes value should contain multiple Brokers. | ||
Important:Software AG requires that you specify the value for JMS_WMClusterNodes by mapping the contents of the service output parameter JMS_WMClusterNodes produced by a previous invocation of pub.jms:send or pub.jms:sendAndWait. Use this field to override a Broker cluster policy when all of the following are true: The Broker Server is the JMS provider. The JMS connection alias used to send the message (connectionAliasName) uses a connection from a cluster connection factory. The cluster connection factory permits the applied policy to be overridden. Leave this field blank if the above conditions are not met or if you want the JMS message to be distributed according to the policy applied to the cluster connection factory. | |||
activation | String. Optional. A unique identifier used to group together messages that will be received by a JMS trigger with a join. A JMS trigger can join together messages with the same activation. | ||
uuid | String. Optional. A universally unique identifier for the message. Integration Server can use the uuid for exactly-once processing or for request/reply. | ||
body | Document. Optional. A Document containing the JMS message body. Integration Server supports the following formats for the JMS message body: | ||
Key | Description | ||
string | String. Optional. Message body in the form of a String. | ||
bytes | primitive type. Optional Message body in the form of a one-dimensional byte array. | ||
object | Object. Optional. Message body in the form of a Serializable Java object. | ||
data | Document. Optional. Message body in the form of a document (IData object). Note: This message format can only be used when sending a JMS message from one Integration Server to another. When the JMS message is sent, the sending Integration Server encodes the IData into a byte array. When the receiving Integration Server receives the message, it decodes the byte array into IData. | ||
message | Object. Optional. Message body in the form of an actual javax.jms.Message. | ||
useCSQ | java.lang.Boolean. Optional. Flag indicating whether Integration Server places sent messages in the client side queue if the JMS provider is not available at the time the messages are sent. Set to: True to write messages to the client side queue if the JMS provider is not available at the time this service executes. When the JMS provider becomes available, Integration Server sends messages from the client side queue to the JMS provider. Note: If you want to use the client side queue with the pub.jms:send service, the JMS connection alias specified for connectionAliasName must be configured to have a client side queue. A JMS connection alias has a client side queue if the Maximum CSQ Size property for the alias is set to a value other than 0 (zero). False to throw an ISRuntimeException if the JMS provider is not available at the time this service executes. This is the default. Note: If the specified connectionAliasName uses a cluster connection factory to which the multisend guaranteed policy is applied, set useCSQ to False. |
JMSMessage | Document. A Document containing the message sent to the JMS provider. | ||
Key | Description | ||
header | Document. Conditional. A Document containing the header fields for the sent message. The JMS provider populates these fields after it has successfully received the message from Integration Server. | ||
Key | Description | ||
JMSCorrelationID | String. Conditional. A unique identifier used to link messages together. | ||
JMSDeliveryMode | java.lang.Integer Delivery mode used to send the message. PERSISTENT indicates that the JMS provider provides once-and-only-once delivery for the message. The message will not be lost if a JMS provider failure occurs. NON_PERSISTENT indicates that the JMS provider provides at-most-once delivery for the message. The message has no guarantee of being saved if a JMS provider failure occurs. Note: When sending a message, this value is obtained from the JMSMessage/header/deliveryMode input parameter. | ||
JMSDestination | Object. Conditional. Destination (queue or topic) to which the message was sent. | ||
JMSExpiration | java.lang.LongConditional. 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 | String. Conditional. Unique identifier assigned to this message by the JMS provider. | ||
JMSPriority | java.lang.Integer. Conditional. Defines the message priority. The JMS standard defines priority levels from 0 to 9, with 0 as the lowest priority and 9 as the highest. Note: When sending a message, this value is obtained from the JMSMessage/header/priority input parameter. | ||
JMSReplyTo | Object. Conditional. Specifies the destination to which a response to this message should be sent. | ||
JMSTimestamp | java.lang.Long Time at which the message was given to the JMS provider. | ||
JMSType | String. Conditional. Message type identifier specified by the client when sending the message. | ||
properties | Document. Conditional. A Document containing optional fields added to the message header. Integration Server adds the following properties to JMS messages it sends. | ||
Key | Description | ||
JMS_WMCluster Nodes | String. Conditional. Name of the Broker or Brokers in the Broker cluster that received the JMS message. The Broker Server acting as the JMS provider populates the JMS_WMClusterNodes parameter after it distributes the JMS message to the Broker or Brokers in the Broker cluster. The JMS_WMClusterNodes value will be null when: The JMS provider is not the Broker Server. The JMS connection alias used to send the JMS message does not use a cluster connection factory to obtain the connection to the Broker Server. The cluster connection factory does not permit a policy to be overridden. | ||
activation | String. Conditional. A unique identifier assigned by the sender. A JMS trigger can join together messages with the same activation. | ||
uuid | String. Conditional. A universally unique identifier for the message assigned by the sender. Integration Server can use the uuid for exactly-once processing or for request/reply. | ||
body | Document. Conditional. A Document containing the JMS message body. Integration Server supports the following formats for the JMS message body: | ||
Key | Description | ||
string | String. Conditional. Message body in the form of a String. | ||
bytes | primitive type. Conditional Message body in the form of a one-dimensional byte array. | ||
object | Object. Conditional. Message body in the form of a Serializable Java object. | ||
data | Document. Conditional. Message body in the form of a document (IData object). Note: This message format can only be used when sending a JMS message from one Integration Server to another. When the JMS message is sent, the sending Integration Server encodes the IData into a byte array. When the receiving Integration Server receives the message, it decodes the byte array into IData. | ||
message | Object. Conditional. Message body in the form of an actual javax.jms.Message. |