Configuration task reference
Contents
- WebSphere Portal base tasks
- backup-main-cfg-file
- basic-config
- cleanup-work-dir
- config-was-internal-http
- create-all-db
- create-database
- create-wmm-db
- create-wps-db
- default
- delete-passwords
- deploy-infocenter
- disable-security
- drop-database-wps
- drop-tables-database-wmm
- drop-tables-database-wps
- drop-wmm-db
- enable-security-cur
- enable-security-ldap
- httpserver-config
- init
- lcc-configure-all
- lcc-configure-quickplace
- lcc-configure-sametime
- lcc-configure-dominodirectory
- modify-servlet-path
- portlets
- remove-was-cfg
- secure-portal-cur
- secure-portal-ldap
- setup-productivity-components
- setup-transcoding
- setup-was
- start-admin-server
- start-portal-server
- stop-admin-server
- stop-portal-server
- update-contentaccessservice-proxy
- update-wtp-translation
- validate-database-connection-wmm
- validate-database-connection-wpcp
- validate-database-connection-wps
- validate-database-driver
- validate-http-portal
- validate-ldap
- validate-wps-admin-login
- Content management tasks
- deploy-pdm-portlet
- remove-wpcp-database
- remove-wpcp-databases-db2
- setup-wpcp
- wpcpconfigure
- wpcpremove
- Related information
Overview
This topic explains the configuration tasks that are used as part of the WebSphere Portal installation process. Note that the specific tasks required for installation can vary, depending on how you are deploying WebSphere Portal and its related components. Refer to the installation instructions for each component for information on which configuration tasks use.
The task dependencies listed for each task will be executed when that specific task is run. The task dependencies are included for informational purposes only.
These instructions assume that the WebSphere Portal installation program has been run and the necessary portal instances have been created.
How to use this topic
- Tasks are sorted alphabetically. Locate tasks by searching by key word.
- You must have an OS/400 user profile with *ALLOBJ and *JOBCTL special authority to configure WebSphere Portal.
- There are two examples given for each configuration task: one for running the task from the Product directory...
/QIBM/ProdData/PortalServer5/config
...and one for running the task from the User directory...
/QIBM/UserData/WebAS5/Base/<instance>/PortalServer5/config
When running the task from the Product directory, specify the instance the task applies to.
WebSphere Portal base tasks
This section explains the configuration tasks that are used to configure the additional components provided with WebSphere Portal. These tasks are invoked by running the WPSconfig script. Note that the specific tasks required can vary, depending on which component you are deploying. Refer to the installation instructions for each component for information on which configuration tasks use.
To run the WPSconfig script with more than one option at a time, use the format below:
- UNIX:
WPSconfig.sh -Dproperty1=value1 -Dproperty2=value2 task-name-goes-here
-
Windows:
WPSconfig.bat -Dproperty1=value1 -Dproperty2=value2 task-name-goes-here
In addition to WPSconfig.sh, there are two other script files needed for manually configuring WebSphere Portal: addwpsinst.sh and rmvwpsinst.sh. For more information on these script files, refer to Adding WebSphere Portal to a WAS instance.
Password considerations:
For security reasons, not leave passwords in the wpconfig.properties file. It is recommended that you choose one of the following options:
- Edit the wpconfig.properties prior to running a configuration task, inserting the passwords needed for that task. Then, after the task has run, delete all passwords from the wpconfig.properties file. For more information, see Deleting passwords.
- Alternatively, you can specify the required passwords on the command line
rather than update the wpconfig.properties file. For example:
- WPSconfig.sh task_name [-Dpassword_property_key=password_value]
- WPSconfig.sh validate-wps-admin-login -DPortalAdminPwd=password
If you select the Install and Configure
option when installing WebSphere Portal, or use the IBM Web Administration for iSeries tool, the passwords in the wpconfig.properties file are automatically removed after configuration.
backup-main-cfg-file
Makes a backup copy of the wpconfig.properties file. This task can be performed at any time to retain a version of the properties used during configuration.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> backup-main-cfg-file
- From the user directory:
WPSconfig.sh backup-main-cfg-file
Inputs:
None
Assumptions/Prerequisites:
The backup copy of the file is named wpconfig_timestamp.properties, where timestamp indicates the time the copy was made. For example, wpconfig_yyyy-mm-dd-hh-mm.properties.
Error Conditions:
This task will fail if the wpconfig.properties file cannot be found.
Task dependencies:
None
Tasks invoked:
None
basic-config
Performs all basic configuration to set up WebSphere Portal, including initializing the database, setting up WAS and WebSphere Portal content publishing, and setting up WebSphere Portal's transcoding capability and the enterprise applications associated with WebSphere Portal.
Usage:
Typically invoked as part of the WebSphere Portal installation (Install and Configure
option). The task can also be invoked manually after installation. For example:
- From the product directory:
WPSconfig.sh -instance <instance> basic-config
- From the user directory:
WPSconfig.sh basic-config
Inputs:
None
Assumptions/Prerequisites:
WAS must be installed and running before this task is invoked.
Error Conditions:
None
Task dependencies:
init
Tasks invoked:
action-check-portal-admin-pwd, action-check-virtualhost-is-present, start-admin-server, action-check-before-init-database, action-init-database-wps, action-init-database-wmm-dev, setup-was, action-config-portal-dev, setup-transcoding, setup-productivity-components, action-set-lwp-shared-library, wpcpconfigure
cleanup-work-dir
Performs cleanup of working config files.
Usage:
Deletes working config files for security or to save disk space. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> cleanup-work-dir
- From the user directory:
WPSconfig.sh cleanup-work-dir
Inputs:
None
Assumptions/Prerequisites:
None
Error Conditions:
This task will fail if the WebSphere Portal product files are not found.
Task dependencies:
None
Tasks invoked:
None
config-was-internal-http
Changes the WAS internal transport port with the WpsHostPort value from the wpconfig.properties file.
Usage:
Changes the WpsHostPort to the WAS internal transport port. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> config-was-internal-http
- From the user directory:
WPSconfig.sh config-was-internal-http
Inputs:
None
Assumptions/Prerequisites:
None
Error Conditions:
This task can only be used if running without an HTTP server.
Task dependencies:
init
Tasks invoked:
action-set-http-transport, action-create-host-alias
create-all-db
Creates the WebSphere Portal and WMM databases for DB2 only.
Usage:
Invoked to create the WebSphere and WMM databases for use with DB2. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> create-all-db
- From the user directory:
WPSconfig.sh create-all-db
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbType The type of database used with WebSphere Portal. For this task, this value should be db2. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbUrl The database URL used to access the WPS50 database with JDBC. DbUser The database user. DbPassword The database user password. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located. WmmDbName The name of the Member Manager database. WmmDbSchema The name of the Member Manager database schema. WmmDbUrl The database URL used to access the Member Manager database with JDBC. WmmDbUser The user ID for the Member Manager database administrator. WmmDbPassword The password for the Member Manager database administrator.
Assumptions/Prerequisites:
None
Error Conditions:
None
Task dependencies:
Tasks invoked:
None
create-database
Creates the WPS50 and WMMDB databases used with WebSphere Portal. Note that this task is only applicable to DB2 UDB for UNIX, Windows, and Linux.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> create-database
- From the user directory:
WPSconfig.sh create-database
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbType The type of database used with WebSphere Portal. For this task, this value should be db2. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbUrl The database URL used to access the WPS50 database with JDBC. DbUser The database user. DbPassword The database user password. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located. WmmDbName The name of the Member Manager database. WmmDbSchema The name of the Member Manager database schema. WmmDbUrl The database URL used to access the Member Manager database with JDBC. WmmDbUser The user ID for the Member Manager database administrator. WmmDbPassword The password for the Member Manager database administrator.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
init
Tasks invoked:
create-wmm-db
Creates the WMM database used with WebSphere Portal. This task only creates the database and does not create any tables or perform any other initialization. Note that this task is only applicable to DB2 UDB for UNIX, Windows, and Linux.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> create-wmm-db
- From the user directory:
WPSconfig.sh create-wmm-db
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbType The type of database used with WebSphere Portal. For this task, this value should be db2. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located. WmmDbName The name of the Member Manager database. WmmDbSchema The name of the Member Manager database schema. WmmDbUrl The database URL used to access the Member Manager database with JDBC. WmmDbUser The user ID for the Member Manager database administrator. WmmDbPassword The password for the Member Manager database administrator.
Assumptions/Prerequisites:
None
Error Conditions:
None
Task dependencies:
None
Tasks invoked:
None
create-wps-db
Creates the WPS50 database. This task only creates the database and does not create any tables or perform any other initialization. Note that this task is only applicable to DB2 UDB for UNIX, Windows, and Linux.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> create-wps-db
- From the user directory:
WPSconfig.sh create-wps-db
Note: Can be invoked directly as part of the WPSconfig script file or can be invoked by another configuration task, such as create-database.
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbType The type of database used with WebSphere Portal. For this task, this value should be db2. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbUser The database user. DbPassword The database user password. WpsDbName The name of the database used with WebSphere Portal. WpsDbSchema The name of the WebSphere Portal database schema. DbUrl The wps database URL. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.
Assumptions/Prerequisites:
None
Error Conditions:
None
Task dependencies:
action-create-wps-db-mp, action-create-wps-db-iseries
Tasks invoked:
None
default
Displays information explaining how the WebSphere Portal configuration program should be invoked.
Usage:
Although this task can be explicitly invoked, it is typically invoked by default when the WPSconfig script file is executed with no targets specified. For example:
- From the Product directory:
WPSconfig.sh -instance <instance>
- From the user directory:
WPSconfig.sh
Inputs:
None
Assumptions/Prerequisites:
None
Error Conditions:
None
Task dependencies:
None
Tasks invoked:
None
delete-passwords
Removes passwords from the wpconfig.properties file.
Usage:
Invoked to remove passwords from the wpconfig.properties file for security reasons. Passwords must be restored before running additional configuration tasks. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> delete-passwords
- From the user directory:
WPSconfig.sh delete-passwords
Inputs:
None
Assumptions/Prerequisites:
None
Error Conditions:
This task will fail if the WebSphere Portal product files are not found.
Task dependencies:
None
Tasks invoked:
None
deploy-infocenter
Copies the Information Center to the enterprise application path.
Usage:
Invoked to enable users to browse the Information Center using the HTTP server. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> deploy-infocenter
- From the user directory:
WPSconfig.sh deploy-infocenter
Inputs:
None
Assumptions/Prerequisites:
None
Error Conditions:
This task will fail if the WebSphere Portal product files are not found.
Task dependencies:
None
Tasks invoked:
None
disable-security
Disables global security on WAS and modifies WebSphere Portal to use basic portal-based authentication with the WMM database.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> disable-security
- From the user directory:
WPSconfig.sh disable-security
Inputs:
The following properties from the wpconfig.properties file must be updated to reflect the original settings before disabling security. If this is not done the administrator will not have administrative rights. For example:
- The original value after installation and before enabling security is:
uid=wpsadmin,o=default organization - The value after enabling security with LDAP is:
uid=wpsadmin,cn=users,dc=yourco,dc=com - The value change back to before disabling security is:
uid=wpsadmin,o=default organization
Input Description PortalAdminId The user ID of the WebSphere Portal administrator.
PortalAdminIdShort The short form of the user ID for the WebSphere Portal administrator, as defined in the PortalAdminId property. PortalAdminPwd The password of the WebSphere Portal administrator. PortalAdminGroupId The group ID for the group to which the WebSphere Portal administrator belongs. PortalAdminGroupIdShort The short form of the group ID for the WebSphere Portal administrator, as defined in the PortalAdminGroupId property.
Assumptions/Prerequisites:
Before this task is performed, WAS must be running and the WPS50 and WMM databases must be created and initialized. Security must be enabled.
Password considerations:
Typically, this task will be invoked passing -DPortalAdminPwd=PortalAdminPassword
Error Conditions:
This task will fail if WAS is not running or if a connection to the databases cannot be established.
Task dependencies:
init
Tasks invoked:
unsecure-configservice, action-disable-was-security
drop-database-wps
Completely drops the WPS50 database. This task drops the database and any tables. Note that this task is only applicable to DB2 UDB for UNIX, Windows, and Linux.
Usage:
Invoked to completely erase the database when using a local DB2 database. For example:
- From the product directory:
WPSconfig.sh -instance <instance> drop-database-wps
- From the user directory:
WPSconfig.sh drop-database-wps
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbType The type of database used with WebSphere Portal. WpsDbName The name of the database used with WebSphere Portal. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbUser The database user. DbPassword The database user password. WpsDbSchema The name of the WebSphere Portal database schema. DbUrl The wps database URL. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
init, action-drop-wps-db-mp, action-drop-wps-db-iseries
Tasks invoked:
None
drop-tables-database-wmm
Cleans the tables from the WPS50 database.
Usage:
Invoked to erase the database tables. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> drop-tables-database-wmm
- From the user directory:
WPSconfig.sh drop-tables-database-wmm
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbType The type of database used with WebSphere Portal. For this task, this value should be db2. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located. WmmDbUrl The JDBC URL to the database. WmmDbUser The database user. WmmDbPassword The database user password. WpsInstallLocation The directory where WebSphere Portal is installed.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
init
Tasks invoked:
None
drop-tables-database-wps
Cleans the tables from the WPS50 database.
Usage:
Invoked to erase the database tables. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> drop-tables-database-wps
- From the user directory:
WPSconfig.sh drop-tables-database-wps
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbType The type of database used with WebSphere Portal. For this task, this value should be db2. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbUrl The database URL used to access the WPS50 database with JDBC. DbUser The database user. DbPassword The database user password. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located. WpsInstallLocation The directory where WebSphere Portal is installed.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
init
Tasks invoked:
None
drop-wmm-db
Drops WMM database used with WebSphere Portal. This task drops the database and any tables. Note that this task is only applicable to DB2 UDB for UNIX, Windows, and Linux.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> drop-wmm-db
- From the user directory:
WPSconfig.sh drop-wmm-db
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbType The type of database used with WebSphere Portal. For this task, this value should be db2. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located. WmmDbName The name of the Member Manager database. WmmDbSchema The name of the Member Manager database schema. WmmDbUrl The database URL used to access the Member Manager database with JDBC. WmmDbUser The user ID for the Member Manager database administrator. WmmDbPassword The password for the Member Manager database administrator.
Assumptions/Prerequisites:
The WMM database must be created before performing this task.
Error Conditions:
This task will fail if the WMM database does not exist or if communication with the database cannot be established.
Task dependencies:
None
Tasks invoked:
None
enable-security-cur
Sets WAS security to use the WebSphere Portal database as a custom user registry (CUR).
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> enable-security-cur
- From the user directory:
WPSconfig.sh enable-security-cur
Inputs:
None
Assumptions/Prerequisites:
Before this task is performed, WAS must be running and the WPS50 and WMM databases must be created and initialized. For additional assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
This task will fail if WAS is not running or if a connection to the databases cannot be established.
Task dependencies:
init
Tasks invoked:
None.
enable-security-ldap
Configures the WPS50 and WMM databases for use with an LDAP directory and sets WAS security to use the LDAP directory.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> enable-security-ldap
- From the user directory:
WPSconfig.sh enable-security-ldap
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbUser The database user. DbPassword The database user password.
Assumptions/Prerequisites:
Before this task is performed, WAS must be running and the WPS50 and Member Manager databases must be created and initialized. For additional assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
This task will fail if WAS is not running or if a connection to the databases cannot be established.
Task dependencies:
init
Tasks invoked:
wps-ldap, wmm-cfg-ldap, secure-configservice, update-java-policy, action-cfg-was-security-ldap
httpserver-config
Configures WebSphere Portal for use with an HTTP server using the WpsHostPort value from the wpconfig.properties file.
Usage:
Invoked to configure WebSphere Portal for use with an HTTP server. When this task is performed, the HTTP server plugin is regenerated. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> httpserver-config
- From the user directory:
WPSconfig.sh httpserver-config
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WpsHostName The fully-qualified URL to WebSphere Portal. WpsHostPort The port used to connect to WebSphere Portal.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
This task will fail if WAS is not running or if a connection to the databases cannot be established.
Task dependencies:
init
Tasks invoked:
action-remove-http-transport, action-create-host-alias, action-generate-http-plugin
init
The main initialization task that prepares the configuration environment for other tasks, including preprocessing of some files.
Usage:
It is the prerequisite for other tasks and not commonly run by itself.
Inputs:
None
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
None
Tasks invoked:
copy-pzn-jars, take-care-of-wmm-jar, pre-process-wmm, pre-config
lcc-configure-all
Configures multiple properties related to Lotus Collaborative Components including: Domino Directory, QuickPlace, and Sametime.
Usage:
Invoked to configure multiple Lotus Collaborative Components properties. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> lcc-configure-all
- From the user directory:
WPSconfig.sh lcc-configure-all
Inputs:
None
Assumptions/Prerequisites:
Domino Directory, QuickPlace, and Sametime.
Error Conditions:
This task will fail if the Lotus Collaborative Components property file has not been updated with new values.
Task dependencies:
None
Tasks invoked:
lcc-configure-quickplace, lcc-configure-sametime, lcc-configure-dominodirectory
lcc-configure-quickplace
Configures Lotus QuickPlace for use with Lotus Collaborative Components.
Usage:
Invoked to configure Lotus QuickPlace for use with Lotus Collaborative Components. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> lcc-configure-quickplace
- From the user directory:
WPSconfig.sh lcc-configure-quickplace
Inputs:
None
Assumptions/Prerequisites:
Lotus QuickPlace
Error Conditions:
This task will fail if the Lotus Collaborative Components property file has not been updated with new values.
Task dependencies:
None
Tasks invoked:
None
lcc-configure-sametime
Configures Lotus Sametime for use with Lotus Collaborative Components.
Usage:
Invoked to configure Lotus Sametime for use with Lotus Collaborative Components. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> lcc-configure-sametime
- From the user directory:
WPSconfig.sh lcc-configure-sametime
Inputs:
None
Assumptions/Prerequisites:
Error Conditions:
This task will fail if the Lotus Collaborative Components property file has not been updated with new values.
Task dependencies:
None
Tasks invoked:
None
lcc-configure-dominodirectory
Configures Lotus Domino Directory for use with Lotus Collaborative Components.
Usage:
Invoked to configure Lotus Domino Directory for use with Lotus Collaborative Components. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> lcc-configure-dominodirectory
- From the user directory:
WPSconfig.sh lcc-configure-dominodirectory
Inputs:
None
Assumptions/Prerequisites:
Lotus Domino Directory
Error Conditions:
This task will fail if the Lotus Collaborative Components property file has not been updated with new values.
Task dependencies:
None
Tasks invoked:
None
modify-servlet-path
Updates WAS configuration files associated with WebSphere Portal to have appropriate path information. This task is run to change the context root for portal server.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> modify-servlet-path
- From the user directory:
WPSconfig.sh modify-servlet-path
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WpsContextRoot The context root or base URI for the portal. All URLs beginning with this path will be reserved for the portal. The value of this property is part of the URL used to access WebSphere Portal from a browser: http://WpsHostName:WpsHostPort/WpsContextRoot/WpsPersonalizedHome
For example,
http://hostname.yourco.com:80/wps
/portal
WpsDefaultHome The default portal page for users who are not logged in. The value of this property is part of the URL used to access WebSphere Portal from a browser. For example, http://hostname.yourco.com:80/wps/portal
WpsPersonalizedHome The portal page for users who have already logged in to the portal. This page cannot be accessed by anonymous users. The value of this property is part of the URL used to access WebSphere Portal from a browser. For example, http://hostname.yourco.com:80/wps/myportal
Assumptions/Prerequisites:
The WebSphere Portal enterprise application must be deployed before this task is performed. For additional assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
This task will fail if the required configuration files are not found.
Task dependencies:
init
Tasks invoked:
update-wps-ear, set-servlet-paths
portlets
Deploys the portlets included with WebSphere Portal (defined in the SetupPortal.xml file) using the XML configuration interface.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> portlets
- From the user directory:
WPSconfig.sh portlets
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WpsInstallLocation The directory where WebSphere Portal is installed. WpsHostName The fully-qualified host name used to access WebSphere Portal. WpsContextRoot The context root or base URI for the portal. All URLs beginning with this path will be reserved for the portal. PortalAdminId The user ID of the WebSphere Portal administrator. PortalAdminPwd The password of the WebSphere Portal administrator.
Assumptions/Prerequisites:
The WebSphere Portal enterprise application must be deployed before this task is performed.
Password considerations:
Typically, this task will be invoked passing -DPortalAdminPwd=PortalAdminPassword
Error Conditions:
None
Task dependencies:
init, action-deploy-portlets
Tasks invoked:
None
remove-was-cfg
Removes the WebSphere Portal enterprise application from WAS and performs any necessary WAS -related cleanup for the WebSphere Portal application.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> remove-was-cfg
- From the user directory:
WPSconfig.sh remove-was-cfg
Inputs:
None
Assumptions/Prerequisites:
WAS must be running before this task is performed.
Error Conditions:
This task will fail if WAS is not running.
Task dependencies:
init
Tasks invoked:
action-remove-datasource-wps, action-remove-datasource-wmm, action-remove-jdbcprovider-wps, action-remove-ear-wps, action-remove-ear-wmm, action-remove-appserver-wps, action-remove-shared-library.
secure-portal-ldap
Configures WebSphere Portal to use LDAP security without modifying possible existing WAS security configuration.
Usage:
Invoked to configure WebSphere Portal to use LDAP security without modifying possible existing WAS security configuration. This task should be used if WAS global security is enabled, and you want to configure WebSphere Portal for it. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> secure-portal-ldap
- From the user directory:
WPSconfig.sh secure-portal-ldap
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbUser The database user. DbPassword The database user password.
Assumptions/Prerequisites:
Values in the wpconfig.properties file must be identical to the WAS security configuration in the wpconfig.properties file.
Error Conditions:
This task will fail if the values in the wpconfig.properties file are not identical to the WAS security configuration in the wpconfig.properties file.
Task dependencies:
init
Tasks invoked:
action-update-database-wps-ldap, action-config-portal-ldap, action-secure-configservice, action-update-java-policy
setup-productivity-components
Performs configuration of the WebSphere Portal Productivity Components.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> setup-productivity-components
- From the user directory:
WPSconfig.sh setup-productivity-components
Inputs:
None
Assumptions/Prerequisites:
WebSphere Portal must be installed or deployed.
Error Conditions:
This task will fail if WebSphere Portal files are not found.
Task dependencies:
None
Tasks invoked:
None
setup-transcoding
Performs configuration of the Transcoding Technology function of WebSphere Portal.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> setup-transcoding
- From the user directory:
WPSconfig.sh setup-transcoding
Inputs:
None
Assumptions/Prerequisites:
The WebSphere Portal enterprise application must be installed and deployed before this task is performed.
Error Conditions:
This task will fail if the WebSphere Portal product files are not found.
Task dependencies:
None
Tasks invoked:
None
setup-was
Creates the WebSphere Portal enterprise application in WAS and performs any necessary WAS-related configuration for the WebSphere Portal application.
Usage:
Invoked as part of the WPSconfig script file. For example:
Inputs:
None
Assumptions/Prerequisites:
WAS must be running before this task is performed.
Error Conditions:
This task will fail if WAS is not running.
Task dependencies:
init
Tasks invoked:
action-create-appserver-wps, action-modify-as-attributes, action-deploy-ear-wps, action-modify-attributes-ear-wps, action-deploy-ear-wmm, action-create-jdbcprovider-wps, action-create-datasource-wps, action-create-datasource-wmm, action-set-shared-library, action-set-http-transport
start-admin-server
Starts the WAS administration server.
Usage:
Invoked to start the WAS administration server. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> start-admin-server
- From the user directory:
WPSconfig.sh start-admin-server
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WasAdminServer The WAS. WasHome The WAS install directory. WasUserid The user ID for WAS security authentication. WasPassword The password for WAS security authentication.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
None
Tasks invoked:
None
start-portal-server
Starts the WAS portal server.
Usage:
Invoked to start the WAS portal server. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> start-portal-server
- From the user directory:
WPSconfig.sh start-portal-server
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description ServerName The name of the application server where the WebSphere Portal enterprise application is deployed. This value must be unique among other application server names in the same cell. WasHome The WAS install directory. WasUserid The user ID for WAS security authentication WasPassword The password for WAS security authentication.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
None
Tasks invoked:
None
stop-admin-server
Stops the WAS administration server.
Usage:
Invoked to stop the WAS administration server. For example:
- From the product directory:
WPSconfig.sh -instance <instance> stop-admin-server
- From the user directory:
WPSconfig.sh stop-admin-server
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WasAdminServer The WAS. WasHome The WAS install directory. WasUserid The user ID for WAS security authentication WasPassword The password for WAS security authentication.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
None
Tasks invoked:
None
stop-portal-server
Stops the WAS portal server.
Usage:
Invoked to stop the WAS portal server. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> stop-portal-server
- From the user directory:
WPSconfig.sh stop-portal-server
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description ServerName The name of the application server where the WebSphere Portal enterprise application is deployed. This value must be unique among other application server names in the same cell. WasHome The WAS install directory. WasUserid The user ID for WAS security authentication WasPassword The password for WAS security authentication.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
None
Tasks invoked:
None
update-contentaccessservice-proxy
Configures the HTTP proxy used by Content Access Service. For more information about this service, see Content Access Service.
Usage:
Invoked to configure an HTTP proxy for Content Access Service. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> update-contentaccessservice-proxy
- From the user directory:
WPSconfig.sh update-contentaccessservice-proxy
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description ContentAccessServiceProxyHost The fully-qualified hostname of the proxy server that WebSphere Portal should use, if the security configuration includes a proxy server. ContentAccessServiceProxyPort The port number used to access the proxy server identified by the ContentAccessServiceProxyHost property.
Assumptions/Prerequisites:
For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions:
None
Task dependencies:
None
Tasks invoked:
None
update-wtp-translation
Updates the server and port information used to communicate with WebSphere Translation Server.
Usage:
Invoked as part of the WPSconfig script file. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> update-wtp-translation
- From the user directory:
WPSconfig.sh update-wtp-translation
Inputs:
This task takes the following inputs as defined in the MachineTranslationTranscoder.prop file:
Input Description WTSserverPortList List of WebSphere Translation Server machines with which WebSphere Portal can communicate.
This task takes the following inputs as defined in the wtp_cfg.xml file:
Input Description WTP_BASE_DIR Work directory for Transcoding Technology. For example, c:/websphere/portalserver/IBMTrans
Assumptions/Prerequisites:
Transcoding Technology and Translation Server are available.
Error Conditions:
This task will fail if the MachineTranslationTranscoder.prop file is not found.
Task dependencies:
None
Tasks invoked:
None
validate-database-connection-wmm
Check the connection to the WMM database.
Usage:
Invoked to validate the existence of and access rights to the WMM database. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> validate-database-connection-wmm
- From the user directory:
WPSconfig.sh validate-database-connection-wmm
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbDriver The classname of the JDBC driver. DbUser The database user. DbPassword The database user password. DbUrl The JDBC URL to the database.
Assumptions/Prerequisites:
The database must exist and the database client must be available.
Password considerations:
Typically, this task will be invoked passing -DDbPassword=DatabasePassword
Error Conditions:
The task will fail if the information in the properties file is invalid.
Task dependencies:
None
Tasks invoked:
None
validate-database-connection-wpcp
Check the connection to the WebSphere Portal content publishing database.
Usage:
Invoked to validate the existence of and access rights to the WebSphere Portal content publishing database. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> validate-database-connection-wpcp
- From the user directory:
WPSconfig.sh validate-database-connection-wpcp
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbDriver The classname of the JDBC driver. DbUser The database user. DbPassword The database user password. DbUrl The JDBC URL to the database.
Assumptions/Prerequisites:
The database must exist and the database client must be available.
Password considerations:
Typically, this task will be invoked passing -DDbPassword=DatabasePassword
Error Conditions:
The task will fail if the information in the properties file is invalid.
Task dependencies:
None
Tasks invoked:
None
validate-database-connection-wps
Check the connection to the WPS database.
Usage:
Invoked to validate the existence of and access rights to the WPS database. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> validate-database-connection-wps
- From the user directory:
WPSconfig.sh validate-database-connection-wps
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbDriver The classname of the JDBC driver. DbUser The database user. DbPassword The database user password. DbUrl The JDBC URL to the database.
Assumptions/Prerequisites:
The database must exist and the database client must be available.
Password considerations:
Typically, this task will be invoked passing -DDbPassword=DatabasePassword
Error Conditions:
The task will fail if the information in the properties file is invalid.
Task dependencies:
None
Tasks invoked:
None
validate-database-driver
Check the availability of the JDBC driver class.
Usage:
Invoked to validate the existence of and access rights to the JDBC driver archive. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> validate-database-driver
- From the user directory:
WPSconfig.sh validate-database-driver
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbDriver The classname of the JDBC driver. DbUser The database user. DbPassword The database user password. DbUrl The JDBC URL to the database.
Assumptions/Prerequisites:
The database client must be available.
Password considerations:
Typically, this task will be invoked passing -DDbPassword=DatabasePassword
Error Conditions:
The task will fail if the information in the properties file is invalid.
Task dependencies:
None
Tasks invoked:
None
validate-http-portal
Check the connection to WebSphere Portal using HTTP.
Usage:
Invoked to determine if WebSphere Portal is running.
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WpsHostName The fully qualified URL to WebSphere Portal. WpsHostPort The port used to connect to WebSphere Portal. WpsContextRoot The base URI in the WebSphere Portal URL ("wps" by default). WpsDefaultHome The final element in the WebSphere Portal URL ("portal" by default).
Assumptions/Prerequisites:
WebSphere Portal must be installed and running, and the correct information must be in the properties files.
Error Conditions:
The task will fail if the WebSphere Portal application server is not running, there is a port conflict with another application, or the URL cannot be resolved (DNS error, for example).
Task dependencies:
None
Tasks invoked:
None
validate-ldap
Check the connection to the LDAP server and check other LDAP properties in config file.
Usage:
Should be run before attempting to configure or modify the LDAP configuration. For example:
- From the product directory:
WPSconfig.sh -instance <instance> validate-ldap
- From the user directory:
WPSconfig.sh validate-ldap
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description LDAPHostName The fully qualified hostname of the LDAP server. LDAPPort The port used to connect to the LDAP directory. LDAPAdminUId The user id to be used to authenticate with the directory. LDAPAdminPwd The password for the user LDAPServerId.
Assumptions/Prerequisites:
The directory must be available and access must be permitted.
Password considerations:
Typically, this task will be invoked passing -DLDAPAdminPwd=LDAPAdminPassword
Error Conditions:
The task will fail if the information in the properties file is invalid or there are insufficient directory privileges.
Task dependencies:
None
Tasks invoked:
action-validate-ldap-connection, action-validate-ldap-suffix, action-validate-ldap-user
validate-wps-admin-login
This is a good diagnostic tool for checking the following:
- Checks if the WebSphere Portal Administrator has administrator privileges.
- Checks that HTTP transport, as defined in the wpconfig.properties file, is working. The task uses HTTP to access WebSphere Portal, therefore if the task succeeds WebSphere Portal is running and the settings in the properties file match the running configuration.
- Checks if the application server for WebSphere Portal is running.
- Checks authentication settings, if configured, when trying to access WebSphere Portal.
Usage:
Invoked to determine if the WebSphere Portal Administrator has administrator privileges. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> validate-wps-admin-login
- From the user directory:
WPSconfig.sh validate-wps-admin-login
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WpsHostName The fully-qualified URL to WebSphere Portal. WpsHostPort The port used to connect to WebSphere Portal. WpsContextRoot The base URI in the WebSphere Portal URL ("wps" by default). PortalAdminIdShort The WebSphere Portal admin user. PortalAdminPwd The WebSphere Portal admin user password.
Assumptions/Prerequisites:
WebSphere Portal is installed and running and the correct information is in the properties files.
Password considerations:
Typically, this task will be invoked passing -DPortalAdminPwd=PortalAdminPassword
Error Conditions:
The task will fail if:
- WebSphere_Portal application server is not running.
- Web server is not properly configured or is not running.
- There is a port conflict with another application, such as another HTTP server or service running on the machine.
- The URL cannot be resolved (DNS error, for example).
- The user does not exist.
- The user does not have administration privileges.
- The password is incorrect.
- Authentication is not configured properly.
Task dependencies:
None
Tasks invoked:
None
Content management tasks
The tasks below apply to the content management function provided in WebSphere Portal.
deploy-pdm-portlet
Deploys the Document Manager portlet into WebSphere Portal.
Usage:
Invoked to deploy the Document Manager portlet into WebSphere Portal. For example:
- From the product directory:
WPSconfig.sh -instance <instance> deploy-pdm-portlet
- From the user directory:
WPSconfig.sh deploy-pdm-portlet
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description PortalAdminIdShort The short form of the user ID for the WebSphere Portal administrator, as defined in the PortalAdminId property. PortalAdminPwd The password for the WebSphere Portal administrator, as defined in the PortalAdminId property. WpsHostName The fully-qualified host name of the Web server that WAS is configured to use. This value is set by the installation program based on user input during installation or on values in a response file. WpsContextRoot The context root or base URI for the portal. All URLs beginning with this path will be reserved for the portal. For example, http://hostname.yourco.com:80/wps/portal. WpsInstallLocation The directory where WebSphere Portal is installed. This value is set by the installation program based on user input during installation or on values in a response file.
Assumptions/Prerequisites:
None
Password considerations:
Typically, this task will be invoked passing -DPortalAdminPwd=PortalAdminPassword
Error Conditions:
The task will fail if portal server is not running.
Task dependencies:
None
Tasks invoked:
None
remove-wpcp-database
The main database removal task for database transfer.
Usage:
Invoked to remove a database during the database transfer process. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> remove-wpcp-database
- From the user directory:
WPSconfig.sh remove-wpcp-database
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WasHome WAS install directory. WasUserid The user ID for WAS security authentication. WasPassword The password for WAS security authentication. WpsInstallLocation The directory where WebSphere Portal is installed. WpcpDbName The name of the WebSphere Portal Content Publisher database. WpcpDbPassword The database password. WpcpDbUrl The JDBC URL to the database. WpcpDbUser The user ID for the database administrator. WpcpDbHostName Host where the database is installed. WpcpDbInstanceName (Informix only) For example, ol_myserver. WpcpDbPort (Informix only) Port number for the database software. WpcpDbPznadminPassword
(MS SQL Server and Oracle only)The password for the PZNADMIN user. DbType The type of database used with WebSphere Portal. ServerName The name of the application server where the WebSphere Portal enterprise application is deployed. This value must be unique among other application server names in the same cell. NodeName The node within the WAS cell to which the WebSphere Portal application server belongs (typically this value is the same as the host name for the computer).
Assumptions/Prerequisites:
None
Error Conditions:
This task will fail if the database software is not installed and running.
Task dependencies:
init, action-start-appserver, action-unbind-wpcp-library, action-uninstall-wpcp-runtime, action-remove-wpcp-datasources, action-remove-wpcp-jdbc, action-regen-plugin, action-stop-appserver, del-wpcp-instance, action-start-appserverpost
Tasks invoked:
None
remove-wpcp-databases-db2
Deletes the WebSphere Portal content publishing and Feedback databases.
Usage:
Invoked to delete the WebSphere Portal content publishing and Feedback databases. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> remove-wpcp-databases-db2
- From the user directory:
WPSconfig.sh remove-wpcp-databases-db2
Inputs:
This tasks takes the following inputs as defined in the wpconfig.properties file:
Input Description WpcpDbUser The user ID for the database administrator. WpcpDbName The name of the WebSphere Portal Content Publisher database WpcpDbNode (UNIX only) The node for the WebSphere Portal content publishing database. Must be set for all non-Windows platforms. WpcpXDbName The TCP/IP alias for the database. Must be set for all non-Windows platforms. This value is used to specify the data source on machines that are not running Windows 2000. FeedbackDbUser The Feedback database user. FeedbackDbName The name of the Feedback database. FeedbackXDbName (UNIX only) The TCP/IP alias for the Feedback database. This value is used to specify the data source on machines that are not running Windows 2000. Must be set for all non-Windows platforms.
Assumptions/Prerequisites:
None
Error Conditions:
This task will fail if the database software is not installed and running.
Task dependencies:
init
Tasks invoked:
remove-wpcp-wpcp-database-db2, remove-wpcp-feedback-database-db2
setup-wpcp
Configures WebSphere Portal content publishing, Document Manager, and WebSphere Portal.
Usage:
Invoked to perform all steps to configure WebSphere Portal content publishing, Document Manager, and WebSphere Portal. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> setup-wpcp
- From the user directory:
WPSconfig.sh setup-wpcp
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WasHome WAS install directory. WpsInstallLocation The directory where WebSphere Portal is installed. This value is set by the installation program based on user input during installation or on values in a response file. WasUserid The user ID for WAS security authentication. WasPassword The password for WAS security authentication. WpsContextRoot The context root or base URI for the portal. All URLs beginning with this path will be reserved for the portal. The value of this property is part of the URL used to access WebSphere Portal from a browser: http://<WpsHostName>:<WpsHostPort>/<WpsContextRoot>/<WpsDefaultHome>
WpsHostName The fully-qualified host name of the Web server that WAS is configured to use. This value is set by the installation program based on user input during installation: http://<WpsHostName>:<WpsHostPort>/<WpsContextRoot>/<WpsDefaultHome>
For example:http://hostname.yourco.com:80/wps/portal
WpsHostPort The port number used to access the host machine identified by the WpsHostName property: http://<WpsHostName>:<WpsHostPort>/<WpsContextRoot>/<WpsDefaultHome>
For example:http://hostname.yourco.com:80/wps/portal
DbDriverDs The data source for the JDBC provider that WebSphere Portal uses to communicate with its databases. ServerName The name of the application server where the WebSphere Portal enterprise application is deployed. This value must be unique among other application server names in the same cell. NodeName The node within the WAS cell to which the WebSphere Portal application server belongs (typically this value is the same as the host name for the computer). DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbUser The database user. DbPassword The database password used to access the WPS50 database with JDBC. DbUrl The database URL used to access the WPS50 database with JDBC. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located. DbType The type of database used with WebSphere Portal. WpcpDbPassword The database password. WpcpDbUser The user ID for the database administrator. WpcpDbName The name of the WebSphere Portal Content Publisher database. WpcpDbUrl The JDBC URL to the database. CellName The WAS cell to which the WAS belongs. VirtualHostName The name of the WAS virtual host. WpcpDbInstanceName (Informix only) Required for Informix only (for example, ol_myserver). WpcpDbPort (Informix only) The port used to access the WebSphere Portal content publishing database. WpcpDbHostName
(Informix and MS SQL Server only)Host name of the WebSphere Portal Content Publisher database. WpcpDbPznadminPassword
(MS SQL Server and Oracle only)The password for PZNADMIN user. FeedbackDbPassword
(MS SQL Server and Oracle only)The password for Enterprise Java Bean user.
Assumptions/Prerequisites:
None
Error Conditions:
None
Task dependencies:
init, cfg-wpcp-instance, action-wpcp-update-ear, cfg-access-control, action-install-wpcp-runtime, action-install-wpcp-authoring, action-install-wpcp-pdm, action-update-wpcp-war, action-wpcp-update-jvm, action-create-wpcp-jdbc, action-create-wpcp-datasources, action-create-wpcp-library, configure-wpcp-db, action-update-wcmprops
Tasks invoked:
None
wpcpconfigure
The main WebSphere Portal content publishing configuration task.
Usage:
Invoked to configure WebSphere Portal content publishing databases. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> wpcpconfigure
- From the user directory:
WPSconfig.sh wpcpconfigure
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbLibrary The directory path where the classes for the JDBC provider are located. WpsInstallLocation The directory where WebSphere Portal is installed. This value is set by the installation program based on user input during installation or on values in a response file WasHome WAS install directory. WasUserid The user ID for WAS security authentication. WasPassword The password for WAS security authentication. ServerName The name of the application server where the WebSphere Portal enterprise application is deployed. This value must be unique among other application server names in the same cell. NodeName The node within the WAS cell to which the WebSphere Portal application server belongs (typically this value is the same as the host name for the computer). CellName The WAS cell to which the WAS belongs. VirtualHostName The name of the WAS virtual host. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbDriverDs The data source for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbUser The database user. DbPassword The password to access the database. DbUrl The database URL used to access the WPS50 database with JDBC. DbLibrary The directory path where the classes for the JDBC provider are located. DbType The type of database used with WebSphere Portal. WpcpDbPassword The database password. WpcpDbUser The user ID for the database administrator. WpcpDbName The name of the WebSphere Portal Content Publisher database. WpcpDbUrl The JDBC URL to the database. WpcpDbInstanceName (Informix only) Required for Informix only (for example, ol_myserver). WpcpDbHostName
(Informix and MS SQL Server only)Host name of the WebSphere Portal Content Publisher database. WpcpDbPort (Informix only) The port used to access the WebSphere Portal content publishing database. WpcpDbPznadminPassword
(MS SQL Server and Oracle only)The password for PZNADMIN user. WpcpDbEjbPassword The password for EJB user. FeedbackDbInstanceName (Informix only) Required for Informix only (for example, ol_myserver). FeedbackDbPort (Informix only) The port used to access the WebSphere Portal content publishing Feedback database. FeedbackDbHostName
(Informix and MS SQL Server only)Host name of the WebSphere Portal content publishing Feedback database. FeedbackDbUrl The JDBC URL to the Feedback database. FeedbackDbUser The Feedback database user. FeedbackDbPassword
(MS SQL Server and Oracle only)The password for Enterprise Java Bean user.
Assumptions/Prerequisites:
Must have already run the other configuration tasks that set up the portal databases and install the portal server in WAS.
Error Conditions:
This task will fail if the other configuration tasks that set up the portal databases and install the portal server in WAS have not been run.
Task dependencies:
init, wpcp-database-cloudscape, setup-wpcp
Tasks invoked:
None
wpcpremove
This is the main WebSphere Portal content publishing removal task.
Usage:
Invoked to remove WebSphere Portal content publishing. For example:
- From the Product directory:
WPSconfig.sh -instance <instance> wpcpremove
- From the user directory:
WPSconfig.sh wpcpremove
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description WasHome WAS install directory. WpsInstallLocation The directory where WebSphere Portal is installed. This value is set by the installation program based on user input during installation or on values in a response file. WasUserid The user ID for WAS security authentication. WasPassword The password for WAS security authentication. WpsContextRoot The context root or base URI for the portal. All URLs beginning with this path will be reserved for the portal. The value of this property is part of the URL used to access WebSphere Portal from a browser: http://<WpsHostName>:<WpsHostPort>/<WpsContextRoot>/<WpsDefaultHome>
WpsHostName The fully-qualified host name of the Web server that WAS is configured to use. This value is set by the installation program based on user input during installation: http://<WpsHostName>:<WpsHostPort>/<WpsContextRoot>/<WpsDefaultHome>
For example:http://hostname.yourco.com:80/wps/portal
WpsHostPort The port number used to access the host machine identified by the WpsHostName property: http://<WpsHostName>:<WpsHostPort>/<WpsContextRoot>/<WpsDefaultHome>
For example:http://hostname.yourco.com:80/wps/portal
DbDriverDs The data source for the JDBC provider that WebSphere Portal uses to communicate with its databases. ServerName The name of the application server where the WebSphere Portal enterprise application is deployed. This value must be unique among other application server names in the same cell. NodeName The node within the WAS cell to which the WebSphere Portal application server belongs (typically this value is the same as the host name for the computer). DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. DbUser The database user. DbPassword The database password used to access the WPS50 database with JDBC. DbUrl The database URL used to access the WPS50 database with JDBC. DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located. DbType The type of database used with WebSphere Portal. WpcpDbPassword The database password. WpcpDbUser The user ID for the database administrator. WpcpDbName The name of the WebSphere Portal Content Publisher database. WpcpDbUrl The JDBC URL to the database. CellName The WAS cell to which the WAS belongs. VirtualHostName The name of the WAS virtual host. WpcpDbInstanceName (Informix only) Required for Informix only (for example, ol_myserver). WpcpDbPort (Informix only) The port used to access the WebSphere Portal content publishing database. WpcpDbHostName
(Informix and MS SQL Server only)Host name of the WebSphere Portal Content Publisher database. WpcpDbPznadminPassword
(MS SQL Server and Oracle only)The password for PZNADMIN user. FeedbackDbPassword
(MS SQL Server and Oracle only)The password for Enterprise Java Bean user.
Assumptions/Prerequisites:
None
Error Conditions:
None
Task dependencies:
init, action-remove-wpcp-library,
action-uninstall-wpcp-runtime, action-uninstall-wpcp-authoring,
action-uninstall-wpcp-pdm, action-remove-wpcp-datasources, action-remove-wpcp-jdbc, del-wpcp-instance, remove-access-control
Tasks invoked:
None
wpcp-database-db2_iseries
Configures the WebSphere Portal content publishing databases using DB2 for iSeries. Note that in the task name, "db2" is followed by an underscore rather than a dash.
Usage:
Invoked to configure WebSphere Portal content publishing databases using DB2 for iSeries. For example:
- From the product directory:
WPSconfig.sh -instance <instance> wpcp-database-db2_iseries
- From the user directory:
WPSconfig.sh wpcp-database-db2_iseries
Inputs:
This task takes the following inputs as defined in the wpconfig.properties file:
Input Description DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. WasUserHome WAS install directory. NodeName The node within the WebSphere Application Server cell to which the WebSphere Portal application server belongs (typically this value is the same as the host name for the computer). WpcpDbUrl The JDBC URL to the database. WpcpDbUser The WPCP/Feedback database user. Note: For db2_iseries, DbUser and WpcpDbUser must be set to two different values in the properties file. WpcpDbPassword The WPCP/Feedback database user's password. DbLibrary The directory path where the classes for the JDBC provider are located. DbType Type of DB to configure (db2_iseries). FeedbackDbUrl The JDBC URL to the Feedback database. WpcpDbName WPCP database name. WpcpSchema WPCP database schema. DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases. PznDbName Database name for Personalization. PznSchema Database schema for Personalization. PznDbUrl Database URL for Personalization FeedbackDbName Database name for feedback database. FeedbackSchema Database schema for feedback database. BrbDbName Database name for BrBreans database. BrbSchema Database schema for BrBreans database. BrbDbUrl Database URL for BrBeans database.
Assumptions/Prerequisites:
The database software must be installed and running.
Error Conditions:
The task will fail if the database software is not installed and running.
Task dependencies:
init, action-stop-wps, action-copy-cfg-files-wpcp, action-process-wpcp-dbfiles-db2_iseries, action-create-wpcp-database-db2_iseries, action-create-feedback-database-db2_iseries, action-populate-wpcp-database-db2_iseries, action-populate-feedback-database-db2_iseries
Tasks invoked:
None
See also