Wait for Rendezvous Message

The Wait for Rendezvous Message activity waits to receive a TIBCO Rendezvous message with the given subject.

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.

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.
Subject	Yes	The subject on which to listen for the TIBCO Rendezvous message.
Transport	Yes	The TIBCO Rendezvous transport parameters. These are specified as a Rendezvous Transport shared configuration resource. See Rendezvous Transport for more information about shared configuration resources.
XML Format	No	If checked, the body of the incoming TIBCO Rendezvous message is expected to be a single field named "xml". This field is a byte array containing the body of the message. TIBCO ActiveMatrix BusinessWorks automatically deserializes the xml field and represents the message as a schema tree in this activity’s output.
Needs Output Validation	No	Specifies that you would like the incoming message to be validated against the schema specified on Output Editor tab. An error is returned if an incoming message does not match the specified schema. Validation does affect system performance, and you may want to uncheck this field to handle incoming messages more quickly. If you uncheck this field, no validation is performed and any incoming message that does not match the specified schema is processed. You should only uncheck this field if you can guarantee that incoming messages conform to the expected schema.
Needs Output Filtration	No	Specifies that only fields that match the name and datatype of the schema elements specified on the Output Editor tab should be processed. Any elements that do not match the specified schema are ignored and not included in this activity’s output. This is useful if you need only a subset of the fields of an incoming message. Any unnecessary fields are not included in the activity output. This can save memory, and consequently improve performance. Note: This option is only valid when the XML Format field is unchecked. Do not select this check box when the XML Format field is also selected.
XML-Compliant Field Names	No	Specifies whether the field names of the incoming message should be altered so that they comply with XML and ActiveEnterprise naming rules. Only field names that do not comply with XML and ActiveEnterprise naming rules are altered when this field is unchecked. When checked, field names are left unaltered.

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 Publish Rendezvous Message activity that sends a message with a particular ID. You are expecting a reply 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 message that contains your ID in the Candidate Event Key. You would then use the message ID of the message 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
sendSubject	string	The subject of the received message.
replySubject	string	The reply subject of the TIBCO Rendezvous message.
certifiedSender	string	This element is only available when RVCM transports are used. This element contains the CM name of the message sender.
certifiedSequenceNumber	integer	This element is only available when RVCM transports are used. This element contains the sequence number of the message.
body	complex	The body of the TIBCO Rendezvous message. The elements contained in this element are specified on the Configuration tab.

Exception	Thrown When...
ActivityTimedOutException	A timeout has been reached.