Wait for Adapter Request

Waits for the receipt of a request from an adapter request-response invocation service. The adapter sends a request using a preconfigured service, and the process definition acts as the implementation of the request. The process sends any required responses back to the adapter’s service by placing the Respond to Adapter Request activity at a later point in the process definition.

Adapter request-response invocation 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 services.

See Scalability With Incoming Events in TIBCO ActiveMatrix BusinessWorks Process Design Guide for information on running the "Wait for..." activities in a multi-engine mode.

Figure 8 illustrates a Wait for Adapter Request activity waiting for a request from an adapter request-response invocation service. At a later point in the business process, a Respond to Adapter Request activity sends the response.

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.
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 this process definition is waiting for.

Field	Description
Candidate Event Key	Expression built from the data of the incoming message. This expression should evaluate to a string and it is compared to the "key" field of the activity’s input. If the Candidate Event Key and the activity’s key match, then the process accepts the incoming message. For example, you may have a Invoke an Adapter Request-Response activity that sends a request with a particular ID. You are expecting a response message that contains that same ID so that you can determine the message is a response to your sent message. You would specify the field of the incoming reply that contains your ID in the Candidate Event Key. You would then use the message ID of the request you sent earlier in the process as the "key" field in the input. This expression is specified in XPath, and only data from the incoming event is available for use in this XPath expression. See TIBCO ActiveMatrix BusinessWorks Process Design for more information about XPath expressions.
Event Timeout (msec)	A message may arrive before this activity is executed. This field specifies the amount of time (in milliseconds) a message waits if it is received before this activity is executed. If the event timeout expires, an error is logged and the event is discarded. If no value is specified in this field, the message waits indefinitely. If zero is specified, the event is discarded immediately, unless this activity has already been reached.

Input Item	Datatype	Description
key	string	The value that is compared to the Candidate Event Key field of the Event tab to determine if this message applies to this process. See Event for an example of using the Candidate Event Key field with the key input item.
processTimeout	integer	The time (in milliseconds) to wait for the incoming message. An error is returned if the message is not received in this time limit.

Output Item	Datatype	Description
subject	string	The subject of the message.
certifiedSequenceNumber	string	This element is only available when Tibrv Certified is the transport. This element contains the sequence number in which this message was received.
certifiedSender	string	This element is only available when Tibrv Certified is the transport. This element contains the cmname of the message sender.
trackingInfo	complex	The AE tracking info of the sender. This element contains the tracking ID and appInfo sent by the application.
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 class specified for the client service of the specified adapter configuration or the schema specified in the Custom AESchema Reference field on the Configuration tab.