JMS Setup Message (Magic xpa 3.x)
The JMS Setup Message program sets up the message, setting properties that are different from the defaults. Some of these properties are required for using the JMS messaging filtering capability. Once these properties are set, they are used for every send message program.
The parameters and return value for the JMS Setup Message program are:
|
|
|
|
Queue Handle
|
Numeric (18). Input. The numeric value that was returned from the JMS Open Destination program.
|
|
Expiration
|
Numeric (9). The life span of a message in milliseconds. The default, 0, is unlimited.
|
|
Priority
|
Numeric (1). The message priority can range from 0, the lowest priority, to 9, the highest priority. The default is 4.
|
|
DeliveryMode
|
Numeric (1). Persistence. The valid values are:
1: Non-persistent. If the provider fails, the message may be lost.
2: Persistent. The message will not be lost. This is the default.
|
|
JMS Type
|
Alpha (200). For use in Message selector. Setting this for a Send operation causes the receiver that requested only certain messages to filter messages. For example, if the Open message was started with the Selector option of JMSType = ‘Magic’ and this parameter was not set with JMS, then this message will not be read. However, if this parameter was set with Magic, it will be received.
|
|
String property value
|
Alpha (2000). This is for the selector’s StringProperty. The properties work in pairs and are separated by the delimiter provided in the next parameter. For example, if you want to set a property called Sender and give it the value Magic, the setup string would be Sender!Magic if ! was the delimiter. The selector option would be Sender = ‘Magic’. Multiple properties can be set up.
|
|
Delimiter
|
Alpha (5). The delimiter for the StringProperty string.
|
|
Return value
|
Numeric. 0 for success. When the connection is not successful, a negative value is returned and an error is entered in the Error Log.
|
