SiebelInput node
Use the SiebelInput node to interact with a Siebel application.
- Developer
- Application Integration Suite
- Standard
- Advanced
- Scale
- Adapter
This topic contains the following sections:
Purpose
Use the SiebelInput node to interact with Siebel applications. For example, a SiebelInput node monitors a Siebel system for a specified event. When that event occurs, the SiebelInput node generates a message tree that represents the business object with the new event details. The message tree is propagated to the Out terminal so that the rest of the message flow can use the data to update other systems, or audit the changes.
The SiebelInput node is contained in the WebSphere Adapters drawer of the message flow node palette, and is represented in the IBM® Integration Toolkit by the following icon:
Using this node in a message flow
To use the SiebelInput node, you must first create the Siebel event table. For instructions, see Creating the event store manually.
To function correctly, the SiebelInput node needs an adapter component, which you set using the Adapter component node property, and business object definitions, which are stored in the message set that you reference from the node. For this reason, you must provide a message set. By default, the message that is propagated from the SiebelInput node is in the DataObject domain, so the Message domain property is set to DataObject. You cannot specify a different domain. The message type is detected automatically by the node.
The SiebelInput node populates the route to label destination list with the name of the method binding. If you add a RouteToLabel node to the message flow after the SiebelInput node, the RouteToLabel node can use the name of the method binding to route the message to the correct part of the message flow for processing.
You can deploy only one input node that uses a particular adapter component to an integration server, but you can deploy many input nodes that use different adapter components to an integration server.
mqsisetdbparms integrationNodeName -n adapter name -u user name -p password
For
example:mqsisetdbparms BRK1 -n eis::SiebelCustomerInbound.inadapter -u siebeluid -p ********
Using configurable services for Siebel nodes
Siebel nodes can get Siebel connection details from either the adapter component or a configurable service. By using a configurable service, you can change the connection details for an adapter without the need to redeploy the adapter. For more details about creating, changing, reporting, and deleting the configurable services for Siebel, see Changing connection details for Siebel adapters.
You can also connect to different versions of Siebel by creating a custom EISProviders configurable service and setting the location of the appropriate library files. For more information, see Connecting to different versions of Siebel.
Terminals and properties
When you have put an instance of the SiebelInput 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. If you double-click a SiebelInput node, you open the Adapter Connection wizard. All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.
The SiebelInput node terminals are described in the following table.
Terminal | Description |
---|---|
Out | Business object events from the adapter are sent to the Out terminal. |
Failure | If an error happens in the SiebelInput node, the message is propagated to the Failure terminal. Information about the error, and business object events can also be propagated to the Failure terminal. |
Catch | Business object events are sent to the Catch terminal if they cause an uncaught exception in the message flow. If the Catch terminal is not connected, the retry process is activated to handle the business object. |
The following table describes 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).
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type, SiebelInput. | The name of the node. |
Short Description | No | No | A brief description of the node. | |
Long Description | No | No | Text that describes the purpose of the node in the message flow. |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Primary adapter component | Yes | Yes | The name of the adapter component that contains
configuration properties for the adapter. Either enter a
name of an adapter file or click Browse to
select an adapter file from the list of files that are available
in referenced message set projects. When theSiebelInput node receives
data from the Siebel system, it associates that data with
a method name, depending on the service operation name
that is assigned to that type of data when you run the Adapter
Connection wizard. The SiebelInput node attempts
to handle methods that are defined in the primary adapter.
If the type of data that is received does not correspond
to any of the methods that are defined in the primary adapter,
the node can handle methods that are defined in matching
secondary adapters that are deployed to the same integration
server.
Note: You can override the properties in the adapter
file at run time by creating a SiebelConnection configurable
service that has the same name as the adapter file. For
more information see Changing connection details for Siebel adapters
|
adapterComponent | |
Secondary adapter mode | No | Yes | None | Specifies whether the node can handle methods
that are defined in secondary adapters. If you set the Secondary adapter mode property to None, the node handles only methods that are defined in the primary adapter. If the type of data that is received does not correspond to any of the methods that are defined in the primary adapter, a failure occurs. If you set this property to All adapters in application, the node can handle methods that are defined in any Siebel inbound adapters that are deployed to the same application. If the node is deployed as an independent resource (that is, it is not contained within an application), the node can call methods that are defined in any Siebel inbound adapter that is also deployed as an independent resource. |
secondaryAdapterMode |
Property | M | C | Default | Description |
---|---|---|---|---|
Set destination list | No | No | Selected | This property specifies whether to add the method binding name to the route to label destination list. If you select this check box, the method binding name is added so that you can use a RouteToLabel node in the message flow after the SiebelInput node. |
Label prefix | No | No | The prefix to add to the method name when routing to label. Add a label prefix to avoid a clash of corresponding label nodes when you include multiple WebSphere® Adapters input nodes in the same message flow. By default, there is no label prefix, so the method name and label name are identical. |
Property | M | C | Default | Description |
---|---|---|---|---|
Message domain | No | No | DataObject | The domain that is used to parse the incoming message. By default, the message that is propagated from the SiebelInput node is in the DataObject domain. You cannot specify a different domain. |
Message model | Yes | No | Set automatically | The name or location of the message model schema
file in which the incoming message is defined. This field
is set automatically from the Adapter
component property. If you set this property, then subsequently update the project dependencies to remove this message model reference, a warning is issued. Either update the Message model property, or restore the reference to this message model. |
Message | No | No | The name of the incoming message. The node detects the message type automatically. You cannot set this property. | |
Physical format | No | No | The name of the physical format of the incoming message. You cannot set this property. |
Property | M | C | Default | Description |
---|---|---|---|---|
Transaction mode | No | No | Yes | The transaction mode on this input node determines whether the rest of the nodes in the flow operate under sync point. |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Additional instances pool | No | Yes | Use Pool Associated with Message Flow | The pool from which additional instances are
obtained.
|
componentLevel |
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. | additionalInstances |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Retry mechanism | No | No | Failure | This property specifies how retry processing
is handled when a failure is rolled back to the SiebelInput node.
|
|
Retry threshold | No | Yes | 0 | The maximum number of times that retry processing is performed for short retry. | retryThreshold |
Short retry interval | No | Yes | 0 | The interval between short retry attempts. | shortRetryThreshold |
Long retry interval | No | Yes | 0 | The interval between long retry attempts. | longRetryThreshold |
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. |