Siebel Adapter 6.0 SP3 | webMethods Siebel Adapter Documentation | webMethods Siebel Adapter Installation and User’s Documentation | Siebel Adapter Connections | Configuring Adapter Connections
 
Configuring Adapter Connections
When you configure a Siebel Adapter connection, you specify information that the adapter uses to connect to and log into a Siebel system. You configure connections using Integration Server Administrator.
As mentioned in the installation chapter, to use a Siebel Java Data Bean client connection, you must obtain the following .jar files from the Siebel Server installation CD and place them in the WmSiebelAdapter\code\jars directory:
*SiebelJI_Common.jar (Not required for Siebel Client version 7.7.1 and later)
*Siebel.jar (Required only for Siebel Client version 7.7.1 and later)
*SiebelJI_xxx.jar
where xxx is your locale. For example, SiebelJI_enu.jar for English.
*To configure a connection
1. In Integration Server Administrator, select Adapters > Siebel Adapter.
2. On the Connections screen, click Configure New Connection.
3. On the Connection Types screen, select one of the following adapter connection types:
Connection Type
Description
Siebel Java Connection
Uses Siebel's Java Data Bean Business Object Interface (BOI) API to communicate with the Siebel Server. This connection requires that your Windows or UNIX platform supports a JVM that the Data Bean supports.
When configuring a connection that will connect to a virtual server used for Siebel Server load balancing, select this connection type. For more information about this feature, see Using Connections with Siebel Server Load Balancing.
Siebel Windows Thin Connection
Uses Siebel's COM Data Control to communicate with the Siebel Server's Object Manager.
The Configure Connection Type screen is displayed. For more information, see Connection Types.
4. In the Configure Connection Type section, provide values for the following parameters:
Parameter
Description/Action
Package
The package in which to create the connection.
You must create the package using Digital Event Services or Designer before you can specify it using this parameter. For general information about creating packages, see the webMethods Service Development Help for your release.
Note:
Create the connection in a user-defined package rather than in the adapter's package. See Siebel Adapter Package Management for other important considerations when creating packages for the Siebel Adapter.
Folder Name
The folder in which to create the connection.
Connection Name
The name you want to give the connection (32 characters maximum). Connection names cannot have spaces or use special characters reserved by Integration Server, Digital Event Services or Designer. For more information about the use of special characters in package, folder, and element names, see the webMethods Service Development Help for your release.
5. In the Connection Properties section, provide values for the following parameters:
Parameter
Description/Action
Transport
Optional. The protocol to communicate with the Siebel Server. Type tcpip (the default) or http.
Encryption
Optional. The ability to encrypt data. Select none (the default) or mscrypto.
Compression
Optional. The data in compressed format. Select none (the default), zlib, or pkware.
Gateway Server
The name of the Siebel Gateway Server through which you want to open a session to the Siebel Server. Enter the server name or the server's IP address.
Note:If this connection will connect to a virtual server used for Siebel Server load balancing, enter the name of the Siebel virtual server for this field. For more information about this feature, see Using Connections with Siebel Server Load Balancing.
Siebel Enterprise
The name of the Siebel Enterprise to which you want to connect.
Object Manager
The name of the Siebel Object Manager through which you want to access the Siebel application's business objects.
Siebel Server
The name of the Siebel Server through which you want to access the Siebel application's business objects.
You do not need to provide the name of the Siebel Server for Siebel Server version 7.7.1 and later.
Note:If this connection will connect to a virtual server used for Siebel Server load balancing, leave this field blank. For more information about this feature, see Using Connections with Siebel Server Load Balancing.
Repository Context
The Siebel repository in which the Siebel application stores the business component and business object definitions.
Note:
Specify the same repository that your Siebel Server uses.
Language
A valid Siebel language code specifying which language the Siebel connection uses. For example, ENU specifies English. For a list of all available codes, see your Siebel documentation.
User Name
The login name to use to log in to the Siebel Server. If no login is required, leave this field blank.
Password
The password to use to log in to the Siebel Server. If no login is required, leave this field blank.
6. In the Connection Management Properties section, provide values for the following parameters:
Parameter
Description/Action
Enable Connection Pooling
Enables the adapter to use connection pooling. Default: true.
For more information about connection pooling, see Connection Pooling and Run-Time Behavior of Connection Pools in Production Environments.
Note:
If you plan to enable connection pooling in a clustered environment, consider the connection pool size. For details, see Clustering Considerations and Requirements.
Minimum Pool Size
The minimum number of connection objects that remain in the connection pool at all times, even if the connections become idle. When the adapter creates the pool, it creates this number of connections. Default: 1.
Important:
As you configure and test your adapter, we recommend that you set the Minimum Pool Size field to 1 or greater. Doing this ensures that the adapter will verify your connection parameters when you enable (establish) the connection, using the Siebel Adapter. However, when you deploy the adapter in a production environment, set the Minimum Pool Size field to 0 to avoid possible connectivity failures. For details, see Run-Time Behavior of Connection Pools in Production Environments.
Maximum Pool Size
The maximum number of connection objects that can exist at one time in the connection pool. When the connection pool has reached its maximum number of connections, the adapter will reuse any inactive connections in the pool or, if all connections are active, it will wait for a connection to become available. Default: 10.
Pool Increment Size
The number of connections by which the pool will be incremented if connections are needed, up to the maximum pool size. Default: 1.
Block Timeout
The number of milliseconds that Integration Server will wait to obtain a connection with the Siebel application before it times out and returns an error. Default: 1000 milliseconds.
Expire Timeout
The number of milliseconds that an inactive connection can remain in the pool before it is closed and removed from the pool. For example, to specify 10 seconds, specify 10000. Enter 0 to specify no timeout. Default: 1000 milliseconds.
Note:
The Expire Timeout interval that you set for the adapter connection must be less than the interval that Siebel's connection pool manager sets for its own connections. For example, if Siebel's connection pool manager sets the interval at 20 seconds and you set the Expire Timeout interval at 30 seconds, then the Siebel connection pool manager will always timeout the connections before the adapter's connection pool does.
Note:
The adapter will never violate the Minimum Pool Size parameter. These connections remain in the pool regardless of how long they are inactive.
Startup Retry Count
The number of times that the system should attempt to initialize the connection pool at startup if the initial attempt fails.
Default: 0.
Startup Backoff Timeout
The number of seconds that the system should wait between attempts to initialize the connection pool.
7. Click Save Connection.
The connection you created appears on the adapter's Connections screen and in the Digital Event Services Service Browser or the Designer Package Navigator.
8. Enable the connection, as described in Enabling Adapter Connections.
When you enable the connection, Integration Server verifies your connection parameters and tries to establish a connection to the Siebel application, assuming you configured your connection with the Minimum Pool Size field set to 1 or greater. If you set the Minimum Pool Size field set to 0, Integration Server does not try to establish a connection until you use the connection to configure adapter services.