This Getting Started guide describes PeopleSoft Extension.
Getting Started Guide
- 1.0 Installation notes
- 2.0 Configuration requirements
- 3.0 PeopleSoft session pooling and properties
The PeopleSoft Extension delivers to IBM® WebSphere® Portlet Factory users the following important features:
Using IBM WebSphere Portal Server credential vault.Automation of Portlet Code
Including support for standard component interface methods (Get, Find, Create, Save, Cancel), generation of various display and edit pages, and creation of schema to describe the data contained in the component interface.Seamless Integration with Other Builders
To create robust, highly customized portlets, including custom look-and-feel.
1.0 Installation notes
Install the PeopleSoft Extension as you would any other feature set.
- Consult the detailed system requirements in the release notes topic for information on supported product versions.
- 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 PeopleSoft Extension and click Apply. Click OK to add the feature set. Choose to re-deploy when prompted.
- Place a copy of the psjoa.jar file into the work/lib folder of the Eclipse project.
The PeopleSoft Java Object Adapter JAR file, psjoa.jar, can be obtained from your PeopleSoft installation or from your PeopleSoft Customer Service representative.
The JAR file contains Java classes used by the builders to access your PeopleSoft servers. If you have a local installation of PeopleSoft, look into the PS_HOME directory for a copy of this file.
Note: The version of this JAR file used by the builders must match the version of the PeopleSoft server being accessed. Using a mismatched psjoa.jar file with your PeopleSoft server may result in errors during builder regen and runtime.
Depending on your server settings, your application server and WebSphere Portlet Factory Designer may need to be restarted to correctly register all feature set files.
In a WebSphere Portal server environment, you must set the class loading order such that third-party JAR files are loaded before other JARs and classes. This insures that WebSphere Portal server can access and use these third-party files. See your WebSphere Portlet Factory Installation Guide for the steps required to establish this setting in WebSphere Portal server.
1.1 Verify installation
To confirm correct installation of the builder and JAR files, follow these steps:
- Create a new model.
- Add a PeopleSoft View and Form builder to the model and enter a name for the builder.
- Under the Connection Group, select default_connection.properties as the value for the Properties File input.
- Click the Test Connection button.
- A dialog indicating that a connection was successfully established should be displayed. If there was a problem connecting to your PeopleSoft server, an error dialog is displayed with an error message.
2.0 Configuration requirements
The first step in using the PeopleSoft builders is to establish a connection properties file. This file is located in the project /WEB-INF/config/peoplesoft_config/
directory. The properties file (default_connection.properties
) is used to specify connection properties, such as the name of the PeopleSoft server and a valid PeopleSoft user name and password.
A typical properties file might contain the following properties:
#Default connection properties for the PeopleSoft Builders
# PeopleSoft application server
# Logon user name
# Logon 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.
3.0 PeopleSoft session pooling and properties
The PeopleSoft builders support pooling of sessions to your backend PeopleSoft 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 PeopleSoft project .../WEB-INF/config/override.properties
file to enable and configure PeopleSoft session pooling.
PeopleSoft 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 1. Properties to enable and configure session pooling
|bowstreet.peoplesoft.session.pool.enabled||false||If defined and set to TRUE session pooling is enabled.|
|bowstreet.peoplesoft.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.peoplesoft.session.pool.maxIdleSessions||8||Maximum number of idle session in the pool at one time. When negative, there is no limit to the number of idle sessions.|
|bowstreet.peoplesoft.session.pool.maxWait||-1||Maximum time in milliseconds to wait for a session to be returned to the pool. When 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.peoplesoft.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.peoplesoft.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.peoplesoft.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 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