Publish to Adapter

The Publish to Adapter activity publishes a message that can be received by an adapter’s subscription service. Subscription services are configured during adapter configuration, and the activity uses the information in the adapter configuration to fill in most of the fields of this activity. See your adapter documentation for more information about creating adapter configurations and creating adapter subscription services.

Figure 4 illustrates a Publish to Adapter activity sending a message to a preconfigured adapter subscription service.

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
Adapter Service	No	The preconfigured adapter subscription service. You must specify the adapter service when configuring the adapter. Use the Browse button to locate the appropriate service for this activity. You can choose services configured with the RVCMQ transport, but the transport is converted to RVCM when used by this activity. This is because the RVCMQ transport does not apply to publishing activities.
RequestReply	No	Specifies that this publish activity is sending a request message and expecting a response message. This is similar to using the Invoke an Adapter Request-Response Service activity, except this activity uses an adapter Subscription service instead of a Request-Response service. When this field is checked, the Request AE Schema and Reply AE Schema fields appear. Also, the replyDestination element appears in the activity output.
Request AE Schema	No	Only appears when the RequestReply field is checked. This field specifies the TIBCO ActiveEnterprise schema to use for the body of the message in the input of this activity.
Reply AE Schema	No	Only appears when the RequestReply field is checked. This field specifies the TIBCO ActiveEnterprise schema to use as the output reply message.
Custom AESchema	No	Specifies whether you want to supply a class for this activity’s input.
Custom AESchema Reference	No	Only appears when the Custom AESchema field is checked. This field specifies the TIBCO ActiveEnterprise schema to use for the body of the message in the input of this activity.

The name to appear as the label for the activity in the process definition.

Description

Short description of the activity.

Adapter Service

The preconfigured adapter subscription service. You must specify the adapter service when configuring the adapter.

Use the Browse button to locate the appropriate service for this activity.

You can choose services configured with the RVCMQ transport, but the transport is converted to RVCM when used by this activity. This is because the RVCMQ transport does not apply to publishing activities.

RequestReply

Specifies that this publish activity is sending a request message and expecting a response message. This is similar to using the Invoke an Adapter Request-Response Service activity, except this activity uses an adapter Subscription service instead of a Request-Response service.

When this field is checked, the Request AE Schema and Reply AE Schema fields appear. Also, the replyDestination element appears in the activity output.

Request AE Schema

Only appears when the RequestReply field is checked. This field specifies the TIBCO ActiveEnterprise schema to use for the body of the message in the input of this activity.

Reply AE Schema

Only appears when the RequestReply field is checked. This field specifies the TIBCO ActiveEnterprise schema to use as the output reply message.

Custom AESchema

Specifies whether you want to supply a class for this activity’s input.

Custom AESchema Reference

Only appears when the Custom AESchema field is checked. This field specifies the TIBCO ActiveEnterprise schema to use for the body of the message in the input of this activity.

See Transport Tab for more information about the Transport tab.

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
subject	string	The subject to send the request on. The default subject is displayed on the Advanced tab, but you can override the default by specifying a subject here.
requestTimeout	integer	When publishing in request/reply mode, this element specifies the timeout (in milliseconds) to wait for the reply.
preRegisterListener	string	When using TIBCO Rendezvous Certified Messaging (RVCM), this field specifies the cmname(s) of the RVCM subscriber(s). This allows the publisher to pre-register with any expected listeners. If multiple cmnames are specified, separate each cmname with a comma. Any listeners preregistered on the Transport tab are also preregistered with the listeners specified in this element. See the TIBCO Rendezvous documentation for more information about RVCM.
replySubject	string	The subject that replies to this message should be sent to.
businessKey	string	This string is appended to the AE tracking info appInfo field. The AE tracking info for messages published is a concatenation of bw + <processName> + <jobID> + <businessKey>. The AE tracking info id is set to the same value for all message publishers in a process definition. Note: It is a good idea to have all publishers in a process use the same business key. Only the most recent publisher’s business key is used in the tracking info for the message.
OtherProperties	complex	This element is only available when JMS Topic or JMS Queue is the transport and a JMS Application Properties resource is specified on the Transport tab. This element contains the message properties for the message. See JMS Properties for more information about message properties. Only properties applicable to this type of message are displayed.
body	complex	The schema definition for the specified adapter service. This can be overridden by specifying a different schema in the Custom AESchema Reference field on the Configuration tab, or by specifying a Request AE Schema when RequestReply is checked on the Configuration tab.

The subject to send the request on. The default subject is displayed on the Advanced tab, but you can override the default by specifying a subject here.

requestTimeout

integer

When publishing in request/reply mode, this element specifies the timeout (in milliseconds) to wait for the reply.

preRegisterListener

string

When using TIBCO Rendezvous Certified Messaging (RVCM), this field specifies the cmname(s) of the RVCM subscriber(s). This allows the publisher to pre-register with any expected listeners. If multiple cmnames are specified, separate each cmname with a comma. Any listeners preregistered on the Transport tab are also preregistered with the listeners specified in this element.

See the TIBCO Rendezvous documentation for more information about RVCM.

replySubject

string

The subject that replies to this message should be sent to.

businessKey

string

This string is appended to the AE tracking info appInfo field. The AE tracking info for messages published is a concatenation of bw + <processName> + <jobID> + <businessKey>.

The AE tracking info id is set to the same value for all message publishers in a process definition.

Note: It is a good idea to have all publishers in a process use the same business key. Only the most recent publisher’s business key is used in the tracking info for the message.

OtherProperties

complex

This element is only available when JMS Topic or JMS Queue is the transport and a JMS Application Properties resource is specified on the Transport tab.

This element contains the message properties for the message. See JMS Properties for more information about message properties. Only properties applicable to this type of message are displayed.

body

complex

The schema definition for the specified adapter service. This can be overridden by specifying a different schema in the Custom AESchema Reference field on the Configuration tab, or by specifying a Request AE Schema when RequestReply is checked on the Configuration tab.

This activity only produces output when the RequestReply field on the Configuration tab is checked. The output for the activity is the following.

Output Item	Datatype	Description
replyDestination	string	A reply message can optionally have a reply destination, presumably so that the two applications can communicate with further messages. This element contains the reply subject (RV) or destination (JMS) set on the reply message, if one is set. If no reply subject or destination is set on the reply message, this element is not populated.
trackingInfo	string	The AE tracking info. The id element is set to the same value for all message publishers in a process definition. The appInfo element is obtained from the businessKey element on the Input tab.
MessageID	string	This element is only available when JMS Topic or JMS Queue is the transport. This is the message ID of the message.
JMSHeaders	complex	This element is only available when JMS Topic or JMS Queue is the transport. This element contains the message header fields for the message. See JMS Properties for more information about message header fields. Only properties applicable to this type of message are displayed.
OtherProperties	complex	This element is only available when JMS Topic or JMS Queue is the transport and a JMS Application Properties resource is specified on the Transport tab. This element contains the message properties for the message. See JMS Properties for more information about message properties. Only properties applicable to this type of message are displayed.
body	complex	The specified reply schema.

A reply message can optionally have a reply destination, presumably so that the two applications can communicate with further messages. This element contains the reply subject (RV) or destination (JMS) set on the reply message, if one is set. If no reply subject or destination is set on the reply message, this element is not populated.

trackingInfo

string

The AE tracking info.

The id element is set to the same value for all message publishers in a process definition. The appInfo element is obtained from the businessKey element on the Input tab.

MessageID

string

This element is only available when JMS Topic or JMS Queue is the transport. This is the message ID of the message.

JMSHeaders

complex

This element is only available when JMS Topic or JMS Queue is the transport.

This element contains the message header fields for the message. See JMS Properties for more information about message header fields. Only properties applicable to this type of message are displayed.

OtherProperties

complex

This element is only available when JMS Topic or JMS Queue is the transport and a JMS Application Properties resource is specified on the Transport tab.

This element contains the message properties for the message. See JMS Properties for more information about message properties. Only properties applicable to this type of message are displayed.

body

complex

The specified reply schema.

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
TransportException	The transport cannot be created.
SerializationException	The outgoing message cannot be serialized.
TimeoutException	The specified timeout has been reached for the request/reply operation.

Exception

Thrown When...

TransportException

The transport cannot be created.

SerializationException

The outgoing message cannot be serialized.

TimeoutException

The specified timeout has been reached for the request/reply operation.