Configuration task reference

Configuration task reference

+
Search Tips | Advanced Search

How to use this topic
WebSphere Portal base tasks
action-empty-portal
action-modify-ports
action-precompile-jsp
action-start-application
action-stop-application
activate-portlets
archive-was-ext
backup-main-cfg-file
cleanup-work-dir
config-was-internal-http
connect-database
create-all-db
create-db2-database-jcr
create-local-database-db2
database-transfer
database-transfer-community
database-transfer-customization
database-transfer-feedback
database-transfer-jcr
database-transfer-likeminds
database-transfer-release
database-transfer-wmm
default
delegate-all-conversions
delegate-presentation-conversions
delegate-spreadsheet-conversions
delegate-text-conversions
delete-passwords
disable-page-as-extension-node
disable-page-as-page-task-container
disable-security
drop-database-wps
drop-tables-database-wps
drop-database-tables-domain-release
drop-database-tables-domain-customization
drop-database-tables-domain-community
drop-database-tables-domain-jcr
drop-database-tables-domain-wmm
drop-database-tables-domain-feedback
drop-database-tables-domain-likeminds
drop-database-tables-all
drop-wmm-db
enable-jcr-security
enable-page-as-extension-node
enable-page-as-task-page-container
enable-security-ldap
enable-security-wmmur-db
enable-security-wmmur-ldap
enable-security-wmmur-dmgr
feedback-database
init
lcc-configure-all
lcc-configure-quickplace
lcc-configure-sametime
lcc-configure-discoveryserver
lcc-configure-dominodirectory
modify-servlet-path
modify-wcm-host
populate-feedback-caltod-dbtype
portlets
portlets-admin
post-portal-node-federation-configuration
remove-conversion-delegation
remove-was-cfg
setup-feedback
setup-productivity-components
configure-transcoding
remove-transcoding
remove-wcm-persistence-tables
start-admin-server
start-portal-server
stop-admin-server
stop-portal-server
update-contentaccessservice-proxy
validate-database-connection-feedback
validate-database-connection-jcr
validate-database-connection-likeminds
validate-database-connection-wmm
validate-database-connection-wps
validate-database-driver
validate-http-portal
validate-ldap
validate-wmmur-ldap***
validate-wps-admin-login
disable-tam-userprov
enable-sm-authorization
enable-sm-all
enable-sm-tai
enable-tam-all
enable-tam-tai
enable-tam-authorization
enable-tam-userprov
run-svrssl-config
enable-tam-vault
validate-pdadmin-connection
Related information

All of these tasks assume that the WebSphere Portal installation program has been run, and the product files are available.
For i5/OS be sure all necessary portal profiles have been created.
The task dependencies listed for each task are executed when that specific task is run. The task dependencies are included for informational purposes only.

WebSphere Portal base tasks
External security manager tasks

How to use this topic

All configuration tasks must be run as root (UNIX) or as Administrator (Windows). The user running configuration tasks needs to have read, write, and execute permissions on the /PortalServer and /AppServer directories. For i5/OS have an OS/400 user profile of user type *SECOFR to configure WebSphere Portal.

The following files are referred to as WebSphere Portal configuration properties files:

wpconfig.properties Non-database related properties
wpconfig_dbdomain.properties Database domain specific properties
wpconfig_dbtype.properties Database type specific properties

For database related properties: depending on which database has to be configured, dbdomain has to be replaced by...

release
customization
community
jcr
likeminds
feedback
wmm

...depending on which database type is used, dbtype has to be replaced by:

cloudscape
db2
oracle
sqlserver
db2_zos
db2_iseries

WebSphere Portal base tasks

Base tasks are invoked by running the WPSconfig script...
WPSconfig.sh -Dproperty1=value1 -Dproperty2=value2 task-name-goes-here

For security reasons, you should not leave passwords in the WebSphere Portal configuration properties files. IBM recommends that you choose one of the following options:

Edit the WebSphere Portal configuration properties files 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 WebSphere Portal configuration properties files.

Alternatively, we can specify the required passwords on the command line rather than update the WebSphere Portal configuration properties files.
WPSconfig.sh -profileName profile task -DPasswordProperty=password

For example...
WPSconfig.sh -profileName wp_profile 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 WebSphere Portal configuration properties files are automatically removed after configuration.

action-empty-portal

Post-install and configuration task that removes WebSphere Portal artifacts that were placed during the archive install. Can be run manually immediately after a successful WebSphere Portal install.
This configuration task is only supported when you are planning to import another WebSphere Portal environment.
This configuration task is NOT supported if you intend to do any of the following:

Clean up WebSphere Portal of its default applications
Improve startup performance
Deploy only administrative portlets using portlets-admin task
Start with a clean Portal to deploy only your applications.
The 'action-empty-portal' task removes all portal artifacts, some of which are needed for normal WebSphere Portal operation. The only way to recover these artifacts is to import another portal's configuration.
Invoke as part of the WPSconfig script file. For example:

UNIX/Windows:

./WPSconfig.sh|bat action-empty-portal

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile action-empty-portal

This task takes the following inputs passed with the command line:

Input Description
PortalAdminIdShort The short name for the administrator id.
PortalAdminPwd Administrator password.

Assumptions/Prerequisites: No custom configuration has been applied after installation.
Error Conditions: None
Task dependencies: None
Tasks invoked:
start-portal-server: WebSphere Portal must be running in order to invoke the XMLAccess tool.

action-modify-ports

Modifies ports. Validation is not done on the ports to check for port conflicts.
Invoke as part of the WPSconfig script file. For example:
Using start port:
./WPSconfig.sh action-modify-ports-by-startport \ -DModifyPortsServer=server1 \ -DStartPort=20000 ./WPSconfig.sh action-modify-ports-by-startport \ -DModifyPortsServer=WebSphere_Portal \ -DStartPort=20000

Using ports file:
./WPSconfig.sh action-modify-ports-by-portsfile \ -DModifyPortsServer=server1 \ -DPortsFile=/tmp/WPDefaultPortsFile.props ./WPSconfig.sh action-modify-ports-by-portsfile \ -DModifyPortsServer=WebSphere_Portal \ -DPortsFile=/tmp/WPDefaultPortsFile.props

This task takes the following inputs passed with the command line:

Input Description
ModifyPortsServer The server on which the ports should be modified.
StartPort The starting port block value.
PortsFile The full path to the file with the port name and the value pairs.
Assumptions/Prerequisites: The WebSphere Portal properties file, wpconfig.properties must contain the following:

Input Description
WpsInstallLocation WebSphere Portal install location.
NodeName The node on which you are modifying ports.

Password considerations: None
Error conditions: None
Task dependencies: None
Tasks invoked:
action-modify-ports-by-startport, action-modify-ports-by-portsfile

action-precompile-jsp

Post-install task that pre-compiles all the JSP pages in the WebSphere Portal Server. Running this task manually improves (decrease) the initial load times of the WebSphere Portal pages.
Invoked manually post-install as part of the WPSconfig script file. For example:
./WPSconfig.sh action-precompile-jsp

i5/OS:
From the UserData directory:

WPSconfig.sh -profileNameprofile action-precompile-jsp -DApplication=Name

Inputs: None
Assumptions/Prerequisites: None
Password considerations: None
Error Conditions: None
Task dependencies: None
Task invoked: None

action-start-application
Starts an application installed or mapped to WebSphere_Portal server.
This task calls only wsadmin it does not update the WebSphere Portal database and registries. If you run the task from WAS, the start status may not display in the manage applications and manage portlets pages. If you start it in WAS there is no update in WebSphere Portal.
Invoke as part of the WPSconfig script file. For example:

./WPSconfig.sh action-start-application -DApplication=Name

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile action-start-application -DApplication=Name

This task takes the following inputs passed with the command line:

Input Description
Application Application name to be started.

Assumptions/Prerequisites: Use with single WAS installation.
Password considerations: Typically, this task will be invoked passing -DWasPassword=password
Error Conditions: None
Task dependencies: None
Tasks invoked: None

action-stop-application
Stops an application installed or mapped to WebSphere_Portal server.
This task calls only wsadmin it does not update the WebSphere Portal database and registries. If you run the task from WAS, the stopped status may not display in the manage applications and manage portlets pages. If you stop it in WAS there is no update in WebSphere Portal.
Invoke as part of the WPSconfig script file. For example:

./WPSconfig.sh action-stop-application -DApplication=Name

i5/OS:
From the UserData directory:

WPSconfig.sh -profileName profile action-stop-application -DApplication=Name

This task takes the following inputs passed with the command line:

Input Description
Application Application name to be stopped.

Assumptions/Prerequisites: Use with single WAS installation.
Password considerations: Typically, this task will be invoked passing -DWasPassword=password
Error Conditions: None
Task dependencies: None
Tasks invoked: None

activate-portlets

Activates the deployed portlets in a cluster.
If you run the activate-portlets task while you are logged in to WebSphere Portal, log out and log back in before we can see the updated status for the portlets.
Invoked to activate deployed portlets. For example:

./WPSconfig.sh activate-portlets

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile activate-portlets

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
dbdomain.DbType Type of database used with WebSphere Portal dbdomain database.
dbdomain.DbName Name of the WebSphere Portal dbdomain database
dbdomain.DbUrl Databasebase URL used to access the WebSphere Portal dbdomain database with JDBC.
dbdomain.DbUser WebSphere Portal dbdomain database user.
dbdomain.DbPassword WebSphere Portal dbdomain database user password.

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
PortalAdminId User ID for the WebSphere Portal Administrator
PortalAdminPwd The password for the WebSphere Portal Administrator

Assumptions/Prerequisites: The Portal Server must be up and running when this command is invoked. Password considerations: Typically, this task will be invoked passing

-DPortalAdminPwd=password

Error Conditions: This task will fail if the Portal Server is not running.
Task dependencies: None
Tasks invoked:
action-export-all-portlets, action-transform-activate-scripts, action-full-sync-nodes, action-start-all-portlets

archive-was-ext

This task is only required in a clustered environment when using Member Manager user registry security mode. This task archives Member Manager binaries and WebSphere Portal scripting prerequisites from the WebSphere Portal system into...
portal_server_root/config/work/wasextarchive.jar

If there is an existing wasextarchive.jar file in the output directory, it will be deleted first before the new file is created.
The archive must then be manually copied and unarchived on the WebSphere Portal Network Deployment system before enabling security using the Member Manager user registry mode on a federated node. The archive also needs to be copied and unarchived on other WebSphere Portal only nodes in the cell which has Member Manager user registry security mode enabled.
Invoked as part of the WPSconfig script file. For example:

./WPSconfig.sh archive-was-ext

Inputs: None.
Assumptions/Prerequisites: None.
Password considerations: None.
Error Conditions: None.
Task dependencies: None.
Tasks invoked:
None.

backup-main-cfg-file

Makes a backup copy of the WebSphere Portal configuration properties files. This task can be performed at any time to retain a version of the properties used during configuration.
Invoked as part of the WPSconfig script file. For example:

./WPSconfig.sh backup-main-cfg-file

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile backup-main-cfg-file

Inputs: None
Assumptions/Prerequisites: The backup copy of the file is named...
wpconfig.properties_timestamp
wpconfig_dbdomain.properties_timestamp
wpconfig_dbtype.properties_timestamp

...where timestamp indicates the time the copy was made. For example...
wpconfig.properties_yyyy-mm-dd-hh-mm.properties

Error Conditions: This task will fail if the WebSphere Portal configuration properties files cannot be found.
Task dependencies: None
Tasks invoked: None

cleanup-work-dir

Performs cleanup of working config files.
Deletes working config files for security or to save disk space. For example:

./WPSconfig.sh cleanup-work-dir

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile 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.
Changes the WpsHostPort to the WAS internal transport port. For example:

./WPSconfig.sh config-was-internal-http

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile 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

connect-database

Connects the database for clustered installation by removing the old datasources and JDBC providers and creating new datasources and JDBC providers. The required JNDI links are updated.
Invoked to connect the database for clustered installation. For example:

./WPSconfig.sh connect-database

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.
dbtype.JdbcProviderName Name of the JDBC Provider to be used.
This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
dbdomain.DbType Type of database to configure:

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

dbdomain.DbName Name of the WebSphere Portal database.
dbdomain.DbSchema Databasebase schema WebSphere Portal name.
dbdomain.DataSourceName Name of the datasource to be used for WebSphere Portal database.
dbdomain.XDbName Required for Non-Windows platforms when using DB2 only. The name of the Windows database loop back alias.
dbdomain.DbNode Required for Non-Windows platforms when using DB2 only. The node for the Windows database.
dbdomain.DbUrl The URL used to access the WebSphere Portal database with JDBC.
dbdomain.DbUser WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
dbdomain.DbPassword WebSphere Portal database administrator password.

Assumptions/Prerequisites: None
Error Conditions: None
Task dependencies: init
Tasks invoked:
action-remove-datasource-foundation action-remove-jdbcprovider-foundation connect-database-pzn connect-database-content-management action-create-jdbcprovider-foundation action-create-datasource-foundation action-modify-attributes-ear-wmm-jndi-wmm-ds action-modify-attributes-ear-wps-jndi-wps-ds action-modify-scheduler-cleanup-daemon-jndi-wps-ds action-config-portal-transfer action-set-shared-library action-stop-node-manager action-start-node-manager

create-all-db

Creates the WebSphere Portal and WMM databases for DB2 only.
Invoked to create the WebSphere and WMM databases for use with DB2. For example:

./WPSconfig.sh create-all-db

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile create-all-db

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
db2.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
db2.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.
db2.JdbcProviderName Name of the JDBC Provider to be used.

The following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
dbdomain.DbType Type of database used withWebSphere Portal dbdomain database.
dbdomain.DbName Name of the WebSphere Portal dbdomain database.
dbdomain.DbSchema WebSphere Portal dbdomain database schema name.
dbdomain.DataSourceName Name of datasource to be used for WebSphere Portal dbdomain database
dbdomain.DbUrl Databasebase URL used to access the WebSphere Portal dbdomain database with JDBC.
dbdomain.DbUser WebSphere Portal dbdomain database user.
dbdomain.DbPassword WebSphere Portal dbdomain database user password.
dbdomain.XDbName Required for Non-Windows platforms when using DB2 only. The name of the WebSphere Portal dbdomain database loop back alias.
dbdomain.DbNode Required for Non-Windows platforms when using DB2 only. The node for the WebSphere Portal dbdomain database.

Assumptions/Prerequisites: None Password considerations: Typically, this task will be invoked passing

-Drelease.DbPassword=password

-Dcustomization.DbPassword=password

-Dcommunity.DbPassword=password

-Djcr.DbPassword=password

-Dwmm.DbPassword=password

Error Conditions: None
Task dependencies: None
Tasks invoked: None

create-db2-database-jcr

Creates a DB2 Content Manager Runtime Edition database in a local DB2 installation to store Document Manager, Personalization, and Feedback data.
Invoked to create a local DB2 Content Manager Runtime Edition DB2 database. For example:

./WPSconfig.sh create-db2-database-jcr

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.
JcrDbUrl The JDBC URL to the DB2 Content Manager Runtime Edition database.
JcrDbUser The DB2 Content Manager Runtime Edition database user.
JcrDbPassword The DB2 Content Manager Runtime Edition database user password.
DbType Type of database used with WebSphere Portal.

Assumptions/Prerequisites: Must have DB2 installed and running.
Password considerations: Typically, this task will be invoked passing -DJcrDbPassword=password
Error Conditions: The task will fail if DB2 is not installed and running.
Task dependencies: None
Tasks invoked:
None

create-local-database-db2

Creates all the local DB2 databases used with WebSphere Portal and Personalization.
Invoked for convenience to automatically create the local DB2 databases. For example:

UNIX :
./WPSconfig.sh create-local-database-db2

Windows:
WPSconfig.bat create-local-database-db2

Inputs: None
Assumptions/Prerequisites: DB2 must be installed locally. For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task.
Error Conditions: Task will fail if DB2 is not installed.
Task dependencies: init
Tasks invoked: None

database-transfer

Transfers existing data from one supported database to another.
Invoked to transfer existing data from one, more than one, or all source databases. For example, to transfer all source databases:

./WPSconfig.sh database-transfer

i5/OS.

WPSconfig.sh -profileName profile database-transfer

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.
dbtype.JdbcProviderName Name of the JDBC Provider to be used.
This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
dbdomain.DbType Type of database to configure:

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

dbdomain.DbName Name of the WebSphere Portal database.
dbdomain.DbSchema Databasebase schema WebSphere Portal name.
dbdomain.DataSourceName Name of the datasource to be used for WebSphere Portal database.
dbdomain.XDbName Required for Non-Windows platforms when using DB2 only. The name of the Windows database loop back alias.
dbdomain.DbNode Required for Non-Windows platforms when using DB2 only. The node for the Windows database.
dbdomain.DbUrl The URL used to access the WebSphere Portal database with JDBC.
dbdomain.DbUser WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
dbdomain.DbPassword WebSphere Portal database administrator password.
This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
WasPassword
The password for WAS security authentication.
If a value is specified for WasPassword, a value must also be specified for WasUserid. If WasPassword is left blank, WasUserid must also be left blank.
Value type: Alphanumeric text string
Recommended: Set this value according to your own environment.
Default: ReplaceWithYourWASUserPwd

Assumptions/Prerequisites: None
Error Conditions: If you have configured security while configuring to use a database other than Cloudscape, do not run the database-transfer task a second time. This task will not transfer the data inserted during the enable-security task, and will cause the Portal to become inoperable. To recover from this situation, you would have to disable and re-enable security.
Task dependencies: init, stop-portal-server
Tasks invoked:
action-database-transfer-export-wps, action-remove-datasource-wps, action-remove-datasource-wmm, action-remove-jdbcprovider-wps

database-transfer-community

Transfers WebSphere Portal data (user data and user objects) from one supported database to another.
During Portal basic configuration, data is installed to Cloudscape. This task transfers data to a production database of a different type.

UNIX :
./WPSconfig.sh database-transfer-community

Windows:
WPSconfig.bat database-transfer-community

This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
community.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

community.DbLibrary Directory path where the classes for the JDBC provider are located.
community.DbUrl The URL used to access the WebSphere Portal database with JDBC.
community.DbName Name of the WebSphere Portal database for WebSphere Portal tables.
community.DbUser WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
community.DbPassword WebSphere Portal database administrator password.

Additionally, this task takes the following inputs as defined in the wpconfig_sourceDb.properties file. These values should point to the database from which you are transferring the data:

Input Description
source.community.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

source.community.DbLibrary Directory path where the classes for the JDBC provider are located.
source.community.DbUrl The URL used to access the WebSphere Portal database with JDBC.
source.community.DbName Name of the WebSphere Portal database for WebSphere Portal tables.
source.community.DbUser WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
source.community.DbPassword WebSphere Portal database administrator password.

Assumptions/Prerequisites: WebSphere Portal database exists currently in the source database. For databases other than local DB2, the database must have been created according to specifications in the information center and accessible during the transfer process.
Error Conditions: Database not accessible.
Task dependencies: init
Tasks invoked:
None

database-transfer-customization

Transfers WebSphere Portal data (user data and user objects) from one supported database to another.
During Portal basic configuration, data is installed to Cloudscape. This task transfers data to a production database of a different type.

UNIX :
./WPSconfig.sh database-transfer-customization

Windows:
WPSconfig.bat database-transfer-customization

This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
customization.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

customization.DbLibrary Directory path where the classes for the JDBC provider are located.
customization.DbUrl The URL used to access the WebSphere Portal database with JDBC.
customization.DbName Name of the WebSphere Portal database for WebSphere Portal tables.
customization.DbUser WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
customization.DbPassword WebSphere Portal database administrator password.

Additionally, this task takes the following inputs as defined in the wpconfig_sourceDb.properties file. These values should point to the database from which you are transferring the data:

Input Description
source.customization.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

source.customization.DbLibrary Directory path where the classes for the JDBC provider are located.
source.customization.DbUrl The URL used to access the WebSphere Portal database with JDBC.
source.customization.DbName Name of the WebSphere Portal database for WebSphere Portal tables.
source.customization.DbUser WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
source.customization.DbPassword WebSphere Portal database administrator password.

Assumptions/Prerequisites: WebSphere Portal database exists currently in the source database. For databases other than local DB2, the database must have been created according to specifications in the information center and accessible during the transfer process.
Error Conditions: Database not accessible.
Task dependencies: init
Tasks invoked:
None

database-transfer-feedback

Transfers Feedback data (user data and user objects) from one supported database to another.
During Portal basic configuration, data is installed to Cloudscape. This task transfers data to a production database of a different type.

UNIX :
./WPSconfig.sh database-transfer-feedback

Windows:
WPSconfig.bat database-transfer-feedback

This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
feedback.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

feedback.DbLibrary Directory path where the classes for the JDBC provider are located.
feedback.DbUrl The URL used to access the Feedback database with JDBC.
feedback.DbName Name of the WebSphere Portal database for Feedback tables.
feedback.DbUser The Feedback database administrator UserID, which is also used as the schema name for the Feedback's tables and database resources.
feedback.DbPassword The Feedback database administrator password.

Additionally, this task takes the following inputs as defined in the wpconfig_sourceDb.properties file. These values should point to the database from which you are transferring the data:

Input Description
source.feedback.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

source.feedback.DbLibrary Directory path where the classes for the JDBC provider are located.
source.feedback.DbUrl The URL used to access the Feedback database with JDBC.
source.feedback.DbName Name of the WebSphere Portal database for Feedback tables.
source.feedback.DbUser The Feedback database administrator UserID, which is also used as the schema name for the Feedback's tables and database resources.
source.feedback.DbPassword The Feedback database administrator password.

Assumptions/Prerequisites: Feedback database exists currently in the source database. For databases other than local DB2, the database must have been created according to specifications in the information center and accessible during the transfer process.
Error Conditions: Database not accessible.
Task dependencies: init
Tasks invoked:
None

database-transfer-jcr

Transfers DB2 Content Manager Runtime Edition data (user data and user objects) from one supported database to another.
During Portal basic configuration, data is installed to Cloudscape. This task transfers data to a production database of a different type.

UNIX :
./WPSconfig.sh database-transfer-jcr

Windows:
WPSconfig.bat database-transfer-jcr

This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
jcr.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

jcr.DbLibrary Directory path where the classes for the JDBC provider are located.
jcr.DbUrl The URL used to access the DB2 Content Manager Runtime Edition database with JDBC.
jcr.DbName Name of the WebSphere Portal database for DB2 Content Manager Runtime Edition tables.
jcr.DbUser 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.
jcr.DbPassword The DB2 Content Manager Runtime Edition database administrator password.

Additionally, this task takes the following inputs as defined in the wpconfig_sourceDb.properties file. These values should point to the database from which you are transferring the data:

Input Description
source.jcr.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

source.jcr.DbLibrary Directory path where the classes for the JDBC provider are located.
source.jcr.DbUrl The URL used to access the DB2 Content Manager Runtime Edition database with JDBC.
source.jcr.DbName Name of the WebSphere Portal database for DB2 Content Manager Runtime Edition tables.
source.jcr.DbUser 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.
source.jcr.DbPassword The DB2 Content Manager Runtime Edition database administrator password.

Assumptions/Prerequisites: DB2 Content Manager Runtime Edition database exists currently in the source database. For databases other than local DB2, the database must have been created according to specifications in the information center and accessible during the transfer process.
Error Conditions: Database not accessible.
Task dependencies: init
Tasks invoked:
None

database-transfer-likeminds

Transfers LikeMinds data (user data and user objects) from one supported database to another.
During Portal basic configuration, data is installed to Cloudscape. This task transfers data to a production database of a different type.

UNIX :
./WPSconfig.sh database-transfer-likeminds

Windows:
WPSconfig.bat database-transfer-likeminds

This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
likeminds.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

likeminds.DbLibrary Directory path where the classes for the JDBC provider are located.
likeminds.DbUrl The URL used to access the LikeMinds database with JDBC.
likeminds.DbName Name of the WebSphere Portal database for LikeMinds tables.
likeminds.DbUser The LikeMinds database administrator UserID, which is also used as the schema name for the LikeMinds's tables and database resources.
likeminds.DbPassword The LikeMinds database administrator password.

Additionally, this task takes the following inputs as defined in the wpconfig_sourceDb.properties file. These values should point to the database from which you are transferring the data:

Input Description
source.likeminds.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

source.likeminds.DbLibrary Directory path where the classes for the JDBC provider are located.
source.likeminds.DbUrl The URL used to access the LikeMinds database with JDBC.
source.likeminds.DbName Name of the WebSphere Portal database for LikeMinds tables.
source.likeminds.DbUser The LikeMinds database administrator UserID, which is also used as the schema name for the LikeMinds's tables and database resources.
source.likeminds.DbPassword The LikeMinds database administrator password.

Assumptions/Prerequisites: LikeMinds database exists currently in the source database. For databases other than local DB2, the database must have been created according to specifications in the information center and accessible during the transfer process.
Error Conditions: Database not accessible.
Task dependencies: init
Tasks invoked:
None

database-transfer-release

Transfers WebSphere Portal data (user data and user objects) from one supported database to another.
During Portal basic configuration, data is installed to Cloudscape. This task transfers data to a production database of a different type.

UNIX :
./WPSconfig.sh database-transfer-release

Windows:
WPSconfig.bat database-transfer-release

This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
release.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

release.DbLibrary Directory path where the classes for the JDBC provider are located.
release.DbUrl The URL used to access the WebSphere Portal database with JDBC.
release.DbName Name of the WebSphere Portal database for WebSphere Portal tables.
release.DbUser WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
release.DbPassword WebSphere Portal database administrator password.

Additionally, this task takes the following inputs as defined in the wpconfig_sourceDb.properties file. These values should point to the database from which you are transferring the data:

Input Description
source.release.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

source.release.DbLibrary Directory path where the classes for the JDBC provider are located.
source.release.DbUrl The URL used to access the WebSphere Portal database with JDBC.
source.release.DbName Name of the WebSphere Portal database for WebSphere Portal tables.
source.release.DbUser WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
source.release.DbPassword WebSphere Portal database administrator password.

Assumptions/Prerequisites: WebSphere Portal database exists currently in the source database. For databases other than local DB2, the database must have been created according to specifications in the information center and accessible during the transfer process.
Error Conditions: Database not accessible.
Task dependencies: init
Tasks invoked:
None

database-transfer-wmm

Transfers Member Manager data (user data and user objects) from one supported database to another.
During Portal basic configuration, data is installed to Cloudscape. This task transfers data to a production database of a different type.

UNIX :
./WPSconfig.sh database-transfer-wmm

Windows:
WPSconfig.bat database-transfer-wmm

This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
wmm.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

wmm.DbLibrary Directory path where the classes for the JDBC provider are located.
wmm.DbUrl The URL used to access the Member Manager database with JDBC.
wmm.DbName Name of the Member Manager database for Member Manager tables.
wmm.DbUser The Member Manager database administrator UserID, which is also used as the schema name for the Member Manager 's tables and database resources.
wmm.DbPassword The Member Manager database administrator password.

Additionally, this task takes the following inputs as defined in the wpconfig_sourceDb.properties file. These values should point to the database from which you are transferring the data:

Input Description
source.wmm.DbType Type of database to configure

cloudscape
db2
db2_iseries
db2_zos
oracle
sqlserver

source.wmm.DbLibrary Directory path where the classes for the JDBC provider are located.
source.wmm.DbUrl The URL used to access the Member Manager database with JDBC.
source.wmm.DbName Name of the Member Manager database for Member Manager tables.
source.wmm.DbUser The Member Manager database administrator UserID, which is also used as the schema name for the Member Manager 's tables and database resources.
source.wmm.DbPassword The Member Manager database administrator password.

Assumptions/Prerequisites: Member Manager database exists currently in the source database. For databases other than local DB2, the database must have been created according to specifications in the information center and accessible during the transfer process.
Error Conditions: Database not accessible.
Task dependencies: init
Tasks invoked:
None

default

Displays information explaining how the WebSphere Portal configuration program should be invoked.
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:

./WPSconfig.sh default

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile default

Inputs: None
Assumptions/Prerequisites: None
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

delegate-all-conversions

Delegates all file conversion services to a remote machine
Call this optional task if you want all document conversions to be performed on a remote machine. Install the DCS web application on the remote server.

./WPSconfig.sh delegate-all-conversions

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
DcsRemoteHost The URL of the remote host that provides document conversion services.

Assumptions/Prerequisites: DCS services have been installed on the remote machine. (This is not a requirement for the configuration task itself but will be necessary before we can use document conversion services.)
Password considerations: None
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

delegate-presentation-conversions

Delegates presentation file conversion services to a remote machine.
Call this optional task if you want presentation document conversions (such as Microsoft PowerPoint to Portal Presentation and vice versa) to be performed on a remote machine. Note that install the DCS web application on the remote server.

UNIX:

./WPSconfig.sh delegate-presentation-conversions

Windows:
WPSconfig.bat delegate-presentation-conversions

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
DcsRemoteHost The URL of the remote host that provides document conversion services.

Assumptions/Prerequisites: DCS services have been installed on the remote machine. (This is not a requirement for the configuration task itself but will be necessary before we can use document conversion services.)
Password considerations: None
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

delegate-spreadsheet-conversions

Delegates spreadsheet file conversion services to a remote machine
Call this optional task if you want spreadsheet document conversions (such as MS Excel to Portal Spreadsheet and vice versa) to be performed on a remote machine. Note that install the DCS web application on the remote server.

UNIX:

./WPSconfig.sh delegate-spreadsheet-conversions

Windows:
WPSconfig.bat delegate-spreadsheet-conversions

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
DcsRemoteHost The URL of the remote host that provides document conversion services.

Assumptions/Prerequisites: DCS services have been installed on the remote machine. (This is not a requirement for the configuration task itself but will be necessary before we can use document conversion services.)
Password considerations: None
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

delegate-text-conversions

Delegates text file conversion services to a remote machine
Call this optional task if you want text document conversions (such as MS Word to Portal Text and vice versa) to be performed on a remote machine. Note that install the DCS web application on the remote server.

UNIX:

./WPSconfig.sh delegate-text-conversions

Windows:
WPSconfig.bat delegate-text-conversions

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
DcsRemoteHost The URL of the remote host that provides document conversion services.

Assumptions/Prerequisites: DCS services have been installed on the remote machine. (This is not a requirement for the configuration task itself but will be necessary before we can use document conversion services.)
Password considerations: None
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

delete-passwords

Removes passwords from the WebSphere Portal configuration properties file.
Invoked to remove passwords from the wpconfig.properties file for security reasons. Passwords must be restored before running additional configuration tasks.
Passwords must also be restored to any backup properties files you have created. For example:

UNIX :
./WPSconfig.sh delete-passwords

Windows:
WPSconfig.bat delete-passwords

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile 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

disable-page-as-extension-node

Disables a page as an extension node.
Invoked to delete an extension node.

./WPSconfig.sh disable-page-as-extension-node -DPageUniqueName=value

This task takes the following input as defined in the wpconfig.properties file:

Input Description
PageUniqueName The unique name of the page to be affected.

Assumptions/Prerequisites: None
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

disable-page-as-page-task-container

Disables the parent page of the dynamically created task page instance.
Invoked to delete a task page container.

UNIX:

./WPSconfig.sh disable-page-as-task-page-container -DPageUniqueName=value

Windows:
WPSconfig.bat disable-page-as-task-page-container -DPageUniqueName=value

This task takes the following input as defined in the wpconfig.properties file:

Input Description
PageUniqueName The unique name of the page to be affected.

Assumptions/Prerequisites: None
Error Conditions: None
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 Member Manager database.

drop-database-wps
Completely drop the wpsdb and JCR databases. This task drops the databases and any tables.
This task is only applicable to DB2 UDB for UNIX, Windows, and Linux. For a remote DB2 for iSeries database, remove it by following the instructions found here.
Invoked to completely erase the DB2 database. For example:

UNIX :
./WPSconfig.sh drop-database-wps

Windows:
WPSconfig.bat drop-database-wps

i5/OS For a local DB2 for iSeries wpsdb and JCR database:

From the User directory:
WPSconfig.sh -profileName profile drop-database-wps

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal l uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
dbdomain.DbType Type of database used with WebSphere Portal dbdomain database.
dbdomain.DbName Name of the WebSphere Portal dbdomain database
dbdomain.DbSchema WebSphere Portal dbdomain database schema name
dbdomain.DbUrl Databasebase URL used to access the WebSphere Portal dbdomain database with JDBC.
dbdomain.DbUser WebSphere Portal dbdomain database user.
dbdomain.DbPassword WebSphere Portal dbdomain database user password.

Assumptions/Prerequisites: For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task. Password considerations: Typically, this task will be invoked passing

-Drelease.DbPassword=password

-Dcustomization.DbPassword=password

-Dcommunity.DbPassword=password

-Djcr.DbPassword=password

Error Conditions: None Task dependencies:

init

action-drop-wps-db-mp

action-drop-wps-db-iseries

Tasks invoked:
None

drop-tables-database-wps

Cleans the tables from the wpsdb database. This task drops the tables that are used to manage the configuration domains for the following four specific domains: release, customization, community and jcr. Run this task only if you want to drop all four of these domains. To drop the jcr tables that contain user data, refer to the drop-database-tables-domain-jcr task.
Invoked to erase the database tables. For example:

UNIX :
./WPSconfig.sh drop-tables-database-wps

Windows:
WPSconfig.bat drop-tables-database-wps

i5/OS:

From the User directory:
WPSconfig.sh -profileName profile drop-tables-database-wps

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
DbType Type of database used with WebSphere Portal.
DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
WpsDbName Name of the Wps database.
WpsDbUrl Databasebase URL used to access the wpsdb database with JDBC.
WpsDbUser The database user.
WpsDbPassword 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.

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
dbdomain.DbType Type of database used with WebSphere Portal dbdomain database.
dbdomain.DbName Name of the WebSphere Portal dbdomain database
dbdomain.DbUrl Databasebase URL used to access the WebSphere Portal dbdomain database with JDBC.
dbdomain.DbUser WebSphere Portal dbdomain database user.
dbdomain.DbPassword WebSphere Portal dbdomain database user password.

Assumptions/Prerequisites: For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task. Password considerations: Typically, this task will be invoked passing

-Drelease.DbPassword=password

-Dcustomization.DbPassword=password

-Dcommunity.DbPassword=password

-Djcr.DbPassword=password

Error Conditions: None
Task dependencies: init
Tasks invoked: None

drop-database-tables-domain-release

Cleans the tables from the release database.
Invoked to erase the database tables. For example:

UNIX :
./WPSconfig.sh drop-database-tables-domain-release

Windows:
WPSconfig.bat drop-database-tables-domain-release

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile drop-database-tables-domain-release

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
release.DbType Type of database used with the release database.
release.DbName Name of the release database
release.DbUrl Databasebase URL used to access the release database with JDBC.
release.DbUser The release database user.
release.DbPassword The release database user password.

Assumptions/Prerequisites: None Password considerations: Typically, this task will be invoked passing

-Drelease.DbPassword=password

Error Conditions: None
Task dependencies: init
Tasks invoked: None

drop-database-tables-domain-customization

Cleans the tables from the customization database.
Invoked to erase the database tables. For example:

UNIX :
./WPSconfig.sh drop-database-tables-domain-customization

Windows:
WPSconfig.bat drop-database-tables-domain-customization

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile drop-database-tables-domain-customization

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
customization.DbType Type of database used with the customization database.
customization.DbName Name of the customization database
customization.DbUrl Databasebase URL used to access the customization database with JDBC.
customization.DbUser The customization database user.
customization.DbPassword The customization database user password.

Assumptions/Prerequisites: None Password considerations: Typically, this task will be invoked passing

-Dcustomization.DbPassword=password

Error Conditions: None
Task dependencies: init
Tasks invoked: None

drop-database-tables-domain-community

Cleans the tables from the community database.
Invoked to erase the database tables. For example:

UNIX :
./WPSconfig.sh drop-database-tables-domain-community

Windows:
WPSconfig.bat drop-database-tables-domain-community

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile drop-database-tables-domain-community

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
community.DbType Type of database used with the community database.
community.DbName Name of the community database
community.DbUrl Databasebase URL used to access the community database with JDBC.
community.DbUser The community database user.
community.DbPassword The community database user password.

Assumptions/Prerequisites: None Password considerations: Typically, this task will be invoked passing

-Dcommunity.DbPassword=password

Error Conditions: None
Task dependencies: init
Tasks invoked: None

drop-database-tables-domain-jcr
Cleans the tables from the DB2 Content Manager Runtime Edition database.
Some tables and views will remain in the DB2 Content Manager Runtime Edition database even after this command is run. These are dynamically-created resources with names such as "ICMUTxxxxxxx" that will contain additional data about the WebSphere Portal content. It is safe to leave these tables in place as their presence will not interfere with any other activity; however, if you wish to completely clean out the database, you may drop all these tables and views using standard database tools.
Invoked to erase the database tables. For example:

UNIX :
./WPSconfig.sh drop-database-tables-domain-jcr

Windows:
WPSconfig.bat drop-database-tables-domain-jcr

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile drop-database-tables-domain-jcr

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
jcr.DbType Type of database used with the DB2 Content Manager Runtime Edition database.
jcr.DbName Name of the DB2 Content Manager Runtime Edition database
jcr.DbUrl Databasebase URL used to access the DB2 Content Manager Runtime Edition database with JDBC.
jcr.DbUser TheDB2 Content Manager Runtime Edition database user.
jcr.DbPassword The DB2 Content Manager Runtime Edition database user password.

Assumptions/Prerequisites: None Password considerations: Typically, this task will be invoked passing

-Djcr.DbPassword=password

Error Conditions: None
Task dependencies: init
Tasks invoked: None

drop-database-tables-domain-wmm

Cleans the tables from the Member Manager database.
Invoked to erase the database tables. For example:

UNIX :
./WPSconfig.sh drop-database-tables-domain-wmm

Windows:
WPSconfig.bat drop-database-tables-domain-wmm

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile drop-database-tables-domain-wmm

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
wmm.DbType Type of database used with the Member Manager database.
wmm.DbName Name of the Member Manager database
wmm.DbUrl Databasebase URL used to access the Member Manager database with JDBC.
wmm.DbUser The Member Manager database user.
wmm.DbPassword The Member Manager database user password.

Assumptions/Prerequisites: None Password considerations: Typically, this task will be invoked passing

-Dwmm.DbPassword=password

Error Conditions: None
Task dependencies: init
Tasks invoked: None

drop-database-tables-domain-feedback

Cleans the tables from the feedback database.
Invoked to erase the database tables. For example:

UNIX :
./WPSconfig.sh drop-database-tables-domain-feedback

Windows:
WPSconfig.bat drop-database-tables-domain-feedback

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile drop-database-tables-domain-feedback

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
feedback.DbType Type of database used with the feedback database.
feedback.DbName Name of the feedback database
feedback.DbUrl Databasebase URL used to access the feedback database with JDBC.
feedback.DbUser The feedback database user.
feedback.DbPassword The feedback database user password.

Assumptions/Prerequisites: None Password considerations: Typically, this task will be invoked passing

-Dfeedback.DbPassword=password

Error Conditions: None
Task dependencies: init
Tasks invoked: None

drop-database-tables-domain-likeminds

Cleans the tables from the LikeMinds database.
Invoked to erase the database tables. For example:

UNIX :
./WPSconfig.sh drop-database-tables-domain-likeminds

Windows:
WPSconfig.bat drop-database-tables-domain-likeminds

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile drop-database-tables-domain-likeminds

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
likeminds.DbType Type of database used with the LikeMinds database.
likeminds.DbName Name of the LikeMinds database
likeminds.DbUrl Databasebase URL used to access the LikeMinds database with JDBC.
likeminds.DbUser The LikeMinds database user.
likeminds.DbPassword The LikeMinds database user password.

Assumptions/Prerequisites: None Password considerations: Typically, this task will be invoked passing

-Dlikeminds.DbPassword=password

Error Conditions: None
Task dependencies: init
Tasks invoked: None

drop-database-tables-all

Cleans all the tables from all the databases. In addition to the release, customization, community and jcr domains, this task also drops the wmm, feedback and likeminds domains.
Invoked to erase the database tables. For example:

UNIX :
./WPSconfig.sh drop-database-tables-all

Windows:
WPSconfig.bat drop-database-tables-all

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile drop-database-tables-all

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
DbType Type of database used with WebSphere Portal.
DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
WpsDbName Name of the Wps database.
WpsDbUrl Databasebase URL used to access the wpsdb database with JDBC.
WpsDbUser The database user.
WpsDbPassword 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.

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
dbdomain.DbType Type of database used with WebSphere Portal dbdomain database.
dbdomain.DbName Name of the WebSphere Portal dbdomain database
dbdomain.DbUrl Databasebase URL used to access the WebSphere Portal dbdomain database with JDBC.
dbdomain.DbUser WebSphere Portal dbdomain database user.
dbdomain.DbPassword WebSphere Portal dbdomain database user password.

Assumptions/Prerequisites: For specific assumptions and prerequisites, refer to the individual tasks that are invoked by this task. Password considerations: Typically, this task will be invoked passing

-Drelease.DbPassword=password

-Dcustomization.DbPassword=password

-Dcommunity.DbPassword=password

-Djcr.DbPassword=password

-Dwmm.DbPassword=password

-Dfeedback.DbPassword=password

-Dlikeminds.DbPassword=password

Error Conditions: None
Task dependencies: init
Tasks invoked: None

drop-wmm-db

Drop Member Manager database used with WebSphere Portal. This task drops the database and any tables.
This task is only applicable to DB2 UDB for UNIX, Windows, and Linux. For a remote Member Manager on iSeries database, remove it by following the instructions found here.
Invoked as part of the WPSconfig script file. For example:

UNIX :
./WPSconfig.sh drop-wmm-db

Windows:
WPSconfig.bat drop-wmm-db

i5/OS For a local Member Manager on iSeries database :

From the User directory:
WPSconfig.sh -profileName profile drop-wmm-db

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtpye.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtpye.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file

Input Description
wmm.DbType Type of database used with Member Manager database.
wmm.DbName Name of the Member Manager database
wmm.DbUrl Databasebase URL used to access the Member Manager database with JDBC.
wmm.DbUser The Member Manager database user.
wmm.DbPassword The Member Manager database user password.

Assumptions/Prerequisites: The Member Manager database must be created before performing this task.
Password considerations: Typically, this task will be invoked passing -Dwmm.DbPassword=password
Error Conditions: This task will fail if the Member Manager database does not exist or if communication with the database cannot be established.
Task dependencies: None
Tasks invoked:
None

enable-jcr-security

Update content repository properties on the machine's file system.
Run on secondary nodes when securing a clustered environment.

./WPSconfig.sh enable-jcr-security

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
PortalAdminId User ID of the WebSphere Portal administrator.

Assumptions/Prerequisites: Security has been enabled on the cluster's primary node.
Password considerations: None
Error Conditions: None
Task dependencies: action-check-jcr-files
Tasks invoked: None

enable-page-as-extension-node

Enables a page as an extension node. Invoked to create an extension node.

UNIX:

./WPSconfig.sh enable-page-as-extension-node -DPageUniqueName=value

Windows:
WPSconfig.bat enable-page-as-extension-node -DPageUniqueName=value

This task takes the following input as defined in the wpconfig.properties file:

Input Description
PageUniqueName The unique name of the page to be affected.

Assumptions/Prerequisites: None
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

enable-page-as-task-page-container

Enables the parent page of the dynamically created task page instance.
Invoked to create a task page container.

UNIX:

./WPSconfig.sh enable-page-as-task-page-container -DPageUniqueName=value

Windows:
WPSconfig.bat enable-page-as-task-page-container -DPageUniqueName=value

This task takes the following input as defined in the wpconfig.properties file:

Input Description
PageUniqueName The unique name of the page to be affected.

Assumptions/Prerequisites: None
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

enable-security-ldap

Configures WebSphere Portal Version 6.0 and Member Manager databases for use with an LDAP directory and sets WAS security to use the LDAP directory. Use this task when configuring WebSphere Portal to use an LDAP directory or an LDAP directory + Lookaside database as the user registry.
If this is a cluster environment, stop all cluster members before enabling security using the enable-security-ldap task.
For more information, see Configuring LDAP for non-realm support.

enable-security-wmmur-db

Configures WebSphere Portal Version 6.0 and Member Manager databases for use with a database directory and sets WAS security to use the database directory.
If this is a cluster environment, stop all cluster members before enabling security using the enable-security-wmmur-db task.

enable-security-wmmur-ldap

Configures WebSphere Portal Version 6.0 and Member Manager databases for use with an LDAP directory and sets WAS security to use the LDAP directory. This also configures the LDAP to allow multiple virtual portals.
If this is a cluster environment, stop all cluster members before enabling security using the enable-security-wmmur-ldap task.
For more information, see Configuring LDAP for realm support.

enable-security-wmmur-dmgr

Configures security on the IBM WAS Network Deployment deployment manager machine when setting up a WebSphere Portal cluster. This task configures security to use either a database user registry or LDAP user registry with realm support, depending on the security used by the primary node.
For more information, see Installing WebSphere Portal on an unmanaged node (primary).

feedback-database

Creates the Feedback database.
Invoked to create the Feedback database for use with the specified database type. For example:

UNIX:

./WPSconfig.sh feedback-database

Windows:
WPSconfig.bat feedback-database

This task takes the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
feedback.DbType Type of database used with WebSphere Portal Feedback database.
feedback.DbName Name of the WebSphere Portal Feedback database.
feedback.DbUrl Databasebase URL used to access the WebSphere Portal Feedback database with JDBC.
feedback.DbUser WebSphere Portal Feedback database user.
feedback.DbPassword WebSphere Portal Feedback database user password.

Assumptions/Prerequisites: Database client available. Password considerations: Typically, this task will be invoked passing
-Dfeedback.DbPassword=password

init

The main initialization task that prepares the configuration environment for other tasks, including preprocessing of some files.
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:
action-set-time-property, action-init-zos, action-set-conntype-property action-validate-was-instance init-cfg-files

lcc-configure-all

Configures multiple properties related to Lotus Collaborative Components including:

Domino Directory
Lotus QuickPlace
Lotus Sametime
IBM Tivoli Directory Server

On i5/OS, configures multiple properties related to Lotus Collaborative Components including:

Domino Directory
Lotus QuickPlace
Lotus Sametime

Invoked to configure multiple Lotus Collaborative Components properties. For example:

./WPSconfig.sh lcc-configure-all

i5/OS:
cd /UserData
WPSconfig.sh -profileName profile lcc-configure-all

Inputs: None
Assumptions/Prerequisites:

Domino Directory
Lotus QuickPlace
Lotus Sametime
IBM Tivoli Directory Server

i5/OS Assumptions/Prerequisites:

Domino Directory
Lotus QuickPlace
Lotus 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-discoveryserver

lcc-configure-quickplace

Configures IBM Lotus QuickPlace for use with Lotus Collaborative Components.
Invoked to configure IBM Lotus QuickPlace for use with Lotus Collaborative Components. For example:

UNIX:

./WPSconfig.sh lcc-configure-quickplace

Windows:
WPSconfig.bat lcc-configure-quickplace

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile lcc-configure-quickplace

Inputs: None
Assumptions/Prerequisites: IBM 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 IBM Lotus Sametime for use with Lotus Collaborative Components.
Invoked to configure IBM Lotus Sametime for use with Lotus Collaborative Components. For example:

UNIX :
./WPSconfig.sh lcc-configure-sametime

Windows:
WPSconfig.bat lcc-configure-sametime

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile lcc-configure-sametime

Inputs: None
Assumptions/Prerequisites: IBM Lotus 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: None

lcc-configure-discoveryserver

Configures IBM Tivoli Directory Server for use with Lotus Collaborative Components.
Invoked to configure IBM Tivoli Directory Server for use with Lotus Collaborative Components. For example:

UNIX :
./WPSconfig.sh lcc-configure-discoveryserver

Windows:
WPSconfig.bat lcc-configure-discoveryserver

Inputs: None
Assumptions/Prerequisites: IBM Tivoli Directory Server
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.
Invoked to configure Lotus Domino Directory for use with Lotus Collaborative Components. For example:

UNIX :
./WPSconfig.sh lcc-configure-dominodirectory

Windows:
WPSconfig.bat lcc-configure-dominodirectory

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile 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

Update WAS configuration files associated with WebSphere Portal to have appropriate path information. This task is run to change the context root for portal server.

modify-wcm-host

Modifies Web Content Management configuration when you change the IP address or hostname.
Invoke as part of the WPSconfig script file. For example:

UNIX:

./WPSconfig.sh modify-wcm-host

Windows:
WPSconfig.bat modify-wcm-host

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile modify-wcm-host

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
WpsInstallLocation The directory where WebSphere Portal is installed.
WasUserHome The directory where WAS user data is created.
CellName WAS cell to which the WAS belongs.
NodeName The node within the WAS cell to which the WAS belongs.
WpsHostPort Port used to connect to 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 User ID of the WebSphere Portal administrator.
PortalAdminPwd The password of the WebSphere Portal administrator.
WcmDbUrl The JDBC URL to the Web Content Management database.
WcmDbDriver The Java class name for the JDBC provider that Web Content Management uses to communicate with its databases.

Assumptions/Prerequisites: Run this task after you change the IP address or hostname of the Portal Server.
Password considerations: Typically, this task will be invoked passing -DPortalAdminPwd=password
Error Conditions: None
Task dependencies: init
Tasks invoked: action-update-wcm-app-config-properties, action-update-wcm-db-config-properties

populate-feedback-caltod-dbtype

This task populates the FEEDBACK.CALENDAR and FEEDBACK.TIMEOFDAY tables.
Invoked to populate these tables for customized reports and logging. Enter the following command appropriate for the environment:

DB2:

UNIX:

./WPSconfig.sh populate-feedback-caltod-db2

Windows:
WPSconfig.bat populate-feedback-caltod-db2

Cloudscape :

UNIX:

./WPSconfig.sh populate-feedback-caltod-cloudscape

Windows:
WPSconfig.bat populate-feedback-caltod-cloudscape

Oracle :

UNIX:

./WPSconfig.sh populate-feedback-caltod-oracle

Windows:
WPSconfig.bat populate-feedback-caltod-oracle

SQL Server :

UNIX:

./WPSconfig.sh populate-feedback-caltod-sqlserver

Windows:
WPSconfig.bat populate-feedback-caltod-sqlserver

Inputs: None
Assumptions/Prerequisites: The database must be installed locally. Feedback tables must already be created.
Error Conditions: The database is not installed.
Task dependencies: None
Tasks invoked: action-populate-feedback-caltod

portlets

Deploys the portlets included with WebSphere Portal (defined in the SetupPortal.xml file) using the XML configuration interface.
Invoked as part of the WPSconfig script file. For example:

UNIX :
./WPSconfig.sh portlets

Windows:
WPSconfig.bat portlets

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile portlets

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=password
Error Conditions: None
Task dependencies: init
Tasks invoked: action-deploy-portlets

portlets-admin

Deploys only the administrative portlets included with WebSphere Portal using the XML configuration interface.
Invoked as part of the WPSconfig script file. For example:

UNIX :
./WPSconfig.sh portlets-admin

Windows:
WPSconfig.bat portlets-admin

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile portlets-admin

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=password
Error Conditions: None
Task dependencies: init
Tasks invoked: action-deploy-portlets-admin

post-portal-node-federation-configuration

Update the configuration of the deployment manager after adding a WebSphere Portal node to a cell managed by the deployment manager.
For more information, see Installing WebSphere Portal on an unmanaged node (primary).

remove-conversion-delegation

Ends delegation of all file conversion services to a remote machine
Call this optional task if you want to discontinue the delegation of file conversion services to a remote machine. This will cause all future conversions to be performed on the local host.

UNIX:

./WPSconfig.sh remove-conversion-delegation

Windows:
WPSconfig.bat remove-conversion-delegation

Inputs: None
Assumptions/Prerequisites: None
Password considerations: None
Error Conditions: None
Task dependencies: None
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.
Invoked as part of the WPSconfig script file. For example:

UNIX:

./WPSconfig.sh remove-was-cfg

Windows:
WPSconfig.bat remove-was-cfg

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile 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.

setup-feedback

Creates datasources in WAS for use by the Feedback function.
Call in conjunction with feedback-database to configure Feedback for use with the WebSphere Portal Server. For example:

UNIX :
./WPSconfig.sh setup-feedback

Windows:
WPSconfig.bat setup-feedback

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
CellName WAS cell to which the WAS belongs.
NodeName The node within the WAS cell to which the WAS belongs.
ServerName 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.
WasUserid User ID for WAS security authentication.
WasPassword The password for WAS security authentication.

Assumptions/Prerequisites: None Password considerations: Typically, this task will be invoked passing
-DWasPassword=password

setup-productivity-components

Performs configuration of the WebSphere Portal Productivity Components.
Invoked as part of the WPSconfig script file. For example:

UNIX:

./WPSconfig.sh setup-productivity-components

Windows:
WPSconfig.bat setup-productivity-components

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile 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

configure-transcoding

Enables and configures Transcoding Technology functionality inWebSphere Portal.
Invoke this configuration task to enable and configure Transcoding Technology functionality.

UNIX:

./WPSconfig.sh configure-transcoding

Windows:
WPSconfig.bat configure-transcoding

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile configure-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

remove-transcoding

Disables and removes configuration of Transcoding Technology functionality in WebSphere Portal.
Invoke this configuration task to disable and remove Transcoding Technology functionality.

UNIX:

./WPSconfig.sh remove-transcoding

Windows:
WPSconfig.bat remove-transcoding

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile remove-transcoding

Inputs: None Assumptions/Prerequisites:

WebSphere Portal enterprise application must be installed and deployed before this task is performed.

The configure-transcoding task has been previously run to enable Transcoding Technology functionality.

Error Conditions: This task will fail if the WebSphere Portal product files are not found.
Task dependencies: None
Tasks invoked:
None

remove-wcm-persistence-tables

Removes the database tables for the Web Content Management component of WebSphere Portal from the DB2 Content Manager Runtime Edition database.
Invoked to erase the database tables. For example:

UNIX:

./WPSconfig.sh remove-wcm-persistence-tables

Windows:
WPSconfig.bat remove-wcm-persistence-tables

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile remove-wcm-persistence-tables

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
WpsInstallLocation The directory where WebSphere Portal is installed.

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
jcr.DbType Type of database used with DB2 Content Manager Runtime Edition database.
jcr.DbName Name of the DB2 Content Manager Runtime Edition database
jcr.DbUrl Databasebase URL used to access the DB2 Content Manager Runtime Edition database with JDBC.
jcr.DbUser The DB2 Content Manager Runtime Edition database user.
jcr.DbPassword The DB2 Content Manager Runtime Edition database user password.

Assumptions/Prerequisites: None
Password considerations: None
Error Conditions: None
Task dependencies: init
Tasks invoked:
None

start-admin-server

Starts the WAS administrative server.
Invoked to start the WAS administrative server. For example:

UNIX:

./WPSconfig.sh start-admin-server

Windows:
WPSconfig.bat start-admin-server

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile start-admin-server

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
WasAdminServer WAS.
WasHome WAS install directory.
WasUserid 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.
Password considerations: Typically, this task will be invoked passing -DWasPassword=password
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

start-portal-server

Starts the WAS portal server.
Invoked to start the WAS portal server. For example:

UNIX:

./WPSconfig.sh start-portal-server

Windows:
WPSconfig.bat start-portal-server

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile start-portal-server

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
ServerName 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 WAS install directory.
WasUserid 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.
Password considerations: Typically, this task will be invoked passing -DWasPassword=password
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

stop-admin-server

Stops the WAS administrative server.
Invoked to stop the WAS administrative server. For example:

UNIX:

./WPSconfig.sh stop-admin-server

Windows:
WPSconfig.bat stop-admin-server

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile stop-admin-server

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
WasAdminServer WAS.
WasHome WAS install directory.
WasUserid 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.
Password considerations: Typically, this task will be invoked passing -DWasPassword=password
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

stop-portal-server

Stops the WAS portal server.
Invoked to stop the WAS portal server. For example:

UNIX:
./WPSconfig.sh stop-portal-server

Windows:
WPSconfig.bat stop-portal-server

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile stop-portal-server

This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
ServerName 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 WAS install directory.
WasUserid 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.
Password considerations: Typically, this task will be invoked passing -DWasPassword=password
Error Conditions: None
Task dependencies: None
Tasks invoked:
None

update-contentaccessservice-proxy

Configures the HTTP proxy used by Content Access Service.
Invoked to configure an HTTP proxy for Content Access Service. For example:

UNIX:

./WPSconfig.sh update-contentaccessservice-proxy

Windows:
WPSconfig.bat update-contentaccessservice-proxy

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile update-contentaccessservice-proxy

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

validate-database-connection-feedback

Checks the connection to the Feedback database.
Invoked to validate the existence of and access rights to the Feedback database. For example:

./WPSconfig.sh validate-database-connection-feedback

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile validate-database-connection-feedback

Inputs:
This task takes the following inputs as defined in wpconfig_dbtype.properties.

Input Description
dbtype.DbDriver The classname of the JDBC driver.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file.

Input Description
feedback.DbType Type of database.
feedback.DbUrl The JDBC URL to the database.
feedback.DbUser The database user.
feedback.DbPassword The database user password.

Assumptions/Prerequisites: The database must exist and the database client must be available.
Password considerations: Typically, this task will be invoked passing -DDbPassword=password
Error Conditions: The task will fail if the information in the properties file is invalid.
Task dependencies: None
Tasks invoked:
None

validate-database-connection-jcr

Checks the connection to the DB2Content Manager Runtime Edition database.
Invoked to validate the existence of and access rights to the DB2 Content Manager Runtime Edition database. For example:

./WPSconfig.sh validate-database-connection-jcr

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile validate-database-connection-jcr

Inputs:
This task takes the following inputs as defined in wpconfig_dbtype.properties.

Input Description
dbtype.DbDriver The classname of the JDBC driver.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file.

Input Description
jcr.DbType Type of database.
jcr.DbUrl The JDBC URL to the database.
jcr.DbUser The database user.
jcr.DbPassword The database user password.

Assumptions/Prerequisites: The database must exist and the database client must be available.
Password considerations: Typically, this task will be invoked passing -DJcrDbPassword=password
Error Conditions: The task will fail if the information in the properties file is invalid.
Task dependencies: None
Tasks invoked:
None

validate-database-connection-likeminds

Checks the connection to the LikeMinds database.
Invoked to validate the existence of and access rights to the LikeMinds database. For example:

./WPSconfig.sh validate-database-connection-likeminds

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile validate-database-connection-likeminds

Inputs:
This task takes the following inputs as defined in wpconfig_dbtype.properties.

Input Description
dbtype.DbDriver The classname of the JDBC driver.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file.

Input Description
likeminds.DbType Type of database.
likeminds.DbUrl The JDBC URL to the database.
likeminds.DbUser The database user.
likeminds.DbPassword The database user password.

Assumptions/Prerequisites: The database must exist and the database client must be available.
Password considerations: Typically, this task will be invoked passing -DLikemindsPassword=password
Error Conditions: The task will fail if the information in the properties file is invalid.
Task dependencies: None
Tasks invoked:
None

validate-database-connection-wmm

Checks the connection to the WMM database.
Invoked to validate the existence of and access rights to the WMM database. For example:

./WPSconfig.sh validate-database-connection-wmm

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile validate-database-connection-wmm

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
wmm.DbType Type of database used with Member Manager database.
wmm.DbUrl Databasebase URL used to access the Member Manager database with JDBC.
wmm.DbUser The Member Manager database user.
wmm.DbPassword The Member Manager database user password.

Assumptions/Prerequisites: The database must exist and the database client must be available.
Password considerations: Typically, this task will be invoked passing -Dwmm.DbPassword=password
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

Checks the connection to the WPS database.
Invoked to validate the existence of and access rights to the WPS database. For example:

./WPSconfig.sh validate-database-connection-wps

i5/OS. From the UserData directory:

WPSconfig.sh -profileName profile validate-database-connection-wps

This task takes the following inputs as defined in the wpconfig_dbtype.properties file:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.

And the following inputs as defined in the wpconfig_dbdomain.properties file:

Input Description
dbdomain.DbType Type of database used withWebSphere Portal dbdomain database.
dbdomain.DbName Name of the WebSphere Portal dbdomain database.
dbdomain.DbSchema WebSphere Portal dbdomain database schema name.
dbdomain.DbUrl Databasebase URL used to access the WebSphere Portal dbdomain database with JDBC.
dbdomain.DbUser WebSphere Portal dbdomain database user.
dbdomain.DbPassword WebSphere Portal dbdomain database user password.

Assumptions/Prerequisites: The database must exist and the database client must be available. Password considerations: Typically, this task will be invoked passing

-Drelease.DbPassword=password

-Dcustomization.DbPassword=password

-Dcommunity.DbPassword=password

-Djcr.DbPassword=password

Error Conditions: The task will fail if the information in the properties file is invalid.
Task dependencies: None
Tasks invoked: None

validate-database-driver

Checks the availability of the JDBC driver class.
Invoked to validate the existence of and access rights to the JDBC driver archive. For example:

UNIX:

./WPSconfig.sh validate-database-driver

Windows:
WPSconfig.bat validate-database-driver

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile validate-database-driver

This task takes the following inputs as defined in wpconfig_dbtype.properties:

Input Description
dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary The fully qualified directory path name where the classes for the JDBC provider are located.
And the following inputs as defined in thewpconfig_dbdomain.properties file:
Although this task only verifies the database driver, these properties must also be set.

Input Description
dbdomain.DbType Type of database used withWebSphere Portal dbdomain database.
dbdomain.DbName Name of the WebSphere Portal dbdomain database.
dbdomain.DbSchema WebSphere Portal dbdomain database schema name.
dbdomain.DbUrl Databasebase URL used to access the WebSphere Portal dbdomain database with JDBC.
dbdomain.DbUser WebSphere Portal dbdomain database user.
dbdomain.DbPassword WebSphere Portal dbdomain database user password.

Assumptions/Prerequisites: The database client must be available. Password considerations: Typically, this task will be invoked passing

-Drelease.DbPassword=password

-Dcustomization.DbPassword=password

-Dcommunity.DbPassword=password

-Djcr.DbPassword=password

-DDbPassword=password
Error Conditions: The task will fail if the information in the properties file is invalid.
Task dependencies: None
Tasks invoked:
None

validate-http-portal

Checks the connection to WebSphere Portal using HTTP.
Invoked to determine if WebSphere Portal is running.
This task takes the following inputs as defined in the wpconfig.properties file. All inputs are validated unless otherwise specified.

Input Description
WpsHostName The fully qualified URL to WebSphere Portal.
WpsHostPort Port used to connect to WebSphere Portal.
WpsContextRoot 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

Checks the connection to the LDAP server and checks other LDAP properties in config file.
Should be run before attempting to configure or modify the LDAP configuration. For example:

UNIX:

./WPSconfig.sh validate-ldap

Windows:
WPSconfig.bat validate-ldap

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile validate-ldap

This task takes the following inputs as defined in the wpconfig.properties file. All inputs except filtersettings are validated.

Input Description
WasUserid User ID for WAS security authentication.
WasPassword The password for WAS security authentication.
PortalAdminId User ID of the WebSphere Portal administrator.
PortalAdminPwd The password of the WebSphere Portal administrator.
PortalAdminGroupId The group ID for the group to which the WebSphere Portal administrator belongs.
LDAPHostName The fully qualified hostname of the LDAP server.
LDAPPort The server port of the LDAP directory.
LDAPAdminUId User id to be used to authenticate with the directory.
LDAPAdminPwd The password for the user LDAPServerId.
LDAPBindID User ID for LDAP Bind authentication.
LDAPBindPassword The password for LDAP Bind authentication.
LDAPUserFilter The filter used by WAS for finding users in the LDAP.
LDAPGroupFilter The filter used by WAS for finding groups in the LDAP.
LDAPSuffix The LDAP Suffix. Choose a value appropriate for the LDAP server.
LDAPUserSuffix The DN suffix attribute name for user entries. Choose a value appropriate for the LDAP server.
LDAPGroupSuffix The DN suffix attribute name for group entries. Choose a value appropriate for the LDAP server.

Assumptions/Prerequisites: The directory must be available and access must be permitted.
Password considerations: Typically, this task will be invoked passing -DLDAPAdminPwd=password
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-was-admin-user, action-validate-ldap-portal-admin-user, action-validate-ldap-portal-admin-group, action-validate-ldap-bind-user, action-validate-wmm-system-id, action-validate-ldap-container-user, action-validate-ldap-container-group, action-validate-filter-user, action-validate-filter-group

validate-wmmur-ldap***

Checks the connection to the LDAP server and checks other LDAP properties in config file.
Should be run before attempting to configure or modify the LDAP configuration. For example:

UNIX:

./WPSconfig.sh validate-wmmur-ldap

Windows:
WPSconfig.bat validate-wmmur-ldap

i5/OS:

From the UserData directory:
WPSconfig.sh -profileName profile validate-wmmur-ldap

This task takes the following inputs as defined in the wpconfig.properties file. All inputs are validated unless otherwise specified.

Input Description
WasUserid User ID for WAS security authentication.
WasPassword The password for WAS security authentication.
PortalAdminId User ID of the WebSphere Portal administrator.
PortalAdminPwd The password of the WebSphere Portal administrator.
PortalAdminGroupId The group ID for the group to which the WebSphere Portal administrator belongs.
LDAPHostName The fully qualified hostname of the LDAP server.
LDAPPort The server port of the LDAP directory.
LDAPAdminUId User id to be used to authenticate with the directory.
LDAPAdminPwd The password for the user LDAPServerId.
LDAPSuffix The LDAP Suffix. Choose a value appropriate for the LDAP server.
LDAPUserSuffix The DN suffix attribute name for user entries. Choose a value appropriate for the LDAP server.
LDAPGroupSuffix The DN suffix attribute name for group entries. Choose a value appropriate for the LDAP server.
WmmSystemId The fully-qualifed distinguished name (DN) for the Member Manager system.
WmmSystemIdPassword The password for Member Manager security authentication.

Assumptions/Prerequisites: The directory must be available and access must be permitted.
Password considerations: Typically, this task will be invoked passing -DLDAPAdminPwd=password
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-was-admin-user, action-validate-ldap-portal-admin-user, action-validate-ldap-portal-admin-group, action-validate-ldap-bind-user, action-validate-wmm-system-id, action-validate-ldap-container-user, action-validate-ldap-container-group, action-validate-filter-user, action-validate-filter-group

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.

Invoked to determine if the WebSphere Portal Administrator has administrator privileges. For example:

UNIX:

./WPSconfig.sh validate-wps-admin-login

Windows:
WPSconfig.bat validate-wps-admin-login

i5/OS:
From the UserData directory:
WPSconfig.sh -profileName profile validate-wps-admin-login

This task takes the following inputs as defined in the wpconfig.properties file. All inputs are validated unless otherwise specified.

Input Description
WpsHostName The fully-qualified URL to WebSphere Portal.
WpsHostPort Port used to connect to WebSphere Portal.
WpsContextRoot Base URI in the WebSphere Portal URL ("wps" by default).
PortalAdminPwd 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=password
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).

User does not exist.

User does not have administration privileges.

The password is incorrect.

Authentication is not configured properly.

Task dependencies: None
Tasks invoked:
None

External security manager tasks

disable-tam-userprov

Disables and unconfigures the user provisioning function to TAM from WebSphere Portal
Typically run when removing the user provisioning function to TAM
Inputs: This task requires no inputs from the wpconfig.properties file
Password considerations: None
Error Conditions: None
Task dependencies: None
Tasks invoked:
startserver, stopserver, and conditionally action-disable-jaas-temp and action-enable-jaas-temp

enable-sm-authorization

Enables and configures WebSphere Portal to use Computer Associates eTrust SiteMinder as an external authorization engine
Typically run when initially configuring WebSphere Portal to work with eTrust SiteMinder
Inputs: This task takes the following inputs as defined in the wpconfig.properties file:

Input Description
EACserverName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACcellName and EACappname must also be set.
reorderRoles Either have the externalized Portal rolenames displayed with the resource type first, or the role types first.
EACcellName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACserverName and EACappname must also be set.
EACappName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACcellName and EACservername must also be set.
SMDomain eTrust SiteMinder Domain containing all externalized portal resources.
SMScheme eTrust SiteMinder Authentication scheme object name to use when creating realms.
SMAgent The agent created to allow communication between WebSphere Portal and eTrust SiteMinder.
SMAgentPw Password for eTrust SiteMinder agent (SMAgent).
SMAdminId The administrative user ID that eTrust SiteMinder will use to access the eTrust SiteMinder policy server.
SMAdminPw Password for eTrust SiteMinder administrative user (SMAdminId).
SMUserDir eTrust SiteMinder User Directory object referencing the LDAP server used for Portal users and groups.
SMFailover Failover mode of eTrust SiteMinder Policy Server.
Must be set to true if more than one policy server is listed in the SMServers property.
SMServers Comma-delimited list of servers for eTrust SiteMinder agent.

Assumptions/Prerequisites: WAS and WebSphere Portal security has been enabled, eTrust SiteMinder SDK has been installed and added to the WAS and WebSphere Portal classpaths
Password considerations: Typically, this task will be invoked passing any combination of -DSMAgentPw=password -DSMAdminPw=password
Error Conditions: None
Task dependencies: is-security-enabled, validate-smsdk-available
Tasks invoked:
action-create-sm-jaas, action-esm-sm-update-callbackheaderslist, action-esm-sm-update-services, action-esm-sm-update-externalaccesscontrolservice, action-esm-update-static-files

enable-sm-all

Enables every WebSphere Portal integration point with eTrust SiteMinder, including single signon (using a WAS TAI) and portal authorization
Used to enable TAI and authorization to eTrust SiteMinder
This task takes the following inputs as defined in wpsconfig.properties:

Input Description
EACserverName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACcellName and EACappname must also be set.
reorderRoles Either have the externalized Portal rolenames displayed with the resource type first, or the role types first.
EACcellName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACserverName and EACappname must also be set.
EACappName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACcellName and EACservername must also be set.
SMConfigFile Location of the eTrust SiteMinder TAI WebAgent.conf file.
SMDomain eTrust SiteMinder Domain containing all externalized portal resources.
SMScheme eTrust SiteMinder Authentication scheme object name to use when creating realms.
SMAgent The agent name that is created on eTrust SiteMinder for a specific portal external security manager instance.
SMAgentPw Password for eTrust SiteMinder agent (SMAgent).
SMAdminId The administrative user ID that eTrust SiteMinder will use to access the eTrust SiteMinder policy server.
SMAdminPw Password for eTrust SiteMinder administrative user (SMAdminId).
SMUserDir eTrust SiteMinder User Directory object referencing the LDAP server used for Portal users and groups.
SMFailover Failover mode of eTrust SiteMinder Policy Server.
Must be set to true if more than one policy server is listed in the SMServers property.
SMServers Comma-delimited list of servers for eTrust SiteMinder agent.

Assumptions/Prerequisites: WAS and WebSphere Portal security have been enabled, eTrust SiteMinder TAI and SDK installed and available to WebSphere Portal
Password considerations: Typically, this task will be invoked passing any combination of -DSMAgentPw=password -DSMAdminPw=password
Error Conditions: None
Task dependencies: is-security-enabled
Tasks invoked: enable-sm-tai,enable-sm-authorization

enable-sm-tai

Enable and configures WAS with the eTrust SiteMinder TAI
Use to enable only single signon with eTrust SiteMinder
Inputs: This task takes the following inputs as defined in wpsconfig.properties:

Input Description
SMConfigFile Location of the eTrust SiteMinder TAI WebAgent.conf file.

Assumptions/Prerequisites: WAS and WebSphere Portal security enabled, eTrust SiteMinder TAI installed to WAS directory structure
Error Conditions: None
Task dependencies: validate-smtai-available
Tasks invoked: action-create-sm-tai

enable-tam-all

Enables every WebSphere Portal integration point with TAM, including:

Single signon using the WAS TAI
WebSphere Portal authorization
Credential vault

This task takes the following inputs as defined in wpsconfig.properties:

Input Description
EACserverName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACcellName and EACappname must also be set.
reorderRoles Either have externalized Portal rolenames displayed with the resource type first, or the role types first.
JunctionType Type of junction to be created in TAM. Accepted values are tcp and ssl.
EACcellName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACserverName and EACappname must also be set.
PDAdminId User ID for the administrative TAM user.
This user should have the access to create new TAM servers, new Tivoli protected objectspaces, and new Tivoli protected objects.
JunctionPoint The WebSEAL junction point to the WebSphere Portal in use.
EACappName (Optional) Namespace context information to distinguish externalized portal role names in the TAM namespace.
If set, EACcellName and EACservername must also be set.
PDPermPath Location of the TAM AMJRTE properties file (PdPerm.properties).
WebSealInstance The WebSEAL instance used to create the junction.
TAICreds Headers inserted by WebSEAL that the TAI uses to identify the request as originating from WebSEAL.
WebSealUser For tcp junctions. The reverse proxy identity used when you create a TCP junction.
WebSealHost Optional parameter that sets the WebSEAL TAI's hostnames parameter.
BaUserName For ssl junctions. The reverse proxy identity used when you create an SSL junction.
WebSealPort Optional parameter that sets the WebSEAL TAI's ports parameter.
BaPassword For ssl junctions. When you create an SSL junction, we can provide a password to the identity representing the reverse proxy on every request.
PDRoot Root objectspace entry in the TAM namespace.
PDAction Custom Action created by the TAM external authorization plug-in. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles.
PDActionGroup Custom Action group created by the TAM external authorization plug-in. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles.
PDCreateAcl Setting to determine whether the portal can automatically create and attach a TAM ACL when Portal externalizes a role.
vaultType New vault type identifier representing the Tivoli GSO lockbox vault.
vaultProperties Defines a properties file to be used to configure the vault with TAM specific user and SSL connection information.
manageResources Determines if the portal credential vault or any custom portlet is allowed to create new resource objects in TAM.
readOnly Determines if the portal credential vault or any custom portlet is allowed to modify the secrets stored in TAM.
WpsHostName The fully-qualified host.name of the Web server that WAS is configured to use.
WpsHostPort The port number used to access the host machine identified by the WpsHostName property.
PDAdminPw The password for the administrative TAM user.

Assumptions/Prerequisites: TAM AMJRTE SvrSslCfg command has been run, WAS and WebSphere Portal security has been enabled
Password considerations: Typically, this task will be invoked passing any combination of -DBaPassword=password -DPDAdminPw=password
Error Conditions: TAM username/password/url incorrect
Task dependencies: is-security-enabled
Tasks invoked:
enable-tam-tai,enable-tam-authorization,action-esm-tam-update-vaultservice

enable-tam-tai

Enables and configures single signon using the WebSEAL TAI. This task also creates a TCP or SSL junction via TAM AMJRTE calls for WebSphere Portal access
Use to enable external authentication to TAM
Inputs: This task takes the following inputs as defined in wpsconfig.properties:

Input Description
PDAdminId User ID for the administrative TAM user.
JunctionPoint The WebSEAL junction point to the WebSphere Portal in use.
JunctionType Type of junction to be created in TAM. Accepted values are tcp and ssl.
PDAdminPw The password for the administrative TAM user.
PDPermPath Location of the TAM AMJRTE properties file (PdPerm.properties).
WebSealInstance The WebSEAL instance used to create the junction.
TAICreds Headers inserted by WebSEAL that the TAI uses to identify the request as originating from WebSEAL.
WebSealHost Optional parameter that sets the WebSEAL TAI's hostnames parameter.
WebSealPort Optional parameter that sets the WebSEAL TAI's ports parameter.
WpsHostName The fully-qualified host.name of the Web server that WAS is configured to use.
WpsHostPort The port number used to access the host machine identified by the WpsHostName property.
WebSealUser For tcp junctions. The reverse proxy identity used when you create a TCP junction.
BaUserName For ssl junctions. The reverse proxy identity used when you create an SSL junction.
BaPassword For ssl junctions. When you create an SSL junction, we can provide a password to the identity representing the reverse proxy on every request.

Assumptions/Prerequisites: TAM AMJRTE SvrSslCfg command has been run, WAS and WebSphere Portal security has been enabled
Password considerations: Typically, this task will be invoked passing any combination of -DPdAdminPw=password -DBaPassword=password
Error Conditions: TAM username/password/url incorrect
Task dependencies: validate-pdadmin-connection
Tasks invoked: action-create-webseal-junction, action-create-webseal-tai

enable-tam-authorization

Enable and configures WebSphere Portal to use TAM as an external authorization engine
Use to maintain WebSphere Portal access control information in TAM
Inputs: This task takes the following inputs as defined in wpsconfig.properties:

Input Description
EACserverName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACcellName and EACappname must also be set.
reorderRoles Either have externalized Portal rolenames displayed with the resource type first, or the role types first.
EACcellName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACserverName and EACappname must also be set.
PDAdminId User ID for the administrative TAM user.
EACappName (Optional) Namespace context information to further distinguish externalized portal role names from other roll names in the TAM namespace.
If set, EACcellName and EACservername must also be set.
PDPermPath Location of the TAM AMJRTE properties file (PdPerm.properties).
PDRoot Root objectspace entry in the TAM namespace.
PDAction Custom Action created by the TAM external authorization plug-in. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles.
PDActionGroup Custom Action group created by the TAM external authorization plug-in. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles.
PDCreateAcl Setting to determine whether the portal can automatically create and attach a TAM ACL when Portal externalizes a role.

Assumptions/Prerequisites: TAM AMJRTE SvrSslCfg command has been run, WAS and WebSphere Portal security has been enabled
Error Conditions: incorrect TAM username and password
Task dependencies: validate-pdadmin-connection
Tasks invoked:
action-create-tam-jaas, action-esm-tam-update-callbackheaderslist, action-esm-tam-update-services, action-esm-tam-update-externalaccesscontrolservice, action-esm-update-static-files

enable-tam-userprov

Enable user provisioning to TAM.
Used when a new portal LDAP user is created to immediately import and set the new portal LDAP user as a valid user in TAM
This task takes the following inputs as defined in wpsconfig.properties:

Input Description
PDAdminId User ID for the administrative TAM user. This user should have the access to create new TAM servers, new Tivoli protected objectspaces, and new Tivoli protected objects.
PDAdminPw The password for the administrative TAM user.
PDPermPath Location of the TAM AMJRTE properties file (PdPerm.properties).

Assumptions/Prerequisites: Portal/TAM integration for authentication is configured
Password considerations: Typically, this task will be invoked passing -DPDAdminPw=password
Error Conditions: None
Task dependencies: validate-pdadmin-connection
Tasks invoked: xmlaccess

run-svrssl-config

Runs the TAM AMJRTE SvrSslCfg command to configure the SSL link between WAS, WebSphere Portal, and TAM
To run the SvrSslCfg command
This task takes the following inputs as defined in wpsconfig.properties:

Input Description
PDServerName Unique application name used to create a new Tivoli server in the Access Manager Policy Server.
If a server with the same name appears in the server list command, the SvrSslCfg command will fail.
PDAdminId User ID for the administrative TAM user. This user should have the access to create new TAM servers, new Tivoli protected objectspaces, and new Tivoli protected objects.
PDAdminPw The password for the administrative TAM user.
PDPermPath Location of the TAM AMJRTE properties file (PdPerm.properties).
SvrSslCfgPort Configuration port for the application name.
SvrSslCfgMode Configuration mode of the SvrSslCfg command.
PDPolicyServerList Defines a hostname, port, and priority combinations for the TAM Policy servers used when running SvrSslCfg.
PDAuthzServerList Defines a hostname, port, and priority combination for the TAM authorization servers.
PDKeyPath Stores encryption keys used for the SSL communication between AMJRTE and TAM.

Assumptions/Prerequisites: AMJRTE has been installed and available to WAS
Password considerations: Typically, this task will be invoked passing -DPDAdminPw=password
Error Conditions: TAM Policy or Authorization server not found, incorrect username or password for TAM admin user
Task dependencies: validate-pdjrte-available
Tasks invoked:
forks to call the com.tivoli.pd.jcfg.SvrSslCfg command

enable-tam-vault

Configures WebSphere Portal to use the Access Manager Vault Adapter, writing TAM rsrc and rsrccred objects to the GSO lockbox
Use to maintain credentials in TAM
Inputs: This task takes the following inputs as defined in wpsconfig.properties:

Input Description
PDAdminId User ID for the administrative TAM user.
vaultType New vault type identifier representing the Tivoli GSO lockbox vault.
vaultProperties Defines a properties file to be used to configure the vault with TAM specific user and SSL connection information.
PDAdminPw The password for the administrative TAM user.
manageResources Determines if the portal credential vault or any custom portlet is allowed to create new resource objects in TAM.
readOnly Determines if the portal credential vault or any custom portlet is allowed to modify the secrets stored in TAM.
PDPermPath Location of the TAM AMJRTE properties file.

Assumptions/Prerequisites: TAM AMJRTE SvrSslCfg command has been run, WAS and WebSphere Portal security has been enabled
Password considerations: Typically, this task will be invoked passing -DPDAdminPw=password
Error Conditions: TAM username/password/url incorrect
Task dependencies: is-security-enabled, validate-pdadmin-connection
Tasks invoked:
action-esm-tam-update-vaultservice

validate-pdadmin-connection

Verify that the TAM AMJRTE SvrSslCfg command has run and that WebSphere Portal has the necessary configuration parameters to communicate with TAM. If the SvrSslCfg command has not run, see the run-svrssl-config task.
This task takes the following inputs as defined in wpsconfig.properties:

Input Description
PDAdminId User ID for the administrative TAM user.
PDAdminPw The password for the administrative TAM user.
PDPermPath Location of the TAM AMJRTE properties file (PdPerm.properties).

Assumptions/Prerequisites: TAM AMJRTE SvrSslCfg command has been run, WAS and WebSphere Portal security has been enabled
Password considerations: Typically, this task will be invoked passing -DPDAdminPw=password
Error Conditions: TAM username/password/url incorrect
Task dependencies: None
Tasks invoked:
checkpdadmin task

Related information

About the configuration program

Configuration properties reference

Parent topic:
Configuration program

wpconfig.properties	Non-database related properties
wpconfig_dbdomain.properties	Database domain specific properties
wpconfig_dbtype.properties	Database type specific properties

Input	Description
PortalAdminIdShort	The short name for the administrator id.
PortalAdminPwd	Administrator password.

Input	Description
ModifyPortsServer	The server on which the ports should be modified.
StartPort	The starting port block value.
PortsFile	The full path to the file with the port name and the value pairs.

Input	Description
WpsInstallLocation	WebSphere Portal install location.
NodeName	The node on which you are modifying ports.

Input	Description
dbtype.DbDriver	The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
dbtype.DbLibrary	The fully qualified directory path name where the classes for the JDC provider are located.

Input	Description
dbdomain.DbType	Type of database used with WebSphere Portal dbdomain database.
dbdomain.DbName	Name of the WebSphere Portal dbdomain database
dbdomain.DbUrl	Databasebase URL used to access the WebSphere Portal dbdomain database with JDBC.
dbdomain.DbUser	WebSphere Portal dbdomain database user.
dbdomain.DbPassword	WebSphere Portal dbdomain database user password.

Input	Description
PortalAdminId	User ID for the WebSphere Portal Administrator
PortalAdminPwd	The password for the WebSphere Portal Administrator

Input	Description
dbdomain.DbType	Type of database to configure: cloudscape db2 db2_iseries db2_zos oracle sqlserver
dbdomain.DbName	Name of the WebSphere Portal database.
dbdomain.DbSchema	Databasebase schema WebSphere Portal name.
dbdomain.DataSourceName	Name of the datasource to be used for WebSphere Portal database.
dbdomain.XDbName	Required for Non-Windows platforms when using DB2 only. The name of the Windows database loop back alias.
dbdomain.DbNode	Required for Non-Windows platforms when using DB2 only. The node for the Windows database.
dbdomain.DbUrl	The URL used to access the WebSphere Portal database with JDBC.
dbdomain.DbUser	WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
dbdomain.DbPassword	WebSphere Portal database administrator password.

Input	Description
db2.DbDriver	The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
db2.DbLibrary	The fully qualified directory path name where the classes for the JDBC provider are located.
db2.JdbcProviderName	Name of the JDBC Provider to be used.

Input	Description
dbdomain.DbType	Type of database used withWebSphere Portal dbdomain database.
dbdomain.DbName	Name of the WebSphere Portal dbdomain database.
dbdomain.DbSchema	WebSphere Portal dbdomain database schema name.
dbdomain.DataSourceName	Name of datasource to be used for WebSphere Portal dbdomain database
dbdomain.DbUrl	Databasebase URL used to access the WebSphere Portal dbdomain database with JDBC.
dbdomain.DbUser	WebSphere Portal dbdomain database user.
dbdomain.DbPassword	WebSphere Portal dbdomain database user password.
dbdomain.XDbName	Required for Non-Windows platforms when using DB2 only. The name of the WebSphere Portal dbdomain database loop back alias.
dbdomain.DbNode	Required for Non-Windows platforms when using DB2 only. The node for the WebSphere Portal dbdomain database.

Input	Description
DbDriver	The Java class name for the JDBC provider that WebSphere Portal uses to communicate with its databases.
JcrDbUrl	The JDBC URL to the DB2 Content Manager Runtime Edition database.
JcrDbUser	The DB2 Content Manager Runtime Edition database user.
JcrDbPassword	The DB2 Content Manager Runtime Edition database user password.
DbType	Type of database used with WebSphere Portal.

Input	Description
community.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
community.DbLibrary	Directory path where the classes for the JDBC provider are located.
community.DbUrl	The URL used to access the WebSphere Portal database with JDBC.
community.DbName	Name of the WebSphere Portal database for WebSphere Portal tables.
community.DbUser	WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
community.DbPassword	WebSphere Portal database administrator password.

Input	Description
source.community.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
source.community.DbLibrary	Directory path where the classes for the JDBC provider are located.
source.community.DbUrl	The URL used to access the WebSphere Portal database with JDBC.
source.community.DbName	Name of the WebSphere Portal database for WebSphere Portal tables.
source.community.DbUser	WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
source.community.DbPassword	WebSphere Portal database administrator password.

Input	Description
customization.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
customization.DbLibrary	Directory path where the classes for the JDBC provider are located.
customization.DbUrl	The URL used to access the WebSphere Portal database with JDBC.
customization.DbName	Name of the WebSphere Portal database for WebSphere Portal tables.
customization.DbUser	WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
customization.DbPassword	WebSphere Portal database administrator password.

Input	Description
source.customization.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
source.customization.DbLibrary	Directory path where the classes for the JDBC provider are located.
source.customization.DbUrl	The URL used to access the WebSphere Portal database with JDBC.
source.customization.DbName	Name of the WebSphere Portal database for WebSphere Portal tables.
source.customization.DbUser	WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
source.customization.DbPassword	WebSphere Portal database administrator password.

Input	Description
feedback.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
feedback.DbLibrary	Directory path where the classes for the JDBC provider are located.
feedback.DbUrl	The URL used to access the Feedback database with JDBC.
feedback.DbName	Name of the WebSphere Portal database for Feedback tables.
feedback.DbUser	The Feedback database administrator UserID, which is also used as the schema name for the Feedback's tables and database resources.
feedback.DbPassword	The Feedback database administrator password.

Input	Description
source.feedback.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
source.feedback.DbLibrary	Directory path where the classes for the JDBC provider are located.
source.feedback.DbUrl	The URL used to access the Feedback database with JDBC.
source.feedback.DbName	Name of the WebSphere Portal database for Feedback tables.
source.feedback.DbUser	The Feedback database administrator UserID, which is also used as the schema name for the Feedback's tables and database resources.
source.feedback.DbPassword	The Feedback database administrator password.

Input	Description
jcr.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
jcr.DbLibrary	Directory path where the classes for the JDBC provider are located.
jcr.DbUrl	The URL used to access the DB2 Content Manager Runtime Edition database with JDBC.
jcr.DbName	Name of the WebSphere Portal database for DB2 Content Manager Runtime Edition tables.
jcr.DbUser	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.
jcr.DbPassword	The DB2 Content Manager Runtime Edition database administrator password.

Input	Description
source.jcr.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
source.jcr.DbLibrary	Directory path where the classes for the JDBC provider are located.
source.jcr.DbUrl	The URL used to access the DB2 Content Manager Runtime Edition database with JDBC.
source.jcr.DbName	Name of the WebSphere Portal database for DB2 Content Manager Runtime Edition tables.
source.jcr.DbUser	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.
source.jcr.DbPassword	The DB2 Content Manager Runtime Edition database administrator password.

Input	Description
likeminds.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
likeminds.DbLibrary	Directory path where the classes for the JDBC provider are located.
likeminds.DbUrl	The URL used to access the LikeMinds database with JDBC.
likeminds.DbName	Name of the WebSphere Portal database for LikeMinds tables.
likeminds.DbUser	The LikeMinds database administrator UserID, which is also used as the schema name for the LikeMinds's tables and database resources.
likeminds.DbPassword	The LikeMinds database administrator password.

Input	Description
source.likeminds.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
source.likeminds.DbLibrary	Directory path where the classes for the JDBC provider are located.
source.likeminds.DbUrl	The URL used to access the LikeMinds database with JDBC.
source.likeminds.DbName	Name of the WebSphere Portal database for LikeMinds tables.
source.likeminds.DbUser	The LikeMinds database administrator UserID, which is also used as the schema name for the LikeMinds's tables and database resources.
source.likeminds.DbPassword	The LikeMinds database administrator password.

Input	Description
release.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
release.DbLibrary	Directory path where the classes for the JDBC provider are located.
release.DbUrl	The URL used to access the WebSphere Portal database with JDBC.
release.DbName	Name of the WebSphere Portal database for WebSphere Portal tables.
release.DbUser	WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
release.DbPassword	WebSphere Portal database administrator password.

Input	Description
source.release.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
source.release.DbLibrary	Directory path where the classes for the JDBC provider are located.
source.release.DbUrl	The URL used to access the WebSphere Portal database with JDBC.
source.release.DbName	Name of the WebSphere Portal database for WebSphere Portal tables.
source.release.DbUser	WebSphere Portal database administrator UserID, which is also used as the schema name for the WebSphere Portal 's tables and database resources.
source.release.DbPassword	WebSphere Portal database administrator password.

Input	Description
wmm.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
wmm.DbLibrary	Directory path where the classes for the JDBC provider are located.
wmm.DbUrl	The URL used to access the Member Manager database with JDBC.
wmm.DbName	Name of the Member Manager database for Member Manager tables.
wmm.DbUser	The Member Manager database administrator UserID, which is also used as the schema name for the Member Manager 's tables and database resources.
wmm.DbPassword	The Member Manager database administrator password.

Input	Description
source.wmm.DbType	Type of database to configure cloudscape db2 db2_iseries db2_zos oracle sqlserver
source.wmm.DbLibrary	Directory path where the classes for the JDBC provider are located.
source.wmm.DbUrl	The URL used to access the Member Manager database with JDBC.
source.wmm.DbName	Name of the Member Manager database for Member Manager tables.
source.wmm.DbUser	The Member Manager database administrator UserID, which is also used as the schema name for the Member Manager 's tables and database resources.
source.wmm.DbPassword	The Member Manager database administrator password.

Input	Description
release.DbType	Type of database used with the release database.
release.DbName	Name of the release database
release.DbUrl	Databasebase URL used to access the release database with JDBC.
release.DbUser	The release database user.
release.DbPassword	The release database user password.

Input	Description
customization.DbType	Type of database used with the customization database.
customization.DbName	Name of the customization database
customization.DbUrl	Databasebase URL used to access the customization database with JDBC.
customization.DbUser	The customization database user.
customization.DbPassword	The customization database user password.

Input	Description
community.DbType	Type of database used with the community database.
community.DbName	Name of the community database
community.DbUrl	Databasebase URL used to access the community database with JDBC.
community.DbUser	The community database user.
community.DbPassword	The community database user password.

Input	Description
jcr.DbType	Type of database used with the DB2 Content Manager Runtime Edition database.
jcr.DbName	Name of the DB2 Content Manager Runtime Edition database
jcr.DbUrl	Databasebase URL used to access the DB2 Content Manager Runtime Edition database with JDBC.
jcr.DbUser	TheDB2 Content Manager Runtime Edition database user.
jcr.DbPassword	The DB2 Content Manager Runtime Edition database user password.

Input	Description
wmm.DbType	Type of database used with the Member Manager database.
wmm.DbName	Name of the Member Manager database
wmm.DbUrl	Databasebase URL used to access the Member Manager database with JDBC.
wmm.DbUser	The Member Manager database user.
wmm.DbPassword	The Member Manager database user password.