SCAAsyncResponse node

The node allows the broker to receive the response to a previous asynchronous request made from an SCAAsyncRequest node.

The node is contained in the SCA drawer of the palette, and is represented in the IBM® Integration Toolkit by the following icon:

You can view information about samples only when you use the product documentation that is integrated with the IBM Integration Toolkit or the online product documentation. You can run samples only when you use the product documentation that is integrated with the IBM Integration Toolkit.

You can retrieve context data that has been stored by the SCAAsyncRequest node from the following location in the local environment:

LocalEnvironment.SCA.Response.UserContext

You can access the SOAP header and context information in an inbound response in the local environment, at the following locations:

LocalEnvironment.SCA.Response.Binding.WebServices.SOAP.Header
LocalEnvironment.SCA.Response.Binding.WebServices.SOAP.Context

Ensure that the message set contains a Broker SCA definition with an extension of .outsca with which to configure the node.

There are two methods of putting an instance of the node into a message flow: You can either drag an instance of the node from the node palette, or drag a Broker SCA definition with an extension of .outsca from a message set, onto the message flow editor canvas. Dragging a Broker SCA definition with an extension of .outsca onto the canvas creates a pair of SCAAsyncRequest and SCAAsyncResponse nodes.

If you have dragged an instance of the node from the palette onto the canvas, you must then start to configure it by dragging a Broker SCA definition with an extension of .outsca onto the node. The values for many of the node properties are provided in the Broker SCA definition. If you have dragged a Broker SCA definition onto the canvas and created a pair of SCAAsyncRequest and SCAAsyncResponse nodes, many of the values for the node properties have already been supplied from the Broker SCA definition.

The properties of the node are displayed in the Properties view. All mandatory properties for which you must enter a value (properties that do not have a default value defined) are marked with an asterisk.

1. Optional: On the Description tab, enter a Short description, a Long description, or both. You can also rename the node on this tab.
2. On the Basic tab, set the Unique identifier and Broker SCA definition properties.
   • Unique identifier. You must specify the unique URL fragment that is common to your pair of SCAAsyncRequest and SCAAsyncResponse nodes. This property is mandatory.
   • In Broker SCA definition, specify the name of the Broker SCA definition that contains configuration properties for the node. If you have created the node by dragging a Broker SCA definition from a message set onto the Message flow editor canvas, this property is preset to the name of the Broker SCA definition. If you created the node by selecting it from the palette, you can set this property in one of the following ways:
     • If you have a Broker SCA definition, you can select it from the Broker SCA definitions by clicking Browse.
     • If you have Broker SCA definitions, but no message set, you can create a message set:
       1. Click Browse to open the Broker SCA Definition Selection pane.
       2. Click Import/Create New to open the Import Broker SCA definition wizard.
       3. Enter the message set name and message set project name, then click Next.
       4. Choose the relevant option:
          • If your Broker SCA definition exists in your workspace, click Use resources from the workspace, and select the Broker SCA definition.
          • If your Broker SCA definition is in the file system, click Use external resources, select the Broker SCA definition, then click Next.
       5. Select the Broker SCA definition to import.
       6. Click Finish. A new message set project and message set are created with message definitions. The Broker SCA definition is added to the Broker SCA Definitions folder.
       7. Select the Broker SCA definition from the Broker SCA Definition Selection window, then click OK.
     • If you have a message set but no Broker SCA definition, generate a Broker SCA definition by following the instructions in Message Sets: Generating a Broker SCA definition from a message set.
     • Drag a Broker SCA definition from a message set onto the node.
     • Type a file name that is relative to the message set project in which the Broker SCA definition exists.
3. On the Binding tab, specify properties that relate to the binding. Some of the properties on this tab are derived from the Broker SCA definition.
   The value of the Binding type property is derived from the binding information in the Broker SCA definition, and is read-only. Possible values are:

   • WebService. Web service responses are sent as SOAP messages over the HTTP transport.
   • MQ. MQ responses arrive as messages.

   The Propagate only SOAP body (owned by XMLNSC domain) check box is shown only when the Binding type is Web Services. It is not shown when the Binding type is MQ; there are no MQ-specific binding properties.

4. On the Response Message Parsing tab, the properties are set automatically from the Broker SCA Definition file.
   • If the Binding type is Web Services, the Message domain is always SOAP. If the Binding type is MQ, you can change the domain to MRM, XMLNSC, XMLNS, MIME, JSON, DFDL, or BLOB.
   • If the Binding type is MQ, the Message domain defaults to XMLNSC if the data bindings for all operations are using XML. Otherwise the default domain is BLOB.
5. On the Parser Options sub tab, set properties that are associated with the parser.
   • Parse timing is, by default, set to On Demand, which causes parsing of the message to be delayed. For information about how to cause the message to be parsed immediately, see Parsing on demand.
   • XMLNSC Parser Options. Set values for the properties that determine how the XMLNSC parser operates. For more information, see Manipulating messages in the XMLNSC domain.
6. Use the Validation tab to provide validation based on the message set for predefined messages. For more information about validation, see Validating messages. For information about how to complete this tab, see Validation tab properties.
7. Use the Instances tab to specify how additional threads are handled for the message flow.
   • The Additional instances pool property specifies whether additional instance threads are allocated from a thread pool for the whole message flow, or from a thread pool for use by that node only. By default, this property is set to Use Pool Associated with Message Flow.
   • The Additional instances property specifies the number of additional threads that the broker can use to service the message flow and has the default value 0.

The terminals of the node are described in the following table.

When you have put an instance of the node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view. All mandatory properties for which you must enter a value (properties that do not have a default value defined) are marked with an asterisk.

The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).

The Description properties of the node are described in the following table.

The Basic properties of the node are described in the following table:

The Response Message Parsing properties of the node are described in the following table. The node sets these properties automatically; the table describes when you can change them.

The Parser Options properties of the node are described in the following table.

The Validation properties of the node are described in the following table.

If validation fails, the message is propagated to the failure terminal, if this terminal is wired. For more details, see Validating messages and Validation properties.

The Instances properties of the node are described in the following table.