Publish Message On Topic operation

Publishes a message to a topic on the JMS provider. The topic must be configured on the JMS provider before you publish a message to it.

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 .

Topic properties

Properties for connecting to the JMS provider and specifying the topic.

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 for Connection Factory, clicking the ellipsis button  opens the JNDI Browser dialog box. The dialog box shows a list of all the JNDI entries. You need to select the name of the correct connection factory from the list.

For JBoss, the name for the connection factory is TopicConnectionFactory , at the top level of the name tree.

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 to retrieve the JNDI names is specified in the JMS service properties. (See JMS service configuration .)

Topic Name

A string value that represents the name of the topic that you are publishing a message to. The topic must already be configured on the JMS provider.

If you provide a literal value for topicName, clicking the ellipsis button  opens the JNDI Browser dialog box. The dialog box shows a list of all the JNDI entries that are configured on the JNDI service provider. You need to select the name of the topic from the list. The format of the topic name depends on the application server that you are using.

For JBoss, the topic name is in the following format: topic/ [topic name]

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 to publish.

Correlation ID

(Optional) A string value that represents a unique identification of the message, which is included in the message header.

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 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:

  • STRING

  • DOCUMENT

  • EMPTY

  • XML

  • BINARY

  • SERIALIZABLE

    See Message Payload for the corresponding data types that can be used for the message payload.

Message Payload

A value that represents the body of the a 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 Properties

(Optional) A list of property names and corresponding values. Any user-defined message properties as name-value pairs.

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 

Exceptions

This operation can throw JMSConfigurationException and JMSPublisherException exceptions.

// Ethnio survey code removed