Copyright © Cloud Software Group, Inc. All Rights Reserved

Invoke an Adapter Request-Response Service

Activity

The Invoke an Adapter Request-Response Service activity is used to communicate with an adapter’s request-response service. This service invokes an operation with input and output by way of the adapter. Request-response 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 request-response services.

Figure 3 illustrates an Invoke an Adapter Request-Response Service activity sending a request to an adapter request-response service.

Figure 3 An Invoke an Adapter Request-Response Service activity sending a request

Configuration

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 request-response invocation 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.
Operation	No	This field contains a drop down list of any operations defined by the schema used in the selected Adapter Service. Select the operation that you want to invoke.
One Way	No	This is a read-only field that displays whether the selected operation is one-way.

Transport

See Transport Tab for more information about the Transport tab.

Input

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	The time to wait (in milliseconds) for the synchronous request-reply operation to complete. An error is returned if the operation does not complete in this time limit.
replySubject	string	The Subject/Destination that is used to send the response when using the RV/JMS transport.
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>. 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 input parameters for the specified operation. The input parameters are defined by the operation class for the specified Adapter Service for this activity.

Output

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.
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 reply schema for the specified operation.

Error Output

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.
DeserializationException	The incoming response message cannot be serialized.
ConfirmationException	The message could not be confirmed.
TimeoutException	A timeout occurred.
operationException	The adapter service returned an exception encountered while performing the operation. Any exception class defined on the operation schema can be returned. The potential exceptions are displayed as a choice element for activities after an error transition.

Copyright © Cloud Software Group, Inc. All Rights Reserved