|
Sends
a message to a queue that is configured on the JMS provider.
Note:
To use this operation in short-lived processes,
you need to configure the transaction settings of the process version
so that transaction propagation is not supported. (See
Modifying processes
.)
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Queue properties
Properties for connecting to the JMS provider and specifying
the queue.
Connection Factory
A
string
value
that represents the name of the JMS connection factory to use to
connect to the JMS provider. The connection factory must already
be defined on the JMS provider.
If you provide a literal value,
clicking the ellipsis button
opens
the JNDI Browser dialog box. The dialog box shows a list of all
the named connection factories that are configured on the JNDI service
provider. Select the name of the connection factory from the list.
For
Websphere clusters, use the following value:
cell/clusters/[cluster name]/[queueConnectionFactory]
where
[cluster name]
is
the name of the cluster, and
[queueConnectionFactory]
is
the name of the connection factory.
The JNDI service provider
that is used is specified in the JMS service properties. (See
JMS service configuration
.)
Queue Name
A
string
value
that represents the name of the queue that you are sending a message
to. The queue must already be configured on the JMS provider.
If
you provide a literal value for Queue Name, clicking the ellipsis
button opens the JNDI Browser dialog box. The dialog box shows a
list of all the named queues that are configured on the JNDI service
provider. Select the name of the queue from the list.
For
Websphere clusters, use the following value:
cell/clusters/[cluster name]/queue/[queue name]
where
[cluster name]
is
the name of the cluster, and
[queue name]
is the name of
the targeted queue.
The JNDI service provider that is used
is specified in the JMS service properties. (See
JMS service configuration
.)
Message properties
Properties for specifying the message properties and body.
Correlation ID
(Optional) A
string
value
that represents a unique identification of the message, included
in the message header.
Note:
Correlation ID must
not start with
ID:
.
Clients that respond
to the message can include the correlation ID in the header of the
response message. The correlation ID is used to identify responses to
specific messages.
Message Payload
A value that represents the body of the JMS message.
The data type of the value depends on the value of the Message Type
property. The following table lists the supported data types you
can use for the Message Payload value, as well as the corresponding
value for the Message Type property.
|
Data type for Message Payload
|
Value of Message Type
|
|
string
|
STRING
|
|
document
|
DOCUMENT
|
|
org.w3c.dom.Document
|
XML
|
|
binary
|
BINARY
|
|
object
|
SERIALIZABLE
(An object
that has been deserialized for transmission purposes. The value
can be deserialized to re-create the object.)
|
|
No value.
|
EMPTY
|
If any other data type is used for the
value of the Message Payload property, a run-time exception is thrown.
Message Type
(Optional) A
string
value
that represents the data type that you are using to specify the
value of the Message Payload property. The following values are
valid:
Delivery Mode
(Optional) A
string
value
that represents the delivery mode that should be used for the message.
The delivery mode indicates whether message delivery should be made
fail-safe in case the JMS provider fails. Delivery Mode can be one
of the following values:
-
DEFAULT
indicates
that the configuration of the JMS provider dicatates the delivery
mode.
-
PERSISTENT
indicates that the message is stored
on the server when it is sent so that it is available when the JMS
service is restored.
-
NON_PERSISTENT
indicates that the message
is lost if the JMS provider fails.
The delivery mode that
you specify depends on how critical message delivery is for your
process.
Priority
(Optional)
A
string
value
that represents the priority level of the message. The JMS provider
uses the priority level to decide which messages should be sent
first. Messages of higher priority are sent before messages of lower
priority. Priority can have one of the following values (listed
in ascending order of priority):
-
ONE
(default)
-
TWO
-
THREE
-
FOUR
-
FIVE
-
SIX
-
SEVEN
-
EIGHT
-
NINE
Message Properties
(Optional) A list of property names and corresponding
values for the message. The properties that you can or are required
to provide depend on the JMS application that you are using.
To
create the list of property names and values, use the Message Property Editor
dialog box. (See
About Message Properties Editor
.) Click the ellipsis button to
display the dialog box.
Connection Settings properties
Properties for specifying the connection information.
Use Global Settings
(Optional) A
boolean
value
that indicates whether to use the connection settings specified
by the administrator during the configuration process, or to configure
the connection manually. A value of true indicates that the global
settings are used. All other options in this section are grayed.
A value of false indicates that the connection settings must be
configured manually.
Provider URL
(Optional) The URL of the JNDI service provider. The
default is based on the JBoss Application Server. The following
URLs are default values for the application servers that LiveCycle
ES2.5 supports.
-
JBoss:
<server name>
:1099
-
WebLogic:
t3://
<server name>
:7001
-
WebSphere:
iiop://<
server name>
:2809
Note:
In a clustered JBoss environment, do not use localhost
as the server name when Workbench is installed on a cluster node.
Specify the fully-qualified server name or the IP address of one
of the servers in the cluster.
In a clustered WebLogic
environment, do not use the port of the load balancer. Specify the
correct port that cluster nodes use.
JNDI Username
(Optional) The user name of the account to use
for authenticating with the JNDI service provider that is used for
looking up queue and topic names. The default is
guest
.
JNDI Password
(Optional) The password that is associated with
the user name specified for JNDI Username. The default is
guest
.
Initial Context Factory
(Optional) The Java class to use as the
initial context factory. The JMS service uses this class to create
an initial context, which is the starting point for resolving names
of topics and queues. The default is the initial context factory
for the JMS service on JBoss. The following classes are the initial
context factories for the application servers that LiveCycle ES2.5
supports.
-
JBoss:
org.jnp.interfaces.NamingContextFactory
-
WebLogic:
weblogic.jndi.WLInitialContextFactory
-
WebSphere:
com.ibm.websphere.naming.WsnInitialContextFactory
Connection Username
(Optional) The user name of the account to use
for authenticating with the JMS provider when establishing the connection
with the provider. The default is
guest
.
Connection Password
(Optional) The password that is associated with
the user name specified for Connection Username. The default is
guest
.
Other Properties
(Optional) Property name and value pairs that
you can pass to the JNDI service provider. These properties depend
on the implementation and configuration of the provider that you
are using.
The property name and value pairs are separated
by semi-colons (
;
). For example, the following
text shows the value that would be specified for two properties
named name1 and name2, with values value1 and value2, respectively:
name1=value1;name2=value2
|
|
|
