Information

Approval Process Status	Published

Objective

Description

JMS - Methods

These methods are used to configure the JMS component:

Quick Send
Quick Get
Open
Close
Send
Get
Advanced Send
Advanced Quick Send
Commit
Rollback

This table lists the methods and parameters that can be used. Parameters in bold are mandatory.

Name	Parameters	Description
Quick Send opens the queue, sends a message using the JMS protocol and then closes the queue.	Queue Name	Enter the queue name.
	Acknowledge Mode	Select one of the modes from the drop-down list to indicate the Acknowledge Mode status.
	Message Type	Select one of the following from the drop-down list to indicate the type of message sent: Text Map Bytes Stream Object Header
	Message	Enter the text of the message being sent or create a condition to build a message.
	Correlation ID	Enter an ID number that is used for Send/Reply implementations.
	Message ID	This parameter returns the ID for the message sent.
	Error Code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Quick Get opens the queue, receives a message using the JMS protocol, and then closes the queue.	Queue Name	Enter the queue or topic name.
	Acknowledge Mode	Select one of the modes from the drop-down list to indicate the Acknowledge Mode status.
	Message Selector	Enter a message selector string that defines which message to receive.
	Time Out	Enter the amount of time (in seconds) that the component will wait to receive a message before moving to the next step in the flow. If you enter 0, the component will wait indefinitely until a message is received before moving to the next step in the flow.
	Topic	Select one of the following from the drop-drown list to indicate whether the operation is for a queue or a topic: Yes: The connection is to a topic. No: The connection is not to a topic, it is to a queue.
	Durable Subscription	Select one of the following from the drop-down list to indicate whether the subscription is a durable subscription: Yes: The subscription is a durable subscription. No: The subscription is not durable.
	Durable Subscription Name	Enter the name of the durable subscription.
	Message	Select where the message is received.
	Message Type	Select one of the following from the drop-down list to indicate the type of message received: Text Map Bytes Stream Object Header
	Correlation ID	Enter an ID number that is used for Send/Reply implementations.
	Message Properties	This field holds the message's properties. The result is an XML, whose structure is defined in the jmsifc.xsd file, located at the following path: JMS/Methods/QuickGet/Output/MessageProperties Click to open the Variables List. Select a variable where the message properties are held, and then click Select.
	Error Code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Open method opens a queue to send a message on a JMS server.	Queue/Topic Name	Enter the queue or topic name.
	Acknowledge Mode	Select one of the modes from the drop-down list to indicate the Acknowledge Mode status.
	Message Selector	Enter a message selector string that defines which message to receive.
	Topic	Select one of the following from the drop-drown list to indicate whether the operation is for a queue or a topic: Yes: The connection is to a topic. No: The connection is not to a topic, it is to a queue.
	Transacted Operations	Select Yes or No from the drop-down list to indicate whether the message is part of a transaction.
	Queue Handle	Enter the queue handle value returned by the Open method.
	Error Code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Close method closes the queue when sending or receiving a message on a JMS server.	Queue Handle	The queue handle value returned by the Open Queue operation.
	Error Code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Send method sends a message using the JMS protocol.	Queue Handle	The queue handle value returned by the Open Queue operation.
	Message Type	Select one of the following from the drop-down list to indicate the type of message sent: Text Map Bytes Stream Object Header
	Message	Enter the text of the message being sent or create a condition to build a message.
	Correlation ID	Enter an ID number that is used for Send/Reply implementations.
	Message ID	This parameter returns the ID for the message sent.
	Error Code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Get method gets a message using the JMS protocol.	Queue Handle	The queue handle value returned by the Open Queue operation.
	Time Out	Enter the amount of time (in seconds) that the component will wait to receive a message before moving to the next step in the flow. If you enter 0, the component will wait indefinitely until a message is received before moving to the next step in the flow.
	Message	Select where the message is received.
	Message Type	Select one of the following from the drop-down list to indicate the type of message received: Text Map Bytes Stream Object Header
	Correlation ID	Enter an ID number that is used for Send/Reply implementations.
	Message Properties	This field holds the message's properties. The result is an XML, whose structure is defined in the jmsifc.xsd file, located at the following path: JMS/Methods/Get/Output/MessageProperties Click to open the Variables List. Select a variable where the message properties are held, and then click Select.
	Error code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Advanced Send opens the queue, sends a message using the JMS protocol and then closes the queue with additional parameters than the Send parameter.	Queue Handle	The queue handle value returned by the Open Queue operation.
	Message Type	Select one of the following from the drop-down list to indicate the type of message sent: Text Map Bytes Stream Object Header
	Message	Enter the text of the message being sent or create a condition to build a message.
	Correlation ID	Enter an ID number that is used for Send/Reply implementations.
	Expiration	Enter the expiration time (in milliseconds) for messages. A value of zero indicates that the JMS component will wait indefinitely for messages.
	Priority	Message priority can range from 0, the lowest priority, to 9, the highest priority. The default message priority is 4.
	Delivery Mode	Enter one of the following to indicate the delivery mode persistency: 1 = Non-persistent: If the message delivery fails, the message may be lost. 2 = Persistent – Message is not lost. (Default Value : 2).
	JMS Type	Enter the message types that will be sent to the queue. This acts as a filter that will send only the indicated message types.
	String Property Value	Enter a value for the string property.
	Delimiter	Enter a delimiter to be used with various parameters.
	Message ID	This parameter returns the ID for the message sent.
	Error Code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Advanced Quick Send opens the queue, sends a message using the JMS protocol and then closes the queue with additional parameters than the Quick Send parameter.	Queue Name	Enter the queue name.
	Acknowledge Mode	Select one of the modes from the drop-down list to indicate the Acknowledge Mode status.
	Message Type	Select one of the following from the drop-down list to indicate the type of message sent: Text Map Bytes Stream Object Header
	Message	Enter the text of the message being sent or create a condition to build a message.
	Expiration	Enter the expiration time (in milliseconds) for messages. A value of zero indicates that the JMS component will wait indefinitely for messages.
	Priority	Enter a number to indicate the message priority. You can enter a number from 1 to 9. The default is 4.
	Delivery Mode	Enter one of the following to indicate the delivery mode persistency: 1 = Non-persistent: If the message delivery fails, the message may be lost. 2 = Persistent – Message is not lost. (Default Value : 2).
	JMS Type	Enter the message types that will be sent to the queue. This acts as a filter that will send only the indicated message types.
	String Property Value	Enter a value for the string property.
	Delimiter	Enter a delimiter to be used with various parameters.
	Correlation ID	Enter an ID number that is used for Send/Reply implementations.
	Message ID	This parameter returns the ID for the message sent.
	Error Code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Commit method commits the transaction for all open messages when the queue is open as a transaction.	Queue Handle	Enter the number returned by the open operation where the current transaction begins.
	Error Code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Rollback method aborts the transaction and automatically executes the rollback transaction program when the queue is open as a transaction. If the queue is still open, JMS automatically begins a new transaction.	Queue Handle	Enter the number returned by the open operation where the current transaction begins.
	Error Code	This parameter is returned, with the corresponding error code, when an error occurs. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

How to Use Direct Access Methods

Reference

Title	JMS - Methods (Magic xpi 4.5)

URL Name	JMS---Methods-xpi-45

JMS - Methods (Magic xpi 4.5)

Information

JMS - Methods