This Getting Started guide describes Siebel Extension.
Getting Started Guide
- 1.0 Installation notes
- 2.0 Configuration requirements
- 3.0 Session pooling and properties
The Siebel Extension provides IBM® WebSphere® Portlet Factory users with the following important features:
Using IBM WebSphere Portal Server credentialsAutomation of Portlet Code
The Siebel builder includes methods to query, edit and save data in chosen Siebel Business Components, a schema to describe the data returned by the methods, and variables (typed with the schema) to hold the field selections and data values. In addition, the Siebel View and Form builder automatically creates the pages required to query a Siebel Business Component and display the records returned.Seamless Integration with Other Builders
To create robust, highly customized portlets, including custom look-and-feel.
1.0 Installation notes
The components in the Siebel Extension support the following Siebel product versions:
Table 1. Siebel product versions
|Siebel Product||Versions Supported|
|Siebel CRM Solutions||See the detailed system requirements in WebSphere Portlet Factory release note topic for the versions supported.|
The Siebel Extension leverages the Siebel Java Data Bean interface to access the Siebel repository. As a result, you must acquire the following, version-specific, Siebel JAR files from your Siebel systems administrator:
- For Siebel 7.5.2 and 7.5.3: SiebelJI.jar, SiebelJI_Common.jar, SiebelJI_enu.jar
- For Siebel 7.8 and 8.0: Siebel.jar, SiebelJI_enu.jar
Install this Siebel Extension as you would any other feature set.
Add Siebel JAR files to your IDE.
- In the project right-click menu, select Properties. Expand the WebSphere Portlet Factory category and select feature info.
- In the Feature Info screen, select the Siebel Extension and click Apply. Click OK to add the feature set. Choose to re-deploy when prompted.
- Locate your WebSphere Portlet Factory Designer core plugin folder, for example:
C:\\Program Files\\IBM\\WebSphere Portlet Factory\\WPFDesigner\\eclipse\\plugins\\com.bowstreet.designer.core_latest version
- Copy the Siebel JAR files required by your Siebel version into the \\lib folder in this plug-in folder.
- Verify that the JARs you just copied into the \\lib folder are listed in the plugin.xml file; this file is found in the same folder that contains the \\lib folder. The default definitions in this file should be sufficient. However, if the Siebel JAR files you obtained for your server are named differently, then you'll need to adjust the definitions so that these JARs can be loaded by WebSphere Portlet Factory Designer.
Below select the server you will be using and follow the steps to add the Siebel jars.
Add the Siebel jars to the IBM WebSphere Application Server Community Edition (CE) server.
Update the geromino-web.xml file for your project in Portlet Factory
- Open WebSphere Application Server Community Edition server console
- Select the Common Libs link under Services
- Using the Browse option select and add your Siebel jar files.
- Enter Group, Artifact, Version, and Type using your naming conventions.
All other Application Servers
- Open WebContent\\WEB-INF\\bin\\deployment\\geromino-web.xml
- Under <dependencies> you will see the following:
- Uncomment this lines and update the groupID, artifactId and version to the ones you assigned for your JARs on the WebSphere Application Server CE server.
- Rebuild your project.
Copy the Siebel JAR files into a directory from which your application server loads JAR files that are common across all deployed WARs. For example: /WebSphere/AppServer/lib/ext
Depending on your settings, your application server and WebSphere Portlet Factory Designer may need to be restarted to correctly register all feature set files.
Matching file encoding
To communicate successfully, a Siebel server and an external Siebel client (such as WebSphere Portlet Factory), must use a compatible file encoding. For example, the default Windows file encoding is Cp1252. On RedHat Linux, the default file encoding is UTF-8.
To use Siebel builders successfully, ensure that your client platform matches the file encoding used by your Siebel server. For example, when WebSphere Portlet Factory Designer runs on the Linux® system, the default file encoding for the JVM can be different than the default file encoding used by the Siebel server. Siebel requires that a client that uses the Java API to connect to a Siebel server have the same default file encoding as the Siebel server. If the default file encoding settings differ, the Siebel coordinator fails during regeneration with the message Could not open a session in 4 attempts
. This causes model errors and the model does not run.
To regenerate the Siebel builders correctly on a Linux system, set the Eclipse JVM default file encoding to be the same as that used by the Siebel server. Navigate to the Eclipse install root directory and open the eclipse.ini
file. It contains the JVM startup parameters to be used by Eclipse. Add to the file a line that defines the coding that the connecting client must use. For example, if the Siebel server uses utf8
default file encoding, add the following line.
When you restart Eclipse and WebSphere Portlet Factory Designer, the client default encoding is set to the same value as the server and the Siebel builders regenerate correctly.
Using testSiebelConnection.jsp to test your Siebel connection
If you want to use WebContent\\factory\\util\\testSiebelConnection.jsp
to quickly ensure that your connection properties are correct, you will need to:
- Create a project and deploy it to your test server
- In your browser opening the following URL.
- Follow instructions on test page
2.0 Configuration requirements
The first step in using the Siebel builder is establishing a properties file. This file is located in a project's WEB-INF/config/siebel_config/
directory. The properties file (default_connection.properties
) is used to specify connection properties such as the connection string to the Siebel server, and a valid Siebel user name and password.
Because the WebContent/WEB-INF/config
directory is by default an excluded resource, you need to override the team file and directory exclusion to ensure that your new or modified file is kept updated in source control storage.
A typical properties file might contain the following properties:
#Default connection properties for the Siebel Builder
A Siebel default_connection.properties
file is installed with the Siebel Builder. This properties file is located in the WEB-INF/config/siebel_config/
directory. You can use the file to establish your basic Siebel settings and view examples of valid property values. As configured at install time, this file is applicable to a Siebel server running on the local host.
If Siebel business component fields are not being discovered and displayed by the Siebel builders in WebSphere Portlet Factory Designer, then the Siebel server you are accessing may use a repository with a non-default name. If you experience this behavior, then add the following line to your Siebel connection properties file (web-inf/config/siebel_config/default_connection.properties
Replace Siebel Repository
with the name of your active repository.
3.0 Session pooling and properties
The Siebel builder support pooling of sessions to your backend Siebel servers. By default session pooling is disabled (a reasonable configuration for a WebSphere Portlet Factory Designer environment). However, on the server you may want to enable pooling to minimize the number of sessions created and improve overall builder runtime performance.
You can add the properties in the table below to a Siebel project .../WEB-INF/config/override.properties
file to enable and configure Siebel session pooling.
Siebel builders use the standard open source Apache Commons pooling implementation. See the Commons documentation for the GenericKeyedObjectPool class on the Apache web site for detailed information on the meanings of these properties.
Table 2. Properties to enable and configure Siebel session pooling
|bowstreet.siebel.session.pool.enabled||false||If defined and set to TRUE, session pooling is enabled.|
|bowstreet.siebel.session.pool.maxActiveSessions||8||Maximum number of active sessions at one time. |
When negative, there is no limit to the number of active sessions.
|bowstreet.siebel.session.pool.maxIdleSessions||8||Maximum number of idle session in the pool at one time.|
When value is negative, there is no limit to the number of idle sessions.
|bowstreet.siebel.session.pool.maxWait||-1||Maximum time in milliseconds to wait for a session to be returned to the pool.|
When value is negative, the requesting thread will wait indefinitely for a session to be returned. If no session is returned to the pool in the specified time, then the requesting thread receives an exception.
|bowstreet.siebel.session.pool.maxIdleTimeSeconds||1800||Maximum time in seconds that a session is allowed to remain idle in the pool before being evicted and reclaimed.|
When negative, no sessions will be evicted based upon idle time.
|bowstreet.siebel.session.pool.idleSessionSweepSeconds||30||Maximum time in seconds between sweeps of the pool looking for idle sessions to evict and reclaim. |
When negative, pool sweeping is disabled.
|bowstreet.siebel.session.pool.maxAgeMinutes||-1||Maximum age in minutes of a session before it is evicted and reclaimed, no matter what the idle session settings may be.|
When value is negative, sessions are never evicted and reclaimed due to their age.
Note: This is a feature / property specific to WebSphere Portlet Factory that is not implemented in the Commons library.
Parent topic: Getting started with integration extensions: wpf7
Files that are excluded from source control: wpf7
Release notes IBM WebSphere Portlet Factory Version 7.0: wpf7