Invoke an Adapter Request-Response Server
The Invoke an Adapter Request-Response Server activity is used to communicate with Request-Response Service. This service invokes an operation with input and output of the adapter.
Invoke an Adapter Request-Response Service is configured based on adapter configuration, and the activity uses the information in the adapter configuration to configure this activity.
The following figure illustrates an Invoke an Adapter Request-Response Server activity sending a request to Request-Response Service.
General
Advanced
The Advanced tab contains the Transport Type field. You can select a transport type in the Transport Type list. For more information, see Transport Type.
Input Editor
The Input Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map messages are name or value pairs.
You can use the schema to define the structure of the outgoing request and the incoming reply. The schema defined in the Input Editor tab becomes the body of the message in the Input tab.
Output Editor
The Output Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map messages are name or value pairs.
You can use the schema to define the structure of the outgoing request and the incoming reply. The schema defined in the Output Editor tab becomes the body of the message in the Output tab.
Input
Input Item | Data Type | Description |
---|---|---|
subject | String | The subject of the message. |
requestTimeout | Integer | When publishing in request/reply mode, you can specify the timeout (in milliseconds) to wait for the reply. |
replySubject | String | The reply subject of the message. |
businessKey | String | This string is appended to the AE tracking specified in the trackingInfo field. |
OtherProperties | Complex | This element contains the message properties for the message. Only properties applicable to this type of message are displayed.
It is available only when JMS Queue or JMS Topic is the transport and JMS Application Properties in the Transport Type configuration are specified. For more information about message properties, see "JMS Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and Palette Reference. |
Output
Output Item | Data Type | Description |
---|---|---|
replyDestination | String | A reply message can have a reply destination, so that the two applications can communicate with incoming 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 | Complex | The AE tracking information of the sender.
This element is a concatenation of "BW." + Application_Name + Module_Name + Process_Name + Activity_Name + User_Part (Business_Key). |
JMSHeaders | Complex | This element contains the message header fields for the message. Only properties applicable to this type of message are displayed.
It is available only when JMS Queue or JMS Topic is the transport. For more information about message header fields, see "JMS Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and Palette Reference. |
OtherProperties | Complex | This element contains the message properties for the message. Only properties applicable to this type of message are displayed.
It is available only when JMS Queue or JMS Topic is the transport and JMS Application Properties in the Transport Type configuration are specified. For more information about message properties, see "JMS Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and Palette Reference. |
body | Complex | A complex schema type specified for the adapter service or a complex schema type designated by a user. |
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault | 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 cannot be confirmed. |
TimeoutException | A timeout error occurs. |
OperationException | The adapter service returns an exception encountered while performing the operation. Any exception class defined on the schema can be returned.
The potential exceptions are displayed as a choice element for activities after an error transition. |