SCAInput node
Use the SCAInput node with the SCAReply node to process messages from WebSphere® Process Server.
- Developer
- Application Integration Suite
- Standard
- Advanced
- Scale
- Adapter
Purpose
If you use service components in WebSphere Process Server, you can use this node to start a service provided by IBM Integration Bus. 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 IBM Integration Toolkit by the following icon:
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 |
---|---|---|---|---|
IBM Integration Bus SCA definition | Yes | No | <None> | This property type is String. The name of the IBM Integration Bus 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.
|
The following table describes the Binding properties of the SCAInput node; the binding that is found in IBM Integration Bus SCA definition is defined here.
Property | M | C | Default | Description |
---|---|---|---|---|
Binding type | Yes | No | Derived from the IBM Integration Bus SCA definition | This property type is String. Its value derives
from the IBM Integration Bus
SCA definition. If an MQ binding is specified, WebSphere MQ is used to process the messages, which means that WebSphere MQ must be installed on the same machine as the integration node, and a queue manager must be specified on the integration node. For more information, see SCA nodes. |
The following table describes the Web Service properties of the SCAInput node. These properties are shown on the Binding tab when Binding type is set to WebService.
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 IBM Integration Bus 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 IBM Integration Bus SCA definition. | This property type is String. This property
is read-only. Error conditions:
|
Imported binding | Yes | No | Derived from the IBM Integration Bus 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 IBM Integration Bus 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:
|
Service port | Yes | No | Derived from the IBM Integration Bus 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 IBM Integration
Bus 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:
|
URL selector | Yes | Yes | Derived from the IBM Integration Bus 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 IBM Integration Bus 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 shown on the Binding tab when Binding type is set to MQ.
Property | M | C | Default | Description |
---|---|---|---|---|
Queue name | Yes | Yes | Derived from the IBM Integration Bus 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 IBM Integration Bus SCA definition that is chosen in the corresponding node. | The name or location of the message model in
which the incoming message is defined. When you click Browse, you see a list of available message model files. You cannot change this property if the Binding type is Web Services. |
Message | No | No | Picked automatically according to the IBM Integration Bus 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.
|
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.
|
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'. |
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 by using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |