Page navigation
- Overview
- Updates:
- Contents
- Using Application Portlet Builder
- Setting up Application Portlet Builder
- Configure for PeopleSoft
- Configure for Siebel
- WebSphere Portal 5.0.x:
- Configure for SAP
- Configure for SAP Business Object Editor
- Configure the JDBC adapter
- Configure for Domino
- Configure for WebSphere Portal content publishing
- WebSphere Portal 4.x:
- WebSphere Portal 5.0.x:
The IBM Application Portlet Builder enables users to create portlets that can access and manipulate data in an enterprise application, without requiring programming knowledge of the system.
Overview
By selecting business objects available from the enterprise application, users can specify which data fields should be displayed in your portlet. When the portlet is created, the portlet can be made available to portal end users.
JCA adapters allow connections to multiple versions of PeopleSoft and Siebel servers on the same WebSphere Application Server machine. This adapter also allows markup-based configuration so that users can select and modify fields for each supported markup. In addition, portlets that are WML-enabled allow you to search and retrieve information through your WAP-enabled device.
Note:
- If you create Click-to-Action wirings between two portlets, these wirings will not be persisted. After you log out of WebSphere Portal, the wirings will be lost. You will have to recreate wirings with the wiring tool if you still want to use them.
- IBM WebSphere Application Integrator no longer supports Cick-to-Action on IBM WebSphere Portal Version 4.1.x.
- Support for PeopleSoft 7.5 portlet builder has been removed.
- Due to the display limitations on a WAP enabled device, you can only display one field per record on the summary screen.
- The catalog version of the IBM Application Portlet Builder is not supported on WebSphere Portal 5.1.x. All of the Portlet Builders are included in WebSphere Portal 5.1.0.1. Please refer to the Information Center for installation and configuration instructions.
Updates:
- 21 June 2005: Added (in the Note section above) that the catalog version of the IBM Application Portlet Builder is not supported on WebSphere Portal 5.1.x. All of the Portlet Builders are included in WebSphere Portal 5.1.0.1. Refer to the WebSphere Portal 5.1.0.1 Information Center for more information.
-
31 March 2004: Added feature enhancements to the IBM Application Portlet Builder and the run-time portlet (for WebSphere Portal v5.0.x only). For more details, refer to
WPAI Enhancements.pdf, which is included in the download file,1wp10003t.zip. - 3 March 2004: Added Click-to-Action install instructions for WebSphere Everyplace Access 4.3.x .
- 4 February 2004: Added information for Unix platforms to the Configure for SAP section.
- 14 January 2004: Added a section under Deployment/Installation on removing the previous version of Portlet Builders (for WebSphere Portal 5.0.x only).
- 16 December 2003: Changed Domino Server requirements.
-
3 December 2003: Added Additional references section; Clarified databases supported by JDBC Builder; Changed name of the download zip file to
1wp10003t.zip. - 18 November 2003: Added support for the SAP Business Object Editor; Added component interface list retrieval for PeopleTools 8.42.
- 21 October 2003: Added WebSphere Portal v5 support for WPAI Profile Service.
- 7 October 2003: Added WebSphere Portal v5 support for PeopleSoft 8, Siebel, SAP, and WebSphere Portal content publishing portlet builders. Domino now has attachment support. Enhanced the PeopleSoft 8 JCA adapter.
-
19 August 2003: Added WPAI Profile Service installation steps and reference documentation in the download zip file,
1wp10003t.zip. When you unzip1wp10003t.zipyou will can find user guides in the doc subdirectory. - 08 July 2003: Added Domino installation steps.
- 03 June 2003: See the Portlet Installation for new installation instructions.
- 20 May 2003: Added support for Domino builder and for WebSphere Portal Content Publishing builder; Added support for Struts templates.
- 17 April 2003: New WPAIPortletBuilders.war file added.
-
25 March 2003: A new JDBC adapter allows general connections
with databases that support a JDBC interface. Using this interface, normal Create, Retrieve, Update, and Delete (CRUD) operations
are permitted. The JDBC adapter plugs into the WebSphere Portal Application Interface
framework to allow portlets to be generated quickly and easily to work with database
information.
Note: The update and delete operations are supported only for tables with primary keys.
Contents
- Using Application Portlet Builder
-
Setting up Application Portlet Builder
- Client requirements
- Server requirements
-
Deployment/Installation
- Remove previous version of Portlet Builders (for WebSphere Portal 5.0.x only)
- Install Struts (for WebSphere Portal 4.1.x only)
- Install Click-to-Action (for WebSphere Everyplace Access 4.3.x only)
- Verify JCA support (for WebSphere Portal 4.x)
- Configure for PeopleSoft
- Configure for Siebel
- Configure for SAP
- Configure for SAP Business Object Editor
- Configure the JDBC adapter
- Configure for Domino
- Configure for WebSphere Portal content publishing
- Portlet Installation
- WPAI Profile Service
- Additional references
Using Application Portlet Builder
Users can view and modify the information from their enterprise application in the view mode of portlets created with Application Portlet Builder. Users may have to supply the user ID and password they use to access the enterprise application. Administrators can specify connection information and vault slot preference in configure mode.
Setting up Application Portlet Builder
Client requirements
This portlet supports browsers and devices capable of rendering HTML and WML markup. The following table provides detailed information.
| Minimum requirements for HTML | |
|---|---|
| Markup level | HTML 4.01 Transitional |
| Java applet |
None |
| JavaScript |
1.3 |
| <iframe> |
Domino only: Yes |
| Style sheets |
Portal styles only |
| Software | This portlet has been tested on the following browsers:
|
| Accessibility |
Yes |
| Minimum requirements for WML | |
|---|---|
| Markup level |
|
| Other | You must install WebSphere Portal Fix Pack 4.2.1 for WebSphere Portal 4.2, or install the Click-To-Action Version 4.1.1 portlet for WebSphere Portal 4.1.x. |
| Software | Nokia 3.0 Simulator |
Single sign-on is supported through the Portal Server Credential Vault. A user's credentials are stored in a slot assigned to each portlet. Initially, a separate slot is created for each portlet. However, a portlet's configuration mode can be used to set the name of a specific slot. If the same slot is used for all portlets that connect to the same application, a user's credentials need only be entered once.
See the WebSphere Portal documentation for information on using the Credential Vault.
Server requirements
Application Portlet Builder requires WebSphere Portal 4.1.2 or later. In addition, Application Portlet Builder requires one of the following enterprise applications:
- PeopleSoft 8
- Siebel 7 or later
- SAP R/3
- JDBC connection to Oracle or DB2 through WebSphere data source
- WebSphere Portal content publishing v4.2
- Domino Servers v5.0.5 and higher
Deployment/Installation
Application Portlet Builder requires several configuration steps that must occur before the portlet can be deployed in the Portal environment. Configuration steps specific to a particular enterprise application are noted.
Remove previous version of Portlet Builders (for WebSphere Portal 5.0.x only)
Application Portlet Builder (Domino and JDBC) is installed with WebSphere Portal v5 by default. This Application Portlet Builder must first be removed before installing the version from the WebSphere Portal and Lotus Workplace Catalog.
- Login as a portal administrator and go to Administration > Portlets > Manage Applications.
- Remove the following applications:
-
BusinessObjectFrameworkStruts.war -
BOBuilderPortlet.war
-
Install Struts (for WebSphere Portal 4.1.x only)
Before you install WPAI, you must install IBM Struts Portlet Framework Version 4.1.5, available from the WebSphere Portal and Lotus Workplace Catalog as NavCode 1WP10003N . Follow the instructions included with Struts for installation.
Install Click-to-Action (for WebSphere Everyplace Access 4.3.x only)
If you are using WebSphere Everyplace Access 4.3 or later, you must install WebSphere Portal Click-to-Action. Click-to-Action was shipped with the WPAI portlet package. If Click-to-Action is not currently installed on your WebSphere Everyplace Access server, follow these steps to install it:
- Stop the Portal Application Server.
- Save the c2asetup.jar file in a local directory. You can find the c2asetup.jar file in the WPAI zip file.
- Open a command prompt in the directory where you saved the c2asetup.jar file.
- Run the jar to launch the Installer. To properly execute this command, you must specify the WebSphere Application Server java bin as shown
below:
Example command line: C:\<was>\java\bin\java -jar c2asetup.jar, where <was> is the directory where WebSphere Application Server is installed on your machine.
- Follow the prompts in the Installer.
Note: You will need to know the install directories of WebSphere Portal and WebSphere Application Server, the hostname of your machine, the WebSphere Application Server Node node name, and the WebSphere Portal administrator's user name and password. The wizard will display screens indicating that it is stopping the application server at the beginning and starting the application server at the end. It will not do so. Just click Next when you see these screens.
- Start the Portal Server.
Verify JCA support (for WebSphere Portal 4.x)
To verify that J2EE Connector Architecture (JCA) support is installed:
- Verify that the following files are in the was_root\lib
directory, where was_root is the directory where WebSphere
Application Server is installed (for example, C:\WebSphere\AppServer):
- jca.jar
- j2c.jar
- If these files are not present in the was_root\lib directory, JCA support is not installed. Before continuing, uninstall Fix Pack 2 for WebSphere Application Server and then reinstall Fix Pack 2 with JCA support. Also be sure that you have met all other WebSphere Application Server requirements for WebSphere Portal 4.1.2 (refer to the WebSphere Portal documentation for more information on requirements).
Configure for PeopleSoft
WebSphere Portal 4.x:
If you have a previous version of Application Builder installed, you must first remove the existing JCA adapters before continuing. Use the following steps to remove the PeopleSoft 8 JCA adapter:
- Open the WebSphere Application Server Administrative Console.
- Remove any existing connection factories under the PeopleSoft adapters.
- Remove the PeopleSoft adapters.
- Close the Administrative Console.
- Remove the following files from was_root\lib\ if you installed the adapters prior to April 2003:
-
psft_impl.jar -
psft_client.jar -
psjoa.jar
-
- Remove the file was_root\lib\psft8adapter.jar if you installed the adapters in April 2003 or later.
- Remove the directory and directory's contents from was_root
\installedConnectors\psft.rar. - Restart WebSphere Application Server.
After removing any existing PeopleSoft 8 connection factories and adapters, install the updated adapter using the following steps:
- Extract the contents of the download file to a directory of your choice, referred to as peoplesoft_home.
- Create a new empty directory in your hard drive, referred to as peoplesoft_lib_dir.
- Copy the following file from the PeopleSoft 8 server to peoplesoft_lib_dir:
psjoa.jar, pstools.properties
- Deploy the PeopleSoft 8 JCA adapter in WebSphere Application
Server
- Ensure that the WebSphere Application Server Administration Server service is running.
- Start the WebSphere Application Server Administrator's Console.
- Double-click WebSphere Administrative Domain in the tree view.
- Double-click Resources in the tree view.
- Right-click on J2C Resource Adapters, and select New.
- On the General tab of the J2C Resource Adapters Properties window,
enter the following:
- A name for the resource adapter, such as PeopleSoft 8.
- A description, such as PeopleSoft 8 JCA Connector.
- In the Archive file name field, click the button labeled "..." to display the Install Driver window.
- Select the node where you want to deploy the resource adapter and
specify the path and file name of the RAR file, peoplesoft_home\psft.rar, by doing
one of the following steps:
- Enter the path and file name directly in the Rar file field.
- Click Browse to locate the file.
- Click Install. The J2C Resource Adapters Properties window is updated to display the name of the RAR file you specified.
- Click OK to install the resource adapter. A confirmation message is displayed when the resource adapter is installed.
- Click OK to dismiss the message. The Administrator's Console is updated to display information about the resource adapter.
- Define a connection factory for the PeopleSoft JCA adapter.
- Double-click on J2C Resource Adapters in the tree view.
- Double-click on the resource adapter you just deployed. For example, PeopleSoft 8.
- Right-click on J2C Connection Factories, and select New.
- On the General tab of the J2C Connection Factories Properties window,
enter the following:
- A name for the connection factory, such as PeopleSoft 8 Connection Factory.
- The JNDI binding path. The convention for this value is eis/psft. However, you can specify any JNDI binding path as long as it does not conflict with another JNDI path name. Note that this value must also be specified as the JNDI binding path configuration parameter in configuration mode for each PeopleSoft portlet.
- Click the Connections tab.
- Specify the properties for the PeopleSoft system you want to connect
to by selecting the property from the list and entering a value in the
entry field:
- hostName
- The host name of the PeopleSoft server to which you want to connect. For example, myserver.mycompany.com. The port number is for the JOLT Listener port. You can obtain the JOLT Listener port number from the PeopleSoft application server configuration file, psappsrv.cfg. An example location for that file is C:\PSFT_HRMS8.3\appserv\HR8DMO\psappsrv.cfg. An example hostName setting is //myserver.mycompany.com:9210. If you do not specify the port number, the default port number of 9000 is used.
- jarPath
- Enter the value peoplesoft_lib_dir, the directory where you placed the PeopleSoft libraries.
- Click OK.
- Copy server-specific files.
- Extract psft8adapter.jar from peoplesoft_home\psft.rar.
- Copy this file to the was_root\lib directory, where was_root is the directory where WebSphere Application Server is installed. For example, C:\WebSphere\AppServer.
- Restart WebSphere Application Server.
- The final step is importing the component interface list retrieval definition into PeopleSoft. There are two versions of the
component interface: one for PeopleTools 8.18 and another for PeopleTools 8.42. If you are running PeopleTools 8.42 skip to step 8.
Note: The component interface in the project,WPS_PS_CILIST, has been created and tested on PeopleTools 8.18, and is in general limited to that version of PeopleTools. If you attempt to import a component interface definition into another version of PeopleTools, you may crash the PeopleSoft Application Designer.- Extract the contents of peoplesoft_home\wps_ps_cilist.zip to a directory of your choice (referred to as ci_home).
- Start the PeopleSoft Application Designer. To ensure that you can perform the steps below, log in to the Application Designer in two-tier mode.
- Select File > New to create a new project.
- Select File > Copy Project from File and specify the CI_home directory in the Import Directory field. You can enter the path directly or click "..." to browse to it.
- Verify that WPS_PS_CILIST is selected in the Project Name field.
- Click Copy.
- Select File > Save Project As, and enter a project name of your choice.
- Click OK.
- Exit the PeopleSoft Application Designer.
- Log into the PeopleSoft Web application.
- Select PeopleTools > Maintain Security > Use > Permission Lists .
- Add the imported component interface,
WPS_CI_LISTto a permission list. You can use an existing permission list or create a new one. Select the Component Interface tab on the permission list to display the panel for adding the component interface. - Edit the component interface to allow full access to all methods in it.
- Click Save to save your permission list changes.
Note: Ensure that the intended user of the portlets participates in at least one role that contains this permission list.
- Skip step 8.
Note: The component interface in the project,
WPS_PT842_CILIST, has been created and tested on PeopleTools 8.42 and is in general limited to that version of PeopleTools. If you attempt to import a component interface definition into another version of PeopleTools, you may crash the PeopleSoft Application Designer.- Extract the contents of peoplesoft_home
\wps_pt842_cilist.zipto a directory of your choice (referred to as ci_home). - Start the PeopleSoft Application Designer. To ensure that you can perform the steps below, log in to the Application Designer in two-tier mode.
- Select File > New to create a new project definition.
- Select Tools > Copy Project > From File and specify ci_home
\WPS_PT842_CILIST\WPS_PST842_CILIST.inidirectory in the filename field. You can enter the filename directly or browse to it. - Verify that
WPS_PT842_CILISTis selected in the Projects field. - Click Open.
- Click Copy on the Copy from File dialog box.
- Select File > Save Project As and enter a project name of your choice.
- Click OK.
- Exit the PeopleSoft Application Designer.
- Log in to the PeopleSoft Web application.
- Select PeopleTools > Security > Permissions and Roles > Permission Lists.
- Add the imported component interface,
WPS_CI_LIST, to a permission list. You can use an existing permission list or create a new one. Select the Component Interface tab on the permission list to display the panel for adding the component interface. - Edit the component interface to allow full access to all methods in it.
- Click Save to save your permission list changes.
Note: Ensure that the intended user of the portlets participates in at least one role that contains this permission list.
WebSphere Portal 5.0.x:
Install the JCA adapter using the following steps:
- Extract the contents of the download file to a directory of your choice, referred to as peoplesoft_home.
- Create a new empty directory in your hard drive, referred to as peoplesoft_lib_dir.
- Copy the following files from the PeopleSoft 8 server to peoplesoft_lib_dir:
- psjoa.jar, pstools.properties
- Deploy the PeopleSoft 8 JCA adapter in WebSphere Application
Server
- Ensure that the WebSphere Application Server Administration Server service is running.
- Start the WebSphere Application Server Administrator's Console.
- Click Resources in the navigation tree.
- Click on Resource Adapters
- In the console workspace area, click on the Install RAR button.
- Specify the path and the file name of the RAR file by doing one of the following:
- Entering the path and file name directly to psft.rar
- Clicking Browse to locate the local file.
- Select the node where you want to deploy the resource adapter and click Next.
- Enter a name for the resource adapter such as
PeopleSoft 8and click OK. - Save the configuration changes.
- Define a connection factory for the PeopleSoft JCA adapter.
- Click on Resource Adapters in the navigation tree.
- Click on the resource adapter you just deployed in Step 4. For example, PeopleSoft 8.
- Under Additional Properties, click on J2C Connection Factories, and click New.
- Enter the following:
- A name for the connection factory, such as PeopleSoft 8 Connection Factory.
- The JNDI binding path. The convention for this value is eis/psft. However, you can specify any JNDI binding path as long as it does not conflict with another JNDI path name. Note that this value must also be specified as the JNDI binding path configuration parameter in configuration mode for each PeopleSoft portlet.
- Click OK then click on the connection factory you just created.
- Under Additional Properties, click on Custom Properties.
- Specify the properties for the PeopleSoft system you want to connect
to by selecting the property from the list and entering a value in the
entry field:
- hostName
- The host name of the PeopleSoft server to which you want to connect. For example, myserver.mycompany.com. The port number is for the JOLT Listener port. You can obtain the JOLT Listener port number from the PeopleSoft application server configuration file, psappsrv.cfg . An example location for that file is C:\PSFT_HRMS8.3\appserv\HR8DMO\psappsrv.cfg. An example hostName setting is //myserver.mycompany.com:9210. If you do not specify the port number, the default port number of 9000 is used.
- jarPath
- Enter the value peoplesoft_lib_dir, the directory where you placed the PeopleSoft libraries.
- Click OK.
- Copy server-specific files.
- Extract psft8adapter.jar from peoplesoft_home\psft.rar.
- Copy this file to the was_root\lib directory, where was_root is the directory where WebSphere Application Server is installed. For example, C:\WebSphere\AppServer.
- Restart WebSphere Application Server.
- The final step is importing the component interface list retrieval definition into PeopleSoft. There are two versions of the component interface: one for PeopleTools 8.18 and another for PeopleTools 8.42. If you are running PeopleTools 8.42 skip to step 8.
Note: The component interface in the project,WPS_PS_CILIST, has been created and tested on PeopleTools 8.18, and is in general limited to that version of PeopleTools. If you attempt to import a component interface definition into another version of PeopleTools, you may crash the PeopleSoft Application Designer.- Extract the contents of peoplesoft_home\wps_ps_cilist.zip to a directory of your choice (referred to as ci_home).
- Start the PeopleSoft Application Designer. To ensure that you can perform the steps below, log in to the Application Designer in two-tier mode.
- Select File > New to create a new project.
- Select File > Copy Project from File and specify the CI_home directory in the Import Directory field. You can enter the path directly or click "..." to browse to it.
- Verify that WPS_PS_CILIST is selected in the Project Name field.
- Click Copy.
- Select File > Save Project As, and enter a project name of your choice.
- Click OK.
- Exit the PeopleSoft Application Designer.
- Log into the PeopleSoft Web application.
- Select PeopleTools > Maintain Security > Use > Permission Lists .
- Add the imported component interface,
WPS_CI_LIST, to a permission list. You can use an existing permission list or create a new one. Select the Component Interface tab on the permission list to display the panel for adding the component interface. - Edit the component interface to allow full access to all methods in it.
- Click Save to save your permission list changes.
Note: Ensure that the intended user of the portlets participates in at least one role that contains this permission list.
- Skip step 8.
Note: The component interface in the project,
WPS_PT842_CILIST, has been created and tested on PeopleTools 8.42 and is in general limited to that version of PeopleTools. If you attempt to import a component interface definition into another version of PeopleTools, you may crash the PeopleSoft Application Designer.- Extract the contents of peoplesoft_home
\wps_pt842_cilist.zipto a directory of your choice (referred to as ci_home). - Start the PeopleSoft Application Designer. To ensure that you can perform the steps below, log in to the Application Designer in two-tier mode.
- Select File > New to create a new project definition.
- Select Tools > Copy Project > From File and specify ci_home
\WPS_PT842_CILIST\WPS_PST842_CILIST.inidirectory in the filename field. You can enter the filename directly or browse to it. - Verify that
WPS_PT842_CILISTis selected in the Projects field. - Click Open.
- Click Copy on the Copy from File dialog box.
- Select File > Save Project As and enter a project name of your choice.
- Click OK.
- Exit the PeopleSoft Application Designer.
- Log in to the PeopleSoft Web application.
- Select PeopleTools > Security > Permissions and Roles > Permission Lists.
- Add the imported component interface,
WPS_CI_LIST, to a permission list. You can use an existing permission list or create a new one. Select the Component Interface tab on the permission list to display the panel for adding the component interface. - Edit the component interface to allow full access to all methods in it.
- Click Save to save your permission list changes.
Note: Ensure that the intended user of the portlets participates in at least one role that contains this permission list.
Configure for Siebel
WebSphere Portal 4.x:
If you have a previous version of Application Builder installed, you must first ensure that you have the current JCA adapter. To determine if the JCA adapter is out-of-date, open ra.xml in <was_root>\installedConnectors\siebel.rar\META-INF\. The current version number is 1.1. There should be four configuration properties: connectString, jarPath, traceLevel, and language. If any of these properties are missing, you must remove the JCA adapter and install the new version.
Use the following steps to remove the Siebel JCA adapter:
- Open the WebSphere Application Server Administrative Console.
- Remove any existing connection factories under the Siebel adapters.
- Remove the Siebel adapter.
- Close the Administrative Console.
- Stop the Application Server.
- Remove the following files from
was_root\lib\app:- SiebelJI_enu.jar
- SiebelJI_common.jar
- Remove the siebeladapter.jar from
was_root\lib\app\. - Start the Application Server.
Install the JCA adapter siebel.rar using the following steps:
- Extract the contents of the download file (1wp10003t.zip) to a directory of your choice, referred to as siebel_home.
- Create a new empty directory in your hard drive, referred to as siebel_lib_dir.
- Copy the following files from the Siebel server to siebel_lib_dir:
- SiebelJI_enu.jar
- SiebelJI_common.jar
- Deploy the Siebel JCA adapter in WebSphere Application Server
- Ensure that the WebSphere Application Server Administration Server service is running.
- Start the WebSphere Application Server Administrator's Console.
- Double-click WebSphere Administrative Domain in the tree view.
- Double-click Resources in the tree view.
- Right-click on J2C Resource Adapters, and select New.
- On the General tab of the J2C Resource Adapters Properties window,
enter the following:
- A name for the resource adapter, such as Siebel.
- A description, such as Siebel JCA Connector.
- In the Archive file name field, click the button labeled "..." to display the Install Driver window.
- Select the node where you want to deploy the resource adapter and
specify the path and file name of the RAR file by doing one of the following:
- Entering the path and file name directly in the Rar file field.
- Clicking Browse to locate the file.
- Click Install. The J2C Resource Adapters Properties window is updated to display the name of the RAR file you specified.
- Click OK to install the resource adapter. A confirmation message is displayed when the resource adapter is installed.
- Click OK to dismiss the message. The Administrator's Console is updated to display information about the resource adapter.
- For each Siebel application, define a connection factory for the Siebel
JCA adapter.
- Double-click on J2C Resource Adapters in the tree view.
- Double-click on the resource adapter you just deployed. For example, Siebel.
- Right-click on J2C Connection Factories, and select New.
- On the General tab of the J2C Connection Factories Properties window,
enter the following:
- A name for the connection factory that references the Siebel application,
such as Siebel Call Center. The applications to
create a connection factory for may include:
- Siebel Call Center
- Siebel eChannel Partner Portal
- Siebel ERM
- Siebel Marketing
- Siebel Sales
- The JNDI binding path. The convention for this value is based
on the application for which you are creating the connection factory,
such as eis/siebel/SCCObjMgr for the Siebel Call
Center connection factory. However, you can specify any JNDI
binding path as long as it does not conflict with another JNDI path
name. Note that this value must also be specified as the JNDI binding path
configuration parameter in configuration mode for each Siebel portlet.
Recommended JNDI binding path values include:
- Siebel Call Center: eis/siebel/SCCObjMgr
- Siebel eChannel Partner Portal: eis/siebel/eChannelObjMgr
- Siebel ERM: eis/siebel/ERMObjMgr
- Siebel Marketing: eis/siebel/eMarketObjMgr
- Siebel Sales: eis/siebel/SSEObjMgr
- A name for the connection factory that references the Siebel application,
such as Siebel Call Center. The applications to
create a connection factory for may include:
- Click the Connections tab.
- Specify the properties for the Siebel system you want to connect to
by selecting the property from the list and entering a value in the
entry field:
- connectString
-
The connection string used to contact the Siebel server.
The general format for this value is siebel://[machine name]/[enterprise name]/[object manager]/[servername]. The [object manager] value in the connection string should correspond to that specified in the JNDI binding path. For example, if you are defining a connection factory with a JNDI binding path of eis/siebel/ERMObjMgr, you would specify a connection string like siebel://machine1.mycompany.com/siebel/ERMObjMgr/server1. For details on the connection string format, refer to the Siebel documentation.
- jarPath
- Enter the value siebel_lib_dir, the directory where you placed the Siebel libraries.
- Click OK.
- Repeat the steps to create a connection factory for the remaining Siebel applications.
- Copy server-specific files.
- Extract the siebeladapter.jar file from the siebel_home\siebel.rar file, and copy it to the was_root\lib directory.
- Restart WebSphere Application Server.
WebSphere Portal 5.0.x:
If you have a previous version of Application Builder installed, you must first ensure that you have the current JCA adapter. To determine if the JCA adapter is out-of-date, open ra.xml in <was_root>\installedConnectors\siebel.rar\META-INF\. The current version number is 1.1. There should be four configuration properties: connectString, jarPath, traceLevel, and language. If any of these properties are missing, you must remove the JCA adapter and install the new version.
Use the following steps to remove the Siebel JCA adapter:
- Log in to the administrative console using a Web browser.
- Remove any existing connection factories under the Siebel adapters.
- Remove the Siebel adapter.
- Stop the Application Server.
- Remove the following files from
was_root\lib\app:- SiebelJI_enu.jar
- SiebelJI_common.jar
- Remove the siebeladapter.jar from
was_root\lib\app\. - Start the Application Server.
Install the JCA adapter siebel.rar using the following steps:
- Extract the contents of the download file (1wp10003t.zip) to a directory of your choice, referred to as siebel_home.
- Create a new empty directory in your hard drive, referred to as siebel_lib_dir.
- Copy the following files from the Siebel server to siebel_lib_dir:
- SiebelJI_enu.jar
- SiebelJI_common.jar
- Deploy the Siebel JCA adapter in WebSphere Application Server
- Verify that the application server for the administrative console is running.
- Point a Web browser to the URL for the administrative console and log in.
- Browse the administrative console using the navigation tree. Expand the Resources tab in the navigation tree and click on Resource Adapters.
- In the console workspace area, click on Install RAR.
- Specify the path and file name of the RAR file by doing one of the following:
- Entering the path and file name directly to
siebel.rar. - Clicking Browse to locate the local file.
- Entering the path and file name directly to
- Select the node on which to install the RAR file and click Next.
- Enter a name for the resource adapter, such as
Siebel. Click OK. - Save the configuration changes.
- For each Siebel application, define a connection factory for the Siebel JCA adapter.
- Click on Resource Adapters in the navigation tree.
- Click on the resource adapter you deployed in step 4. (For example: Siebel.)
- Under Additional Properties, click on J2C Connection Factories.
- Click New.
- Enter the following:
- A name for the connection factory that references the Siebel application, such as
Siebel Call Center. The application to create a connection factory may include:- Siebel Call Center
- Siebel eChannel Partner Portal
- Siebel ERM
- Siebel Marketing
- Siebel Sales
- The JNDI binding path. The convention for this value is based on the application for which you are creating the connection factory, such as
eis/siebel/SCCObjMgrfor theSiebel Call Centerconnection factory. However, you can specify any JNDI binding path as long as it does not conflict with another JNDI path name. Note that this value must also be specified as the JNDI binding path configuration parameter in configuration mode for each Siebel portlet. Recommended JNDI binding path values include:- Siebel Call Center:
eis/siebel/SCCObjMgr - Siebel eChannel Partner Portal:
eis/siebel/eChannelObjMgr - Siebel ERM:
eis/siebel/ERMObjMgr - Siebel Marketing:
eis/siebel/eMarketObjMgr - Siebel Sales:
eis/siebel/SSEObjMgr
- Siebel Call Center:
- Click OK.
- Click on the connection factory just created.
- Under Additional Properties, click on Custom Properties.
- Specify the properties for the Siebel system you want to connect to by selecting the property from the list and entering a value in the entry field:
- connectString
- The connection string used to contact the Siebel server.
The general format for this value is
siebel://[machine name]/[enterprise name]/[object manager]/[server name]. The[object manager]value in the connection string should correspond to that specified in the JNDI binding path. For example, if you are defining a connection factory with a JNDI binding path ofeis/siebel/ERMObjMgr, you would specify a connection string likesiebel://machine1.mycompany.com/siebel/ERMObjMgr/server1. For details on the connection string format, refer to the Siebel documentation. - jarPath
- Enter the value
siebel_lib_dir, the directory where you placed the Siebel libraries.
- Click OK.
- Repeat the steps to create a connection factory for the remaining Siebel applications.
- A name for the connection factory that references the Siebel application, such as
Configure for SAP
- Download SAP's JCO adapter directory from SAP at http://service.sap.com.
- Click Download Software > Download > SAP Connectors > SAP Java Connector. Select the appropriate file to download based on your operating system and version of WebSphere Portal. Extract the contents of the ZIP file into a local directory.
- Complete the following steps according to your operating system and WebSphere Portal version.
Note:
was_rootrefers to the directory in which WebSphere Application Server is installed; for example, C:\WebSphere\AppServer. In addition,wps_rootrefers to the directory in which WebSphere Portal is installed; for example, C:\WebSphere\PortalServer.
WebSphere Portal 4.x:
- For Windows:
- Copy the file librfc32.dll to
was_root\bin. - Copy sapco.jar and sapjcorfc.dll to
was_root\lib. - Restart the WebSphere Application Server.
- Copy the file librfc32.dll to
- For AIX:
- Copy the file librfccm.o to
was_root\bin. - Copy sapjco.jar and libsapjcorfc.o to
was_root\lib. - Restart the WebSphere Application Server.
- Copy the file librfccm.o to
- For Solaris/Linux:
- Copy the file librfccm.so to
was_root\bin. - Copy sapjco.jar and libsapjcorfc.so to
was_root\lib. - Restart the WebSphere Application Server.
- Copy the file librfccm.so to
WebSphere Portal 5.0.x:
- For Windows:
- Copy the file librfc32.dll to
was_root\binandwps_root\bin. - Copy sapjco.jar and sapjcorfc.dll to
was_root\libandwps_root\shared\app. - Restart the WebSphere Application Server.
- Copy the file librfc32.dll to
- For AIX:
- Copy the file librfccm.o to
was_root\binandwps_root\bin. - Copy sapjco.jar and libsapjcorfc.o to
was_root\libandwps_root\shared\app. - Restart the WebSphere Application Server.
- Copy the file librfccm.o to
- For Solaris/Linux:
- Copy the file librfccm.so to
was_root\binandwps_root\bin. - Copy sapjco.jar and libsapjcorfc.so to
was_root\libandwps_root\shared\app. - Restart the WebSphere Application Server.
- Copy the file librfccm.so to
4. Log in to WebSphere Portal as an administrative user to add the Application Builder to a page.
5. Click the Configure icon to modify the following configuration parameters:
| Parameter | Value |
|---|---|
| Hostname | Enter the SAP server hostname. |
| Client number | Enter the SAP client number. |
| System Number | Enter the SAP system number. |
| Language | Enter the two letter country code. For example, EN for English. |
| Connections per user pool | Enter the maximum number of connections to use for connection pooling purposes. |
Configure for SAP Business Object Editor
Note: Prior to installing the SAP Business Object Editor, you must install SAP's JCO adapter. Follow the first four steps in Configure for SAP under the section that is applicable to your version of WebSphere Portal. Install one of the following war files based upon your WebSphere Portal installation:
- WPAISAPEditor4x.war (for WebSphere Portal 4.x)
- WPAISAPEditor50.war (for WebSphere Portal 5.0)
When you initially start the editor you will be prompted to enter the following configuration information:
| Parameter | Value |
|---|---|
| Hostname | Enter the SAP server hostname. |
| Client number | Enter the SAP client number. |
| System Number | Enter the SAP system number. |
| Language | Enter the two letter country code. For example, EN for English. |
| Slot name | Enter the name of a credential vault slot you have created. |
Configure the JDBC adapter
WebSphere Portal 4.x:
Three fields are needed for input:
- JNDI name
- This is the same name displayed when creating a database data source using the WebSphere Administration Console.
- User ID
- This is the database user ID. It will be saved in the credential vault.
- Password
- This is the database password. It will be saved in the credential vault.
Configure a WebSphere Data Source
- Launch the WebSphere Administration Console.
- In the left hand panel, expand the Domain tree, and then the Resources tree.
- Select JDBC Providers.
- In the right panel, click Help. You will see Help Page 6.6.14.0: Properties of JDBC and data source providers.
- Follow the instructions for creating a JDBC Provider if you do not wish to use an existing one.
- Follow the instructions to create a database data source. The JDBC portlet builder will need the JNDI name listed by WebSphere for the database data source.
Configure a JDBC Business Object
The following parameters exist on the JDBC Business Object configuration page:
| Parameter | Value |
|---|---|
| Schema drop down list | This list contains schemas available through the JDBC connection. |
| Table list search string |
This search string is used when tables are retrieved for a schema. The value can be any legal SQL search string syntax. For example, enter % to get all tables, or use an _ (underscore) to match on a single character. |
| Table list | Results of search. |
- Set the Table list search string. This step is especially important if the schema contains a large number of tables. Otherwise, the default setting is Get all tables.
- Select the schema from the drop down list.
- Click Get tables. The search results will be displayed.
- Select a table in order to make it available to the portlet builder.
Note: There are two ways to refresh the table list:
- Use Get tables.
- Select a new schema.
When using a connection to an Oracle database, an additional configuration step is needed. You must update the Portal JVM properties:
- Launch the WebSphere Administration Server Console.
- In the left pane, expand the tree to the Application Servers, and select WebSphere Portal.
- In the right pane, select JVM settings.
- Add a classpath entry for Oracle classes12.zip.
- Click Apply.
- Stop and restart WebSphere Portal. This step is necessary to enable JDBC and connection pool implementation classes for Oracle.
Notes:
- This portlet uses the WebSphere JDBC data source so it can take advantage of connection pooling. You must consider how many portlets you run versus the size of your connection pool, since each portlet uses a connection. The connection is used and then released. If you run a large number of these portlets, you may need to increase the size of your connection pool.
- The JDBC portlet will not allow you to update or delete records for tables
that do not have primary keys. When you attempt to delete or update records
for a table that does not have primary keys, you see the following message:
Fatal error occurred in BusinessObject Framework. Please see log for details.
In the log you will see one of the following messages along with a stack trace:
- Update is not supported for tables that have no primary keys.
- Delete is not supported for tables that have no primary keys.
- The JDBC Portlet Builder only supports DB/2 and Oracle databases as identified in the following table:
Portal Version Platforms Supported Databases 4.1 - Windows 2000
- Solaris 2.7
- AIX 4.3
- DB2 version 7 FP2 or above
- Oracle 8i
4.2 - Windows 2000
- Solaris 2.7
- DB2 version 7 FP2 or above
- Oracle 8i
WebSphere Portal 5.0.x:
Websphere Application Server Configuration for a Database Provider
- Start the Administrator's Console.
- In the left hand panel expand Resources.
- Select JDBC Providers.
- In the right hand panel specify the cell or node scope by browsing or entering it in the input field.Click Apply.
- Click New to create a JDBC Provider
- Using the drop down list, select the appropriate provider and click on the Apply button. Use the appropriate configuration information listed below for your provider:
- DB2
- Select DB2 JDBC Provider.
- Set property Classpath to the location of db2java.zip
- Oracle
- Select Oracle JDBC Thin Driver
- Set property Classpath to the location of classes12.zip
- Cloudscape
- Select Cloudscape JDBC Provider.5.0
- Set property Classpath to the location of db2j.jar. The default location is <WAS_HOME>/lib.
- DB2
- Save your changes to the Master Configuration.
Websphere Application Server Configuration for a Data Source
- Start the Administrator's Console.
- In the left hand panel expand Resources.
- Select JDBC Providers.
- In the right hand panel specify the cell or node scope by browsing or entering it in the input field.Click Apply.
- Select the appropriate JDBC provider.
- Select Data Sources in the Additional Properties table for the provider.
- Click on the New button to create a Data Source.
- Enter a value for the property Name.
- Enter a value for property JNDI Name.
- Click Apply.
- Use the following to configure the appropriate provider:
- DB2
- Select Custom Properties under the Additional Properties table.
- Enter the database name for property databaseName. Click OK.
- Enter the DB2 server port number for property portNumber. The default is 50000. Click OK
- Save your changes to the master configuration.
- Oracle
- Select J2C Authentication Data Entries under the Related Information table.
- Click on the New button.
- Enter a value for the property Alias.
- Enter the database user ID for property User ID.
- Enter the database password for property Password.
- Click OK.
- Save your changes to the master configuration.
- Navigate back to your data source in the Administrator's Console.
- Select the Authentication Alias you just created for both Container and Component using the drop down list.
- Click Apply
- Select Custom Properties under the Additional Properties table.
- Enter the database name for property databaseName
- Enter the Oracle URL for property URL. The format is jdbc:oracle:thin:@myServer:1521:myDatabase, where myServer is the server name, 1521 is the port it used for communication, and myDatabase is the database name.
- Save your data source configuration.
- Cloudscape
- Select Custom Properties under the Additional Properties table.
- Enter the database name for property databaseName. For example, <WAS_HOME>/bin/DefaultDB.
- Property Connection Attributes: If your cloudscape database needs to be upgraded, enter upgrade=true to permit the upgrade. In this case you will not be able to get a schema list from the database when using the builder. The SystemErr.log will have an exception and indicate upgrade=true needs to be set for this database.
- DB2
Notes:
- After creating the appropriate provider and data source, it will be necessary to stop and restart both the WebSphere application server and the WebSphere_Portal application server.
- For remote DB2 databases, the database connection needs to be set up using the DB2 Client Configuration Assistant. The database alias name entered here is the database name used for the data source. Note that "Test Connection" may fail because there is no awareness of the remote user ID and password. This authentication is handled when configuring the portlet and portlet builder.
- For Cloudscape, only one open conncetion is permitted on a database at a time. If you successfully test the connection using the test connection button on the Cloudscape data source, you may need to restart the server.
- If you are using Cloudscape viewer and you upgrade you may no longer be permited to view this database. This is because the viewer tool says the tool needs an upgrade to view the upgraded database.
- This portlet uses the WebSphere JDBC data source so it can take advantage of connection pooling. You must consider how many portlets you run versus the size of your connection pool, since each portlet uses a connection. The connection is used and then released. If you run a large number of these portlets, you may need to increase the size of your connection pool.
- The JDBC portlet will not allow you to update or delete records for tables
that do not have primary keys. When you attempt to delete or update records
for a table that does not have primary keys, you see the following message:
Fatal error occured in BusinessObject Framework. Please see log for
details.
In the log you will see one of the following messages along with a stack trace:
- Update is not supported for tables that have no primary keys.
- Delete is not supported for tables that have no primary keys.
- The JDBC Portlet Builder only supports DB/2, Oracle, and Cloudscape databases. The following table identifies the supported versions of DB2 and
Oracle:
Portal Version Platforms Supported Databases 5 - Windows 2000
- Solaris 2.8
- AIX 4.3
- DB2 version 8.1
- Oracle 9i
Configure for Domino
- Make sure there is a Domino server available and note the port number where the Domino server is running.
- In the Domino server document > Internet Protocols > HTTP, set Allow HTTP clients to browse databases to "Yes."
- Start Domino server.
- Type "load http" in the Domino server console window. Wait until this loads.
- Type "load diiop".
- Install WebSphere Portal.
Note: If Domino server and WebSphere Portal are installed on the same machine, change the Domino server's http port number so it does not conflict with the http server in WebSphere Portal. Remember this port number. - Install Click-to-Action if it is not installed with WebSphere Portal.
- Install the WebSphere Struts framework if it is not installed with WebSphere Portal.
- Install WPAIPortletBuilders.war and WPAIDominoTemplate.war.
- Create a page on the portal.
- Add the Portlet Builder for Domino portlet to the newly created page.
- Log out of WebSphere Portal and log back in.
- Switch the browser to the newly created page. If all the steps are successful, you will be able to create a new portlet using this page.
| Parameter | Value |
|---|---|
| Domino Server Name | Name of the Domino Server you are using. |
| Domino Database Name | Name of the Domino Database you are using. |
| Domino User ID | User ID |
| Password | Password |
The version of Transcoding Technology that WebSphere Portal 4.1.2 uses causes a conflict with the J2C resource adapter in WebSphere Application Server. To use the adapters, you can resolve the conflict by doing one of the following two actions:
- Install WebSphere Portal Fix Pack 4.1.3 or later.
- Add the J2C JAR files to the JVM settings for the WebSphere Portal application
server in WebSphere Application Server:
- Start the WebSphere Administrator's Console.
- Double-click on WebSphere Administrative Domain.
- Double-click on Nodes.
- Double-click on the node for your machine.
- Double-click on Application Servers.
- Select WebSphere Portal.
- In the right-hand pane, select JVM Settings.
- In the Classpaths box, click Add
and enter the path and file name for each JAR file:
- For PeopleSoft 8:
- <was_root>\lib\jca.jar
- <was_root>\lib\j2c.jar
- <was_root>\lib\psft8adapter.jar
- <was_root>\lib\ccf2.jar
- For Siebel:
- <was_root>\lib\jca.jar
- <was_root>\lib\j2c.jar
- <was_root>\lib\siebeladapter.jar
- <was_root>\lib\ccf2.jar
- For PeopleSoft 8:
- Ensure that the files added to the classpath in the previous step are actually in the specified directories.
Configure for WebSphere Portal content publishing
The WebSphere Portal content publishing Runtime server and the Application Portlet Builder must be installed on the same WebSphere Portal. The builder obtains metadata from content resources that have been published to the WebSphere Portal content publishing Runtime server.
Portlet installation
Once you have completed the configuration steps, deploy the Application Portlet Builder in your portal environment using the following files from the extracted contents of the download file:
- WebSphere Portal 4.1.x
- WPAIPortletBuilders41.war
- WPAIDefaultTemplate41.war
- WPAIDominoTemplate41.war
- WebSphere Portal 4.2.x
- WPAIPortletBuilders.war
- WPAIDefaultTemplate.war
- WPAIDominoTemplate.war
- WebSphere Portal 5.0.x
- WPAIPortletBuilders50.war
- WPAIDefaultTemplate50.war
- WPAIDominoTemplate50.war
See the WebSphere Portal documentation for portlet installation instructions.
Configuration parameters
There are no configuration parameters for this portlet.
WPAI Profile Service
Large enterprise applications such as SAP have certain pieces of information which are frequently needed by users when querying information. The WPAI Profile Service expands upon the already existing user profile provided by WPAI (first name, last name, etc.) by allowing application-specific attributes which are frequently used during queries to be retrieved and cached on a per user basis. These attributes are retrieved "on demand" by the profile service and cached until the user logs out. In addition, since the profile service is actually a portlet service, these cached attributes are available to all WPAI portlets which are accessing the same account on an application.
WebSphere Portal 4.x:
Installing the WPAI Profile Service
Unzip the install file and perform the following steps to install and configure the profile service:
- Copy the files WEB-INF/lib/wpai_profile_service.jar and /WEB-INF/lib/boframework.jar to the <WAS_HOME>/lib/app directory.
- Copy the wpai_profile_service directory to <WAS_HOME>/lib/app
- Add the following three lines to the file <WAS_HOME>/lib/app/config/services/PortletServiceRegistryService.properties exactly as they appear below:
com.ibm.wps.portlets.wpai.profileservice.WPAIProfileService= com.ibm.wps.portlets.wpai.profileservice.WPAIProfileServiceImpl com.ibm.wps.portlets.wpai.profileservice.WPAIProfileServiceImpl.factory= org.apache.jetspeed.portletcontainer.service.PortletServiceCacheFactory com.ibm.wps.portlets.wpai.profileservice.WPAIProfileServiceImpl.BASE_CONFIG= wpai_profile_service.base_config
- Restart the WebSphere Application Server.
Configuring the WPAI Profile Service for Use with SAP
- Copy the sap_config folder to <WAS_HOME>/lib/app.
- Restart the WebSphere Application Server.
Setting up Logging for the Profile Service
- Add the following two lines to the file <WAS_HOME>/lib/app/config/services/LogService.properties exactly as they appear below.
- messagelogger.com.ibm.wps.portlets.wpai.profileservice = MessageLogger
- tracelogger.com.ibm.wps.portlets.wpai.profileservice = WPAIProfileServiceTraceLogger
- Add the following three lines to the file <WAS_HOME>/lib/app/config/jlog.properties exactly as they appear below.
baseGroup.WPAIProfileServiceTraceLogger.parent=TraceLogger baseGroup.WPAIProfileServiceTraceLogger.isLogging=true
#comment second out the line above this one to turn off logging for the WPAI Profile Service
Note: To turn logging off, simply comment out the following statement from the file <WAS_HOME>/lib/app/config/jlog.properties by placing a number sign (#) at the front of the line.
- Restart the WebSphere Application Server.
WebSphere Portal 5.0.x:
Installing the WPAI Profile Service
Unzip the install file and perform the following steps to install and configure the profile service:
- Copy the files WEB-INF/lib/wpai_profile_service.jar and /WEB-INF/lib/boframework.jar to the <WPS_HOME>/shared/app directory.
- Add the JAR files to the application server's WPSLib shared library. You can edit WPSLib in the Administrative Console by selecting Environment > Shared Libraries > WPSLib.
- Copy the wpai_profile_service directory to <WPS_HOME>/shared/app.
- Add the following three lines to the file <WPS_HOME>/shared/app/config/services/PortletServiceRegistryService.properties exactly as they appear below:
com.ibm.wps.portlets.wpai.profileservice.WPAIProfileService= com.ibm.wps.portlets.wpai.profileservice.WPAIProfileServiceImpl com.ibm.wps.portlets.wpai.profileservice.WPAIProfileServiceImpl.factory= com.ibm.wps.pe.pc.legacy.service.PortletServiceCacheFactory com.ibm.wps.portlets.wpai.profileservice.WPAIProfileServiceImpl.BASE_CONFIG= wpai_profile_service.base_config
- Restart the WebSphere Portal.
Configuring the WPAI Profile Service for Use with SAP
- Copy the sap_config folder to <WPS_HOME>/shared/app.
- Restart the WebSphere Portal.
- Enable logging for the com.ibm.wps.portlets.businessobject package
Additional references
Additional documentation is included in the download file, 1wp10003t.zip. When you unzip 1wp10003t.zip, you will find the following references in the doc subdirectory:
- WPAI Domino Reference.pdf
- WPAI Implementation Guide.pdf
- WPAI JDBC Reference.pdf
- WPAI PeopleSoft Reference.pdf
- WPAI Profile Service Reference.pdf
- WPAI Runtime Template Reference.pdf
- WPAI SAP Reference.pdf
- WPAI Siebel Reference.pdf
- WPAI WPCP Reference.pdf