Configure WebSphere Portal for DB2 for OS/390 and z/OS
Before you begin
Before configuring databases, ensure that the following prerequisites are met:
Password considerations: For security reasons, not store passwords in the wpconfig.properties file. It is recommended that you edit the wpconfig.properties prior to running a configuration task, inserting the passwords needed for that task. Then, after the task has run, you should delete all passwords from the wpconfig.properties file. For more information, see Delete passwords.
- WebSphere Portal is installed with Cloudscape databases.
- Supported database software is installed.
- Databases and users are correctly setup for use by WebSphere Portal.
Alternatively, you can specify the password on the command line using the following syntax:
WPSconfig.{sh|bat} task_name
-D password_property_key=password_valueAs with other properties, each password property must have the
-D prefix and be set equal to (=) a value. If you have multiple properties in a single command, use a space character between each-Dproperty=value setting.Tips:
- The Steps for transferring data to another supported database section provides instructions for manually transferring data. Instead of performing the following steps, you can use the configuration wizard, a graphical user interface, to transfer data to another supported database. For more information, refer to Configure portal with the configuration wizard.
- A configuration template might exist to support these instructions. Refer to the wp_root/config/helpers directory for available configuration templates. Use the configuration template to update the wpconfig.properties file, as described in Using configuration templates, according to the property descriptions and recommended values provided here. If you do not want to use a configuration template, follow the instructions as written.
Steps for transferring data to another supported database
Follow these steps to transfer WebSphere Portal, Member Manager, and Personalization databases to DB2 for OS/390 and z/OS.
- Enter values specific to your environment. Locate the wp_root/config/wpconfig.properties file and create a backup copy before changing any values.
- Use a text editor to open the wp_root/config/wpconfig.properties file and enter the values that are appropriate for your environment.
Note the following information:
- To use the WebSphere Portal database to hold information for applications such as Document Manager, Personalization, Feedback and Likeminds, use the same configuration values for similar properties. For example, use the value for WpsDbName for JcrDbName, FeedbackDbName, and LikemindsDbName.
- Do not change any settings other than those specified in these steps. For instructions on working with these files, see Configuration properties reference for a complete properties reference, including default values.
- If you are using a remote database, be sure to enter the values for the remote server.
- Use / instead of \ for all platforms.
- Some values, shown here in italics, might need to be modified to your specific environment.
- There might be additional database properties other than those listed here. Only change the properties within this table; skip all other properties.
- If you are following the recommended architecture in Plan for DB2 for OS/390 and z/OS, the Value listed for each property in the following table represents the DB2 for OS/390 and z/OS-specific information that is required to configure WebSphere Portal to DB2 for OS/390 and z/OS.
Database properties Property Value DbSafeMode Description: This only applies to database-specific tasks. If set to true, database-specific tasks, such as create/modify/drop database, will be performed. The property should be used if a pre-configured database (from a previous installation) already exists. If the property is set to false, the database will be updated and the pre-existing database configuration will be overwritten.
Recommended value: false
Default value: false
DbType Description: The type of database used to store information for WebSphere Portal.
Recommended value: db2_zos
Windows/UNIX Default value: cloudscape
WpsDbName Description: The local alias of the database where WebSphere Portal objects created.
Notes:
- This value is also the database element in the DbUrl property.
- The actual database name is set with the WpsDbNameOnZos property.
- For DB2 and DB2 for OS/390 and z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to your database documentation for more information.
- If you change the name of the WebSphere Portal data source due to a database migration, manually update this property in the wp_root/config/wpconfig.properties file to maintain the proper the resource reference mapping.
Recommended value: wpsdb
Windows/UNIX Default value: wpsdb
WpsDbNameOnZos Description: The name of the WebSphere Portal database on DB2 for OS/390 and z/OS.
Required for DB2 for OS/390 and z/OS only.
- If you are running DB2 for OS/390 and z/OS as a remote database, set this property to the name of the remote WebSphere Portal database.
Recommended value: WPSTST02
Default value: WPSTST02
DbDriver Description: The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
Recommended value: COM.ibm.db2.jdbc.app.DB2Driver
Windows/UNIX Default value: com.ibm.db2j.jdbc.DB2jDriver (Cloudscape)
DbDriverDs Description: The data source for the JDBC provider that WebSphere Portal uses to communicate with its databases.
Recommended value: COM.ibm.db2.jdbc.DB2XADataSource
Windows/UNIX Default value: com.ibm.db2j.jdbc.DB2jXADataSource (Cloudscape)
JdbcProvider Description: The name of the JDBC provider that WebSphere Portal uses to communicate with its databases.
Recommended value: wpsdbJDBC
Default value: wpsdbJDBC
DbUrl Description: The database URL used to access the WebSphere Portal database with JDBC. The value must conform to standard JDBC URL syntax.
The database element of this value should match the value of WpsDbName.
Recommended value: jdbc:db2:wpsdb
Windows/UNIX Default value: jdbc:db2j:wpsdb;create=true (Cloudscape)
DbUser Description: The user ID for the database administrator.
Recommended value: <none>
Default value: db2admin
DbPassword Description: The password for the database administrator.
Recommended value: <none>
Default value: ReplaceWithYourDbAdminPwd
DbLibrary Description: The directory path where the classes for the JDBC provider are located.
Recommended value: SQLLIB/java12/db2java.zip
In UNIX environments, use a colon (:) instead of a semi-colon (;) to separate multiple paths.
Windows/UNIX Default value: d:/WAS51/portalserver/shared/app/cloudscape/db2j.jar
WpsDsName Description: The name of the data source that WebSphere Portal uses to communicate with its databases.
If the WebSphere Portal data source name is changed due to database migration, which is reflected in wp_root/config/wpconfig.properties, update the resource mappings by executing the following steps:
- Login to the WebSphere Application Server Administrative Console.
- Select Application>Enterprise Applications.
- Select the WebSphere Portal application.
- Select the Map resource references to resources option.
- Change the JNDI Name for reference binding jdbc/wpsDS to specify the new data source name.
- Click OK.
- Save the configuration changes.
Recommended value: wpsdbDS
Default value: wpsdbDS
WpsXDbName Description: The TCP/IP alias for the database to be used as data source name.
Required for non-Windows systems only.
Recommended value: wps5TCP
Default value: wps5TCP
WpsDbNode Description: This value is the node for the WebSphere Portal database
Recommended value: wpsNode
Default value: wpsNode
DB2 Content Manager Runtime Edition properties Property Value JcrDbName Description: The local alias of the database where DB2 Content Manager Runtime Edition objects created.
Notes:
- This value is also the database element in the JcrDbUrl property.
- The actual database name is set with the JcrDbNameOnZos property.
- For DB2 and DB2 for OS/390 and z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to your database documentation for more information.
- If you change the name of the WebSphere Portal data source due to a database migration, manually update this property in the wp_root/config/wpconfig.properties file to maintain the proper the resource reference mapping.
Recommended value:
Default value: jcrdb
JcrDbUser Description: The DB2 Content Manager Runtime Edition database administrator UserID, which is also used as the schema name for the DB2 Content Manager Runtime Edition's tables and database resources.
Recommended value: icmadmin
Default value: icmadmin
JcrDbPassword Description: The DB2 Content Manager Runtime Edition database administrator password.
Recommended value: <none>
Default value: ReplaceWithYourDbAdminPwd
JcrDbUrl Description: The URL used to access the DB2 Content Manager Runtime Edition database with JDBC.
The database element of this value should match the value of JcrDbName.
Recommended value: jdbc:db2:jcrdb
Default value: jdbc:db2j:jcrdb;create=true (Cloudscape)
JcrJdbcProvider Description: The name of JDBC provider to be used for DB2 Content Manager Runtime Edition. You can have the same provider even if you have multiple datasources.
Recommended value: jcr51JDBC
Default value: jcr51JDBC
JcrDsName Description: The name of datasource to be used for DB2 Content Manager Runtime Edition.
If the WebSphere Portal data source name is changed due to database migration, which is reflected in wp_root/config/wpconfig.properties, update the resource mappings by executing the following steps:
- Login to the WebSphere Application Server Administrative Console.
- Select Application>Enterprise Applications.
- Select the WebSphere Portal application.
- Select the Map resource references to resources option.
- Change the JNDI Name for reference binding jdbc/wpsDS to specify the new data source name.
- Click OK.
- Save the configuration changes.
Recommended value: JCRDS
Default value: JCRDS
JcrGeneratedDDLPath Description: Directory for the dynamic DDL files generated by DB2 Content Manager Runtime Edition. If you are using a clustered environment, this directory should be accessible to all portals in your cluster.
Recommended value: wp_root\jcr\config\dynamic
(where wp_root is the installation directory of WebSphere Portal)
Default value: ${WpsInstallLocation}/jcr/config/dynamic
(where ${WpsInstallLocation} is the installation directory of WebSphere Portal)
JcrBinaryValueFileDir Description: Temporary location for binary values
Recommended value: ${WpsInstallLocation}/jcr/binaryValues
Default value: ${WpsInstallLocation}/jcr/binaryValues
JcrDebugLevel Description: Debug level for DB2 Content Manager Runtime Edition database utilities. This property can be set to one of the following values:
0 - INFO, prints status information
1 - TRACE, provide method entry-exit information + INFO.
2 - DEBUG, display command information and SQL statement output information.
3 - DEBUG+, display processing information of DDL file as well as command that are been executed.
Recommended value: 2
Default value: 2
JcrDbUnicode Description: This property indicates whether or not the DB2 Content Manager Runtime Edition database is unicode.
Recommended value: Y
Default value: Y
JcrDbNameOnZos Description: The name of the WebSphere Portal database on DB2 for OS/390 and z/OS used to store DB2 Content Manager Runtime Edition data.
Recommended value: <none>
Default value: jcrdbzos
JcrDbHost Description: The hostname (only) of remote system hosting the DB2 Content Manager Runtime Edition database.
Recommended value : <none>
Default value: hostname
JcrDbDomain Description:The domain (not including hostname) of remote system hosting the DB2 Content Manager Runtime Edition database.
Recommended value: <none>
Default value: yourco.com
JcrBPCServerName
Description: The name of appserver with a configured Business Process Container.
Recommended value: <none>
Default value: server1
JcrJMSJAASUser
Description: The the user id for the Java Message Service (JMS) that the workflow engine will use to communicate with the DB2 Content Manager Runtime Edition.
Recommended value: <none>
Default value: ReplaceWithYourJMSUserId
JcrJMSJAASPassword
Description: The password for JcrJMSJAASUser.
Recommended value: <none>
Default value: ReplaceWithYourJMSPwd
JcrJMSType
Description: Type of Java Message Service (JMS) provider used.
Recommended value: embedded
Default value: embedded
JcrMQQueueManager
Description: The name of the WebSphere MQ Queue Manager.
This value is not needed for WebSphere Embedded Messaging.
Recommended value: <none>
Default value: <none>
Personalization and Feedback Database properties Property Value InitializeFeedbackDb Description: Specifies whether the Feedback schema and tables will be created on transfer.
Values:
- false: To share a Feedback database across multiple instances of WebSphere Portal or to use a Feedback database that was initialized with a previous installation of WebSphere Portal, set this property to false and configure the remaining Feedback properties according to the pre-existing database. The data contained in your existing Feedback schema will then be preserved.
- true: If set to true, then any existing Feedback database will be dropped and a new database will be created from scratch.
Recommended value: true
Default value: true
FeedbackXDbName Description: The TCP/IP alias for the Feedback database. This value is used to specify the data source on machines that are not running Windows.
Must be set for all non-Windows platforms when using DB2.
Recommended value: fdbk5TCP
Windows/UNIX Default value: fdbk5TCP
FeedbackDbName Description: The local alias of the database where Feedback objects created.
Notes:
- This value is also the database element in the FeedbackDbUrl property.
- The actual database name is set with the FeedbackDbNameOnZos property.
- For DB2 and DB2 for OS/390 and z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to your database documentation for more information.
- If you change the name of the WebSphere Portal data source due to a database migration, manually update this property in the wp_root/config/wpconfig.properties file to maintain the proper the resource reference mapping.
Recommended value:
Windows/UNIX Default value: wpsdb
FeedbackDbNameOnZos Description: The name of the remote Personalization Feedback database for DB2 for OS/390 and z/OS only.
Required only if using DB2 for OS/390 and z/OS as a remote database.
Recommended value: fdbk5zos
Default value: fdbk5zos
FeedbackDbTablespace Description: The name of the Feedback database table space.
Required only if running on DB2 for OS/390 and z/OS, or if using DB2 for OS/390 and z/OS as a remote database.
Recommended value: fdbkdbts
Default value: fdbkdbts
FeedbackDbUser Description: The database user for the Feedback database.
Recommended value: <none>
Default value: wcmdbadm
FeedbackDbPassword Description: The database password for feedback database.
Recommended value: <none>
Default value: ReplaceWithYourDbAdminPwd
FeedbackDbUrl Description: The database URL used to access the feedback database with JDBC. The value must conform to the standard JDBC URL syntax.
The database element of this value should match the value of FeedbackDbName.
Recommended value: jdbc:db2:fdbkdb
Windows/UNIX Default value: jdbc:db2j:fdbkdb;create=true (Cloudscape)
LikeMinds Database properties Property Value LikemindsXDbName Description: The TCP/IP Alias for the LikeMinds database. This value is used to specify the data source on machines that are not running Windows.
Required for Non-Windows platforms when using DB2 only.
Recommended value: lmdb5TCP
Default value: lmdb5TCP
LikemindsDbName Description: The local alias of the database where Likeminds objects created.
Notes:
- This value is also the database element in the LikemindsDbUrl property.
- The actual database name is set with the LikemindsDbNameOnZos property.
- For DB2 and DB2 for OS/390 and z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to your database documentation for more information.
- If you change the name of the WebSphere Portal data source due to a database migration, manually update this property in the wp_root/config/wpconfig.properties file to maintain the proper the resource reference mapping.
Recommended value:
Default value: wpsdb
LikemindsDbNameOnZos Description: The name of the remote LikeMinds database.
Required only if using DB2 for OS/390 and z/OS as a remote database.
Recommended value: lmdb5zos
Default value: lmdb5zos
LikemindsDbTablespace Description: The name of the LikeMinds database table space.
Required only if running on DB2 for OS/390 and z/OS, or if using DB2 for OS/390 and z/OS as a remote database.
Recommended value: lmdbts
Default value: lmdbts
LikemindsDbUser Description: The database user for LikeMinds database.
This property is required for
- DB2
- DB2 for OS/390 and z/OS
Recommended value: <none>
Default value: lmadmin
LikemindsDbPassword Description: The database password for LikeMinds database.
Recommended value: <none>
Default value: ReplaceWithYourDbAdminPwd
LikemindsDbUrl Description: The database URL used to access the LikeMinds database with JDBC. The value must conform to the standard JDBC URL syntax.
The database element of this value should match the value of LikemindsDbName.
Recommended value: jdbc:db2:lmdb
Windows/UNIX Default value: jdbc:db2j:wpsdb;create=true (Cloudscape)
Member Manager properties Property Value WmmDsName Description: The name of the data source that WebSphere Portal uses to communicate with the Member Manager database.
Recommended value: wmmDS
Default value: wmmDS
WmmAppName Description: The name of the Member Manager enterprise application, as deployed into WebSphere Application Server.
Recommended value: wmmApp
Default value: wmmApp
WmmDbName Description: The local alias of the database where Member Manager objects created.
Notes:
- This value is also the database element in the WmmDbUrl property.
- The actual database name is set with the WmmDbNameOnZos property.
- For DB2 and DB2 for OS/390 and z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to your database documentation for more information.
- If you change the name of the WebSphere Portal data source due to a database migration, manually update this property in the wp_root/config/wpconfig.properties file to maintain the proper the resource reference mapping.
- If WebSphere Portal V5.1 and a previous version of WebSphere Portal coexist on the same box, this value must be different than the WebSphere Member Services database name in the previous version of WebSphere Portal.
Recommended value: wpsdb
Windows/UNIX Default value: wpsdb
WmmDbNameOnZos Description: The name of the remote Member Manager database for DB2 for OS/390 and z/OS only.
Required only if using DB2 for OS/390 and z/OS as a remote database.
Recommended value: wps5zos
Windows/UNIX Default value: wps5zos
WmmDbUser Description: The user ID for the database administrator.
If you are migrating from a previous version of WebSphere Portal, this value must match the database user name for the WebSphere Member Services database from the previous WebSphere Portal version.
Recommended value: <none>
Windows/UNIX Default value: ReplaceWithYourDbAdminId
WmmDbPassword Description: The password for the database administrator.
Recommended value: <none>
Default value: ReplaceWithYourDbAdminPwd
WmmDbUrl Description: The database URL used to access the Member Manager database with JDBC. The value must conform to standard JDBC URL syntax.
The database element of this value should match the value of WmmDbName. On z/OS, the database element of this value should match the location name of the database to be used when establishing connections with the DB2 datasource used by WebSphere Portal.
Recommended value: jdbc:db2:wpsdb
Windows/UNIX Default value:jdbc:db2j:wpsdb;create=true (Cloudscape)
WmmEjbName Description: The Enterprise Java Bean (like a classname) that other applications need to know it in order to communicate with it.
Recommended value: ejb/MemberServiceHome
Default value: ejb/MemberServiceHome
- Save the file.
- cd wp_root/config.
- If WebSphere Portal is on UNIX. Use the following steps to export the db2instance environment in your profile:
- In your .bashrc, .dshrc, or .profile file, add
if [ -f /home/db2inst1/sqllib/db2profile ]; then . /home/db2inst1/sqllib/db2profile; fi- Reopen all the shells.
- Validate configuration properties.
- UNIX:
- ./WPSconfig.sh validate-database-connection-wps -DDbPassword=password
- ./WPSconfig.sh validate-database-connection-jcr -DJcrDbPassword=password
- ./WPSconfig.sh validate-database-connection-feedback -DFeedbackDbPassword=password
- ./WPSconfig.sh validate-database-connection-likeminds -DLikemindsDbPassword=password
- ./WPSconfig.sh validate-database-connection-wmm -DWmmDbPassword=password
- ./WPSconfig.sh validate-database-driver
- Windows:
- WPSconfig.bat validate-database-connection-wps -DDbPassword=password
- WPSconfig.bat validate-database-connection-jcr -DJcrDbPassword=password
- WPSconfig.bat validate-database-connection-feedback -DFeedbackDbPassword=password
- WPSconfig.bat validate-database-connection-likeminds -DLikemindsDbPassword=password
- WPSconfig.bat validate-database-connection-wmm -DWmmDbPassword=password
- WPSconfig.bat validate-database-driver
- From the same command prompt as the previous steps, change to the directory wp_root/config.
- If WebSphere Portal is on UNIX. Export the DB2 user profile, that you created when installing DB2, onto the administrative user. This gives that administrative user rights over DB2. It is important to complete this step before running database tasks.
. /home/db2inst1/sqllib/db2profile
where db2inst1 represents your database instance.
- To transfer the database, perform this step:
- Enter the following commands to run the configuration task.
- UNIX: ./WPSconfig.sh database-transfer
-DDbPassword=password -DJcrDbPassword=password -DJcrJMSJAASPassword=password -DFeedbackDbPassword=password -DLikemindsDbPassword=password -DWmmDbPassword=password - Windows: WPSconfig.bat database-transfer
-DDbPassword=password -DJcrDbPassword=password -DJcrJMSJAASPassword=password -DFeedbackDbPassword=password -DLikemindsDbPassword=password -DWmmDbPassword=password - After running this task, a message indicating success should result. Check the log files to verify that this task was successful. If the configuration fails, verify the values in the wpconfig.properties file, and then repeat this step
- From the command line processor, reset the check pending status on the WebSphere Portal table spaces listed here. CHECK DATA is a DB2 batch utility that is invoked through JCL or through the DB2 utility panels. Type the following utility commands to check pending status:
check data tablespace wpsdb.ts2110 check data tablespace wpsdb.ts320 check data tablespace wpsdb.ts280 check data tablespace wpsdb.ts830 check data tablespace fdbkdb.fdbktswhere wpsdb is the name of your WebSphere Portal database, fdbk is the name of your Feedback database and fdbkts is the name of your Feedback database table space. Refer to the Utility Guide and Reference for DB2 for OS/390 and z/OS for additional details.
- After transferring to WebSphere Portal, run the RUNSTATS utility as shown in the following example:
LISTDEF JCRDBZOS INCLUDE TABLESPACE JCRDBZOS.* BASE RUNSTATS TABLESPACE LIST JCRDBZOS INDEX(ALL) KEYCARD TABLE(ALL)- Start the WebSphere Application Server.
- Verify that the WebSphere Portal appserver is running by opening the following URL in a browser: http://hostname.yourco.com:port_number/wps/portal, where hostname.yourco.com is the fully qualified host name of the machine where WebSphere Portal is running and port_number is the transport port that is created by WebSphere Application Server.
Next steps
- Database (Windows/UNIX)
- Plan for DB2 for OS/390 and z/OS
- Install DB2 for OS/390 and z/OS
- Create databases and users for DB2 for OS/390 and z/OS
- Verifying database connections
- Verifying database connections
WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.
IBM is a trademark of the IBM Corporation in the United States, other countries, or both.