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

SCARequest node

Use the SCARequest node to send a request to WebSphere® Process Server. The node is a synchronous request and response node, and blocks after sending the request until the response is received. The node can also send one-way requests.

This topic contains the following sections:

Purpose
Using this node in a message flow
Configuring the SCARequest node
Terminals and properties

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 SCARequest node sends synchronous outbound two-way (request-response) requests, and one-way (request only) operations, to a business process on WebSphere Process Server.

An outbound Broker SCA definition (.outsca) file is required to configure the SCARequest node. The Broker SCA definition contains specific data related to the binding that is used by the SCA Export component.

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

SCARequest node icon

Using this node in a message flow

You can use the node in any message flow that needs to call an application running on WebSphere Process Server.

You can change the SSL client 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

You can change the timeout by changing the value in the following location in the local environment:

LocalEnvironment.Destination.SCA.Request.Timeout

You can change the timeout by changing the value in the following location in the local environment:

LocalEnvironment.Destination.SCA.Request.Timeout

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

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

LocalEnvironment.Destination.SCA.Request.Binding.MQ.replyToQMgr
LocalEnvironment.Destination.SCA.Request.Binding.MQ.replyToQ

Configuring the SCARequest node

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

There are two methods of putting an instance of the SCARequest 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.

If the request contains a two-way operation, the node blocks until a response message is received, or for the time defined by the timeout property (120 seconds by default). If the timeout period is exceeded, the message received on the input terminal of the SCARequest is propagated to the Failure terminal.

The SOAP, XMLNSC, XMLNS, MRM, MIME, JSON, DFDL, and BLOB domains are available to parse the response.

If the Binding type is Web Service, the message domain is SOAP.
If the Binding type is MQ, the default domain is BLOB if any operations have non-XML data bindings. If all operations have XML data binding the default domain is XMLNSC. The data binding is identified as XML if the SCA Export uses com.ibm.websphere.sca.mq.data.impl.mqdatabindingimplxml or com.ibm.wbiserver.datahandler.xml.XMLDataHandler.

If the request contains a one-way operation, the node sends the request message, then routes the input message through to the Out terminal. In this case, the properties in the Response Message Parsing tab are unavailable.

The values for many of the properties of the node are provided by 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.

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

Terminals and properties

The SCARequest node terminals are described in the following table.

Name	Type	Description
In	Input data	The node is driven by a message arriving on the In terminal.
Out	Output data	When a message has been sent to an external resource it is sent to the Out terminal unchanged, except for the addition of status information.
Failure	Output data	A failure in the node is sent to the failure terminal.
Fault	Output data	A SOAP fault from the external system is sent to this terminal. This terminal is only used when the Binding type is Web Services.

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

Property	M	C	Default	Description
Broker SCA Definition	Yes	No	none	The name of the Broker SCA Definition that contains configuration properties for the SCA Request node. Click the browse button to list all relevant Broker SCA Definitions in the current workspace.

The Binding properties of the SCARequest node are described in the following table.

Property	M	C	Default	Description
Binding type	Yes	No	none	The binding type that was found in the SCA Export.
Request Timeout	No	Yes	120	The time in seconds before the request times out waiting for a response from WebSphere Process Server. If the timeout period is exceeded, the message received on the input terminal of the SCARequest is propagated to the Failure terminal. This property is disabled if the Broker SCA definition (inbound) contains only one-way operations.

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

Property	M	C	Default	Description
WSDL file name	Yes	No	<none>	This property type is String. When you select a WSDL file for the WSDL file name field, the WSDL is validated to ensure that it is WS-I compliant. Only Deployable WSDL can be used to configure the SCA nodes. After a valid WSDL file is selected, the message set project to which WSDL file belongs is added as a referenced project to the corresponding flow project, if the reference does not exist.
Port type	Yes	No	From WSDL	This property type is String. The field lists all the Port types defined in WSDL file selected in the WSDL file name property. Error Conditions: Selected Port type does not contain at least one operation. WSDL properties are disabled when the node is configured to act in gateway mode.
Imported Binding	Yes	No	From WSDL	This property type is String. This property is updated every time that the Port type value changes. The field lists the imported SOAP bindings with HTTP or JMS transport associated with the selected Port type. When you select a binding, the property tab for the associated transport is enabled; otherwise, it is disabled. Bindings are listed in the same order in which they appear in the WSDL file. The selected binding is the one that has both ports and operations. If there is no such binding, then binding with ports is selected. If no bindings have ports then the first binding in the list is selected. Error Conditions: No SOAP bindings (with HTTP or JMS transport) in the WSDL file are associated with the Port type. The selected binding does not have any operations. WSDL properties are disabled when the node is configured to act in gateway mode.
Operation	Yes	No	From WSDL	This property type is String. The Binding operation box contains all the operations defined by the selected binding. The first operation in the list is selected by default. This property is updated every time the selected binding value changes WSDL properties are disabled when the node is configured to act in gateway mode.
Service port	Yes	No	From WSDL	This property type is String. This field is updated every time that the selected binding is updated. This field lists all the WSDL ports that point to the selected binding. The first service port for the binding is selected by default. This property is updated every time the selected binding value changes. Error Conditions: No ports point to the selected binding. WSDL properties are disabled when the node is configured to act in gateway mode.
Target namespace	Yes	No	From WSDL	Target namespace is implemented as a read-only field. This hidden property type is String. It is updated with the Target namespace of the WSDL file when the WSDL file name is configured. WSDL properties are disabled when the node is configured to act in gateway mode.
Web service URL	Yes	Yes	none	The URL of the SOAP address selected. 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 then 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 colon : before the port number. <path> has a default of /. If you specify a value, you must include the / before the path. For more details of how to override this property, see Changing the default URL for a SOAPRequest node or a SOAPAsyncRequest node request.
Propagate only SOAP Body, owned by XMLNSC domain	No	No	false	If selected, only the SOAP body is propagated, otherwise the entire SOAP message is propagated.
Use WS-Addressing	No	No	false	Select the check box if you want to use WS-Addressing.
SSL client authentication key alias	No	Yes	"" (empty string)	The keyAlias property specifies an SSL authentication alias for the client-side of an SCA 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.

Property	M	C	Default	Description
Operation	Yes	No	From WSDL	The selected operation from the selected binding in the WSDL file. The WSDL is not displayed; the WSDL is in the Broker SCA Definition file.
Queue name	Yes	Yes	none	The queue that receives a request message from IBM Integration Bus.
Queue manager name	Yes	Yes	none	The Queue Manager that receives a request from IBM Integration Bus.
Reply-to queue name	Yes	Yes	none	The queue that receives a response message from WebSphere Process Server.
Reply-to queue manager name	No	Yes	none	The Queue Manager that receives a response from WebSphere Process Server.
Response Message Correlation	Yes	No	FromMsgId	This property indicates how IBM Integration Bus is to complete correlation ID information in the response message.

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

Property	M	C	Default	Description
Message domain	No	No	Set automatically according to the binding that is defined in the corresponding node.	The domain that is used to parse the response message. It is determined according to the Binding type. You can change this property if the Binding type is MQ. The property is read-only when the Binding type is Web Services.
Message model	No	No	Picked automatically according to the Broker SCA definition that is chosen in the corresponding node.	The name or location of the message model in which the response message is defined. The Message model is set automatically to the message model that contains the SCA file that is configured on the corresponding node. This property is read-only.
Message	No	No	Picked automatically according to the Broker SCA definition that is chosen in the corresponding node.	The node detects the message automatically. You can change this property if the Binding type is MQ and the message domain is MRM. You cannot change this property if the Binding type is Web Services.
Physical Format	No	No		The name of the physical format of the response message. You can change this property if the Binding type is MQ and the message domain is MRM. You cannot change this property if the Binding type is Web Services.

The validation properties are described in the following table. For more information, see Validation properties.

Property	M	C	Default	Description
Validate	No	Yes	Content and value	This property controls whether validation takes place. Valid values are None, Content and value, and Content.
Failure action	No	No	Exception	This property controls what happens if validation fails. You can set this property only if you set Validate to Content or Content and value. Valid values are User Trace, Local Error Log, Exception, and Exception List.

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.

bc34002_.htm |

Last updated Friday, 21 July 2017