WebSphere Message Broker, Version 8.0.0.7 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

SCAInput node

Use the SCAInput node with the SCAReply node to process messages from WebSphere® Process Server.

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

If you use service components in WebSphere Process Server, you can use this node to start a service provided by WebSphere Message Broker. The flow acts as a SCA endpoint for the service component to use through an import binding.

The SCAInput node is contained in the SCA drawer of the message flow node palette, and is represented in the WebSphere Message Broker Toolkit by the following icon:

SCAInput 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 information center that is integrated with the WebSphere Message Broker Toolkit or the online information center. You can run samples only when you use the information center that is integrated with the WebSphere Message Broker Toolkit.

You can access the operation that is being called on an inbound request in the following location in the local environment:

LocalEnvironment.SCA.Input.Operation

You can access the SOAP Header information that is present in an inbound request from the following location in the local environment:

LocalEnvironment.SCA.Input.Binding.WebServices.SOAP.Header

You can also access the SOAP context information that is present in an inbound request in the local environment. The SOAP context is stored in the following location:

LocalEnvironment.SCA.Input.Binding.WebServices.SOAP.Context

Configuring the SCAInput node

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

You can put an instance of the SCAInput node into a message flow in either of the following ways:
  • Drag a Broker SCA definition with an extension of .insca from a message set onto the message flow editor canvas. If the .insca file contains only one-way operations, dragging a .insca file onto the canvas creates a SCAInput node. Otherwise, a pair of SCAInput and SCAReply nodes is created. If you use this method, many of the values for the properties of the node or nodes are supplied by the Broker SCA definition.
  • Drag an instance of the node from the node palette onto the canvas. You then configure the node by dragging a Broker SCA definition with an extension of .insca onto the 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.

  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 Broker SCA definition and Message routing properties.
    • In Broker SCA definition, specify the name of the Broker SCA definition that contains configuration properties for the SCAInput 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.
    • Use Message routing to specify whether to allow message propagation to dynamic terminals for the operations defined in the SCA message or to the common Out terminal. By default, each operation is routed to its own terminal. You can select:
      • Route each operation to its own terminal. The default. One terminal is generated on the node for each operation defined in the interface of the Broker SCA definition and messages are propagated to the appropriate terminal.
      • Route to a common out terminal. One Out terminal is generated on the node. All messages are propagated to this terminal. If you select this option, the Propagate only SOAP body (owned by XMLNSC domain) check box is disabled and you cannot select it.

      If you specify the Broker SCA definition property by typing a file name, or by selecting a Broker SCA definition by using the Browse facility, on an SCAInput node that already has dynamic terminals configured on it, the existing dynamic terminals are replaced. If you specify a file name that is not valid, previously existing dynamic terminals are removed and no terminals are added.

      If you drag a Broker SCA definition onto an SCAInput node that already has dynamic terminals configured on it, a dialog box is displayed allowing you to confirm whether you want to override the existing dynamic terminals with dynamic terminals that might be generated from the Broker SCA definition. If you choose to override existing dynamic terminals, any existing connections that are configured for these terminals are also deleted. You can specify that this dialog box is not displayed again.

      If you drag a Broker SCA definition onto an SCAInput node which already has an Out terminal, no dynamic terminals which be generated from the Broker SCA definition are added and the node continues to operate with its Out terminal.

  3. On the Binding tab, properties that relate to the WebSphere Process Server binding are specified. 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:
      • Web Service. 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 must 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 must set.
  4. On the Input Message Parsing tab, the properties are set automatically when the WSDL file is configured.
    • If the Binding type is Web Services, the Message domain is always SOAP.
    • 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. You can change the domain to MRM, XMLNSC, XMLNS, MIME, JSON, DFDL, or 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.
  8. Use the Retry tab to define how retry processing is carried out when a failure gets rolled back to the input node.
    • The Retry mechanism defines the format of the mechanism, and its type is Enumerate. Set the property to either Failure or Short and long retry.
    • The Retry threshold property defines the number of retries to correct the failure, and its type is Integer.
    • The Short retry interval property defines the time the client waits in seconds before attempting to correct the failure, and its type is Integer.
    • The Long retry interval property defines the time the client waits in seconds before attempting to correct the failure, and its type is Integer.

Terminals and properties

The following table describes the terminals of the SCAInput node.

Terminal Description
Failure The output terminal to which the received message is propagated when a failure (such as a message validation failure) is detected
Out The output terminal to which the message is routed if you have selected Route to common out terminal on the Message routing property.
Catch The output terminal to which the message is routed if an exception is thrown downstream and caught by this node.
* (dynamic) (Applicable only when the Binding type is Web Services.) A dynamic terminal is generated for each operation that is supported by the port type and implemented by the imported binding. The dynamic operation terminal to which the SCA message is routed depends on the operation that is defined in the SCA message when it is received.

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 following table describes the Description properties of the SCAInput node.

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 following table describes the Basic properties of the SCAInput node.

Property M C Default Description
Broker SCA definition Yes No <None> This property type is String. The name of the Broker SCA definition that contains configuration properties for the SCAInput node.
Message routing Yes No Route each operation to its own terminal This property determines whether a common Out terminal is to be used, or whether each operation is to be routed to its own terminal.
  • If the Binding type is MQ, the common out terminal is always used.
  • If the Binding type is Web Services, you can choose whether to route messages to a dynamic terminal, or to the common Out terminal.

The following table describes the Binding properties of the SCAInput node; the binding that is found in Broker SCA definition is defined here.

Property M C Default Description
Binding type Yes No Derived from the Broker SCA definition This property type is String. Its value derives from the Broker SCA definition.

The following table describes the Web Service properties of the SCAInput node. These properties are only relevant if Binding type is Web Services.

Property M C Default Description
WSDL file name Yes No <None> This property type is String. A value is given to this property when the WSDL configuration file is parsed.
Target namespace No No Derived from the Broker SCA definition This property type is String. Target namespace displays the namespace of the selected WSDL file.
Port type Yes No The default value is the port type from the Broker SCA definition. This property type is String. This property is read-only.
Error conditions:
  • Selected Port type does not contain at least one operation.
Imported binding Yes No Derived from the Broker SCA definition. This property type is String. The Imported binding box lists all the SOAP bindings that are associated with the selected port type. Bindings are listed in the order that they are displayed in the WSDL file. By default, the first binding that is pointed to by the port in the Broker SCA definition is selected. This property is updated every time the Port type value changes, and an information message is displayed that states that corresponding changes must be made in the WebSphere Process Server system.
Error conditions:
  • No SOAP bindings in the WSDL file are associated with the Port type.
  • Selected binding does not have any operations.
Service port Yes No Derived from the Broker SCA definition This property type is String. The Service port box lists all the service ports that point to the selected binding. The service port that is referenced in the Broker SCA definition is selected by default. This property is updated every time the selected binding value changes, and an information message is displayed that states that corresponding changes must be made in the WebSphere Process Server system.
Error conditions:
  • No ports point to the selected binding.
URL selector Yes Yes Derived from the Broker SCA definition This property type is String. URL selector is the HTTP path selector upon which the node accepts inbound messages.
Use HTTPS No Yes Derived from the Broker SCA definition This property type is Boolean. Its value is True if the HTTP location is an HTTPS; otherwise, its value is False.
Propagate only SOAP Body No No True This property type is Boolean. Select the check box if only the body of the SOAP message is to be propagated.
Use WS-Addressing No No False This property type is Boolean. Select the check box if WS-Addressing is to be used.

The following table describes the MQ properties of the SCAInput node. These properties are only relevant if the Binding type is MQ.

Property M C Default Description
Queue name Yes Yes Derived from the Broker SCA definition This property type is String. The value of this property can be changed directly on the node. If the property is changed, an information message is displayed that states that corresponding changes must be made to the WebSphere Process Server system.

The SCAInput node Input Message Parsing properties are described in the following table.

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 incoming message. The domain is determined according to the Binding type type. You can change this property if the Binding type is MQ. The property is read-only when the Binding type is Web Services.

This table describes the Input Message Parsing properties for the DFDL domain. You can find descriptions of the Input Message Parsing properties for other domains earlier in this topic.

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 incoming message is defined. This list is populated with all available message model files. You cannot change this property if the Binding type is Web Services.
Message No No Picked automatically according to the Broker SCA definition that is chosen in the corresponding node. The name or location of a global element that models an entire document of data, and is contained in your message model schema file. This list is populated with all available messages that are defined in the Message model that you have selected.
Physical Format No No   The name of the physical format of the incoming 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 following table describes the Parser Options properties of the SCAInput node.

Property M C Default Description
Parse timing No No On demand This property controls when an input message is parsed. Valid values are On demand, Immediate, and Complete.

For a full description of this property, see Parsing on demand.

Build tree using XML Schema data types No No Selected This property controls whether the syntax elements in the message tree have data types taken from the XML Schema.
Retain mixed content No No Cleared This property controls whether the XMLNSC parser creates elements in the message tree when it encounters mixed text in an input message. If you select the check box, elements are created for mixed text. If you clear the check box, mixed text is ignored and no elements are created.
Retain comments No No Cleared This property controls whether the XMLNSC parser creates elements in the message tree when it encounters comments in an input message. If you select the check box, elements are created for comments. If you clear the check box, comments are ignored and no elements are created.
Retain processing instructions No No Cleared This property controls whether the XMLNSC parser creates elements in the message tree when it encounters processing instructions in an input message. If you select the check box, elements are created for processing instructions. If you clear the check box, processing instructions are ignored and no elements are created.
Opaque elements No No Blank This property is used to specify a list of elements in the input message that are to be opaquely parsed. Opaque parsing is performed only if validation is not enabled (that is, if Validate is None); entries that are specified in Opaque Elements are ignored if validation is enabled.

The following table describes the Validation properties of the SCAInput node. 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 Security properties of the node are described in the following table. Set values for these properties to control the extraction of an identity from a message (when a security profile is associated with the node). For more information about these properties, see Identity, Configuring the extraction of an identity or security token, Message flow security overview, and Setting up message flow security.

Property M C Default Description
Identity token type No No None This property specifies the type of identity token present in the incoming message. Valid values are: Transport Default, Username, Username + Password, SAML Assertion, and X.509 Certificate. If this property is not specified, the identity is retrieved from the Basic-Auth transport header and the type is set to Username.
Identity token location No No None This property specifies where, in the message, the identity can be found. The location is specified as an ESQL field reference, an XPath expression, or a string literal. If you use a string literal, it must be enclosed in single quotation marks and must not contain a period (.), If this property is not specified, the identity is retrieved from the MQMD.UserIdentifier transport header.
Identity password location No No None This property specifies where, in the message, the password can be found. The location is specified as an ESQL field reference, an XPath expression, or a string literal. If you use a string literal, it must be enclosed in single quotation marks and must not contain a period (.), If it is not specified, the password is not set. This property can be set only if Identity token type is set to Username + Password.
Identity IssuedBy location No No None This property specifies a string or path expression that describes the issuer of the identity. The location is specified as an ESQL field reference, an XPath expression, or a string literal. If you use a string literal, it must be enclosed in single quotation marks and must not contain a period (.), The value specifies the Issuer that is passed to a WS-Trust v1.3 STS provider. If this property is not specified, the MQMD.PutApplName value is used. If you leave the Identity issuedBy location field blank and the MQMD.PutApplName is also blank, the string MQ is used.
Treat security exceptions as normal exceptions No No False This property specifies whether to treat security exceptions (such as "Access Denied") as normal exceptions, and propagate them to the Failure terminal (if wired). This property is turned off by default, which ensures that security exceptions cause the message to be backed out even if the Failure terminal is wired.

The following table describes the Instances properties of the SCAInput node.

Property M C Default Description
Additional instances pool No Yes Use Pool Associated with Message Flow The pool from which additional instances are obtained.
  • If you select Use Pool Associated with Message Flow, additional instances are obtained from the message flow value.
  • If you select Use Pool Associated with Node, additional instances are allocated from the additional instances of the node, based on the number specified in the Additional instances property.
Additional instances No Yes 0 The number of additional instances that the node can start if the Additional instances pool property is set to Use Pool Associated with Node. By default, no additional instances are given to the node.

The following table describes the Retry properties of the SCAInput node.

Property M C Default Description
Retry mechanism No No Failure This property specifies how retry processing is handled when a failure is rolled back to the SCAInput node.
  • If you select Failure, retry processing is not performed so you cannot set the remaining properties.
  • If you select Short and long retry, retry processing is performed first at the interval that is specified by the Short retry interval property, and if that is unsuccessful, it is then performed at the interval that is specified by the Long retry interval property.
Retry threshold No Yes 0 The maximum number of times that retry processing is performed for short retry.
Short retry interval No Yes 0 The interval between short retry attempts.
Long retry interval No Yes 0 The interval between long retry attempts.

The Transactionality property of the SCAInput 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 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.

Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2016Copyright IBM Corporation 1999, 2016.

        
        Last updated:
        
        Last updated: 2016-05-23 14:46:33


Reference topicReference topic | Version 8.0.0.7 | ac68510_