webMethods and Intelligent Business Operations 10.2 | Running Business Processes and Composite Applications | Administering webMethods Process Engine | Process Engine Services | Summary of Elements in the WmPRT\pub Folder | pub.prt.jms:send
 
pub.prt.jms:send
WmPRT. Sends a JMS message. This service encodes an IS Document into a JMS message and sends it to the specified destination using the specified options. The main difference between this service and the pub.jms:send service in WmPublic is that this service allows the user to easily specify the type of the document, which is required by the Process Engine to kick off a process instance, as well as make it convenient to format the JMS message appropriately for use with the Process Engine.
Input Parameters
connectionAliasName
String Set this value to define the connection alias you want to use. The default PE_NONTRANSACTIONAL_ALIAS is used if no value is specified.
destinationName
String Set this parameter to the value of the "Destination Name" in the Subscription trigger generated by Designer for the process model that this JMS message should start. It will be similar to "YourProjectName_YourProcessName_SUBQUEUE".
destinationType
String Set this parameter to the value of the "Destination Type" in the Subscription trigger generated by Designer for the process model that this JMS message should start. It will usually be "QUEUE".
deliveryMode
String Set this to PERSISTENT or NON_PERSISTENT. This field is mapped directly to the JMSMessage.header.deliveryMode field in the pub.jms:send service in WmPublic. For more information about the pub.jms:send service see the webMethods Integration Server Built-In Services Reference.
priority
String This field is mapped directly to the JMSMessage.header.priority field in the pub.jms:send service in WmPublic. For more information about the pub.jms:send service see the webMethods Integration Server Built-In Services Reference.
timeToLive
String This field is mapped directly to the JMSMessage.header.timeToLive field in the pub.jms:send service in WmPublic. Refer to the webMethods Integration Server Built-In Services Reference for more information about that field.
data
Document Set this parameter to the IS Document that should be send in the body of the JMS message. This will be the document that actually kicks off the process instance.
documentType
String Set this parameter to the fully qualified name of the document type that was used for the "data" parameter. This will be the same document type that was specified in Designer as the Receive Document type.
useCSQ
String Set this field to false if guaranteed transitions are required. Otherwise set it to "true" to utilize client-side queuing.
Output Parameters
JMSTimestamp
String Indicates when the JMS provider sent the message
JMSMessageID
String Handle to lock object and not drop from pipeline.
Usage Notes:
This service is used to initiate a process instance. If you do not specify a connection alias for the connectionAliasName parameter, the JMS connection alias PE_NONTRANSACTIONAL_ALIAS is used by default to connect to a JMS provider and send the JMS message. You can specify a different connection alias with the connectionAliasName parameter. The connection alias must exist and be properly configured by an IS administrator.
This service is a thin wrapper on top of the pub.jms:send service in WmPublic, but that service may also be used to initiate a process instance. Most of the parameters specified above map directly to similarly named parameters in the WmPublic service, with the following exception:
*The pub.jms:send service has no dedicated input parameter with which to set the documentType value that is required by the Process Engine to correctly map a JMS message to the correct process model. Instead, callers of pub.jms:send must instantiate a documentType field in the properties document, and set the value of that field to the fully qualified name of the IS document expected by the desired process model.
For more information about the pub.jms:send service see the webMethods Integration Server Built-In Services Reference.
Copyright © 2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release