IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

SCAAsyncRequest node

Use the SCAAsyncRequest node with the SCAAsyncResponse node to construct a pair of message flows that invoke a WebSphere® Process Server service component asynchronously.

Note: From Version 7.5 onwards, WebSphere Process Server has been renamed IBM® Business Process Manager Advanced. Information in this topic that refers to WebSphere Process Server Version 7.0 is also applicable to IBM Business Process Manager Advanced Version 7.5.

Purpose

The SCAAsyncRequest node sends a request to a business process that is running on WebSphere Process Server, but the node does not wait for the associated response to be received. However, the SCAAsyncRequest node does wait for an acknowledgment before continuing with the message flow. The response to the Process Server request is received by the SCAAsyncResponse node, which can be in the same message flow or in a separate message flow. The nodes are used as a pair, and correlate responses against the original requests.

Diagram showing the relationship between the SCAAsynchronousRequest node and the SCAAsynchronousResponse node.

The SCAAsyncRequest node is the first half of the asynchronous request and response node pair. The SCAAsyncRequest node sends a request to a business process that is running on WebSphere Process Server. The request is sent by the SCAAsyncRequest node, but the SCAAsyncRequest node does not receive the response. The response is received by a SCAAsyncResponse node that is running on a different thread. The SCAAsyncResponse node is typically at the beginning of a different message flow; however, it must be in the same integration server as the SCAAsyncRequest node.

A Broker SCA definition is required to configure both the SCAAsyncRequest node and the SCAAsyncResponse node. The Broker SCA definition contains specific data related to the Process Server binding.

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

SCAAsyncRequest node icon

Using this node in a message flow

Look at the following sample to see how to use the node:

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 change the operation that should be invoked by changing the value in the following location in the local environment:

LocalEnvironment.Destination.SCA.Request.Operation

For a Web Services binding, you can change the URL to which the request is sent. Change the value in the following location in the local environment:

LocalEnvironment.Destination.SCA.Request.Binding.WebServices.Transport.HTTP.WebServiceURL

For an MQ binding, you can change the Request Queue Manager and Request Queue by changing the values in the following locations:

LocalEnvironment.Destination.SCA.Request.Binding.MQ.queueManagerName
LocalEnvironment.Destination.SCA.Request.Binding.MQ.queueName

You can store context data in the following location in the local environment. The SCAAysncResponse node can later retrieve this data.

LocalEnvironment.Destination.SCA.Request.UserContext
You can change the SSL authentication key alias by changing the value in the following location in the local environment:
LocalEnvironment.Destination.SCA.Request.Binding.WebServices.Transport.HTTP.KeyAlias
You can enable CRL checking for SSL connections used by this node by setting the value in the following location in the local environment to true:
LocalEnvironment.Destination.SCA.Request.Binding.WebServices.Transport.HTTP.EnableCRLChecking

Configuring the SCAAsyncRequest node

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

There are two methods of putting an instance of the SCAAsyncRequest 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 node onto the canvas
If you have dragged an instance of the node from the palette onto the canvas, use one of the following methods to start to configure it:
  • Drag a Broker SCA definition with an extension of .outsca onto the node.
  • Type the file name in the SCA file name option in the Properties view of the node.
  • Browse to the file (SCA file name option in the Properties view of the node.)
Dragging a .outsca file onto the canvas
  • If the .outsca file contains a WSDL that has only a single, one-way operation defined, a SCARequest node is created.
  • If the .outsca file contains a WSDL that only has request-response operations, you first select the operation, and say whether you want the outbound request to be sent synchronously or asynchronously. For a synchronous request, a SCARequest node is created and configured. For an asynchronous request, a pair of SCAAsyncRequest and SCAAsyncResponse nodes are created and configured.
  • If the .outsca file contains a WSDL that has a mixture of one-way and request-response operations defined, and you select a one-way operation, a SCARequest node is created.

The values for many of the node properties are provided in 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 string 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 SCAAsyncRequest 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.
      • Type a file name that is relative to the message set project in which the Broker SCA definition exists.
      • 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, 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.
  3. On the Binding tab, specify properties that relate to the WebSphere Process Server 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. It is read-only. Possible values are:
      • WebService. Requests from WebSphere Process Server are sent as SOAP messages over the HTTP transport. See the WSDL properties table in Terminals and properties for details of binding properties that are either supplied by the Broker SCA definition, or that you need to set.
      • MQ. Requests from WebSphere Process Server arrive as WebSphere MQ messages. See the MQ properties table and the Transactionality table in Terminals and properties, for details of binding properties that are either supplied by the Broker SCA definition, or that you need to set.

For information on configuring the SCAAsyncRequest node to use SSL, see Setting up a public key infrastructure and review the information that relates to the SOAPAsyncRequest node.

Terminals and properties

The SCAAsyncRequest node terminals are described in the following table.

Terminal Description
In The input terminal that accepts a message.
Failure The output terminal to which the message is sent if a failure is detected in the node.
Out The output terminal to which the message is sent after the node has successfully sent the message to the SCA resource.

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 SCAAsyncRequest node are described in the following table.

Property M C Default Description
Node name No No The node type The name of the node.
Short description No No None A brief description of the node.
Long description No No None Text that describes the purpose of the node in the message flow.

The Basic properties of the SCAAsyncRequest node are described in the following table.

Property M C Default Description
Unique identifier Yes Yes Not set The property specifies a unique identifier that is common to your pair of SCAAsyncRequest and SCAAsyncResponse nodes.
Broker SCA definition Yes Yes Not set The property specifies the name of the Broker SCA definition that contains configuration properties for the SCAAsyncRequest node. You can click Browse to see a list of all relevant Broker SCA definitions in the current workspace.

The Binding property of the SCAAsyncRequest node is described in the following table.

Property M C Default Description
Binding type Yes No From SCA export This property is read-only. It is supplied by the toolkit when the SCA export configuration file is parsed. The property describes the binding type that was found in the Broker SCA definition. If the binding is Web Services, only the WSDL properties are shown. If the binding is MQ, only the MQ properties are shown.

The WSDL properties are described in the following table. These properties are shown only if the binding type is Web Services.

Note: The values for the properties must be supplied on the node. They are not marked as mandatory on the node because the Broker SCA definition might not contain all the property values, resulting in node errors being shown. You must supply values for those properties that have not been configured by the Broker SCA definition file.
Property M C Default Description
WSDL file name Yes No Not set The WSDL file name is taken from the WSDL file that is referenced by the Broker SCA definition.
Target namespace No No From Broker SCA definition This property type is String. It is supplied by the toolkit when the WSDL configuration file that is referenced by the Broker SCA definition is parsed.
Port type Yes No By default, the Port type that is referenced in the Broker SCA definition. This property type is String. This property is read-only.
Error Conditions:
  • The selected Port type does not contain at least one operation.
Imported binding Yes No From Broker SCA definition This property type is String. It is supplied by the toolkit when the WSDL that is referenced by the Broker SCA definition is parsed.
Error Conditions:
  • No SOAP bindings (with HTTP transport) in the WSDL file are associated with the Port type.
  • The selected binding does not have any operations.
Operation Yes No From Broker SCA definition This property type is String.

The Operation property lists the operations that are defined by the port type. The first two-way operation in the list is selected by default.

Only two-way operations are supported.
Service port Yes No From Broker SCA definition This property type is String. It is supplied by the toolkit when the WSDL configuration file is parsed.
Error Conditions:
  • No ports point to the selected binding.
Web service URL Yes Yes From Broker SCA definition This property type is String. This property is automatically derived from the <soap:address> element of the selected Service port. Whenever the selected port is updated, the Web service URL is updated accordingly. However, if you override the value, your value persists and the URL is no longer updated from the service port.
If you choose to override this property you must specify it in the form http://<hostname>[:<port>]/[<path>] where:
  • http://<hostname> must be specified.
  • <port> has a default of 80. If you specify a value, you must include the : before the port number.
  • <path> has a default of /. If you specify a value, you must include the / before the path.
SSL client authentication key alias No Yes "" (empty string) The keyAlias property specifies an SSL authentication key alias for the client-side of an SCAAsyncRequest connection. Taking the default value means that the first appropriate key is chosen for you automatically.
Enable certificate revocation list checking No Yes Not selected This property specifies whether CRL checking should be enabled for SSL connections

The MQ properties are described in the following table. These properties are shown only if the binding type is MQ.

Note: The values for the properties must be supplied on the node. They are not marked as mandatory on the node because the Broker SCA definition might not contain all the property values, resulting in node errors being shown. You must provide values for those properties that have not been configured by the Broker SCA definition file.
Property M C Default Description
Operation Yes No From the Broker SCA definition The available operations that are found in the interface of the Broker SCA definition. Only two-way operations are supported.
Queue name Yes Yes From the Broker SCA definition The name of the queue that receives a request message from IBM Integration Bus. This is taken from the Broker SCA definition, but can be updated directly in the node.

This can be a remote queue; see "How does distributed queuing work?" in the Intercommunication section of the WebSphere MQ information center.

Queue manager name Yes Yes From the Broker SCA definition The name of the queue manager that receives a message from IBM Integration Bus. It is taken from the Broker SCA definition, but can be updated directly in the node.

If a remote queue is used, leave this property blank to allow WebSphere MQ to resolve the queue manager name.

Reply-to queue name Yes Yes From the Broker SCA definition The name of the queue that receives a response message from WebSphere Process Server. It is taken from the Broker SCA definition, but can be updated directly in the node.
Reply-to queue manager name No Yes From the Broker SCA definition The name of the queue manager that receives a response from WebSphere Process Server. It is taken from the Broker SCA definition, but can be updated directly in the node.

This queue manager must be local to the broker.

Response message correlation Yes No From the Broker SCA definition This property indicates how WebSphere Process Server provides correlation ID information in the response message. This correlation information is used by the IBM Integration Bus to determine which message is a response to which request, and is supplied by the toolkit when the SCA export file is parsed.

Select From Message ID if the WebSphere Process Server is expected to copy the MQMD MSGID field in the request to the MQMD CORRELID field in the response.

Select From Correl ID if the WebSphere Process Server is expected to copy the MQMD CORRELID field in the request to the MQMD CORRELID field in the response.

The Transactionality property of the SCAAsyncRequest node is described in the following table.

Property M C Default Description
Transaction mode No No For MQ, 'yes' This property can be 'automatic', 'no', or 'yes'. The property is enabled only when the Binding type is MQ.
The Monitoring properties of the node are described in the following table.
Property M C Default Description
Events No No None Events that you have defined for the node are displayed on this tab. By default, no monitoring events are defined on any node in a message flow. Use Add, Edit, and Delete to create, change or delete monitoring events for the node; see Configuring monitoring event sources using monitoring properties for details.

You can enable and disable events that are shown here by selecting or clearing the Enabled check box.


ac68530_.htm | Last updated Friday, 21 July 2017