Configuration properties reference

 

+
Search Tips   |   Advanced Search

 

Overview

This topic describes the properties that are used in...

$WP_ROOT/config/wpconfig.properties

...with the configuration tasks during WebSphere Portal installation.

All of these properties are located in the wpconfig.properties file located in the wp_root/config directory.

When modifying values in this file, use a text editor and only change those values that are required for the configuration tasks you are running.

 

How to edit and use properties and values

During installation and configuration, WebSphere Portal requires that you edit a properties file with component values that are unique to the environment. The following precautions should be taken when working with this file:

  • Password considerations

    For security reasons, not store passwords in the wpconfig.properties file. It is recommended that you edit the wpconfig.properties prior to running a configuration task, inserting the passwords needed for that task. Then, after the task has run, you should delete all passwords from the wpconfig.properties file.

    Alternatively, you can specify the password on the command line...

    ./WPSconfig.sh task_name -Dpassword_property_key=password_value

    As with other properties, each password property must have the -D prefix and be set equal to (=) a value. If you have multiple properties in a single command, use a space character between each -Dproperty=value setting.

  • Create a backup copy before you begin working in a properties file.

    This copy can be used to restore default values if necessary. Each time you modify a properties file make a backup copy. You can back up the file manually or by using the configuration task:

    ./WPSconfig.sh backup-main-cfg-file -Dpassword_property_key=password_value

  • Values identified for properties should not have trailing spaces.

  • Do not enclose values in quotes.

  • When typing directories, use a forward slash (/) instead of a backward slash (\), regardless of the operating system used. For example:

    • Windows/UNIX:

      The directory opt/WebSphere continues to use the same forward slash and should be typed as opt/WebSphere

    • Windows:

      The directory C:\WebSphere must be changed by typing a forward slash (/) and should be typed as C:/WebSphere (Windows long paths can be used).

  • Preserve the case of values, such as class names and directory paths.

  • Change only the values indicated in the component configuration steps. Do not change any other values.

  • Some values require multiple entries. Separate each entry with a semi-colon. Do not add spaces between the values.

  • Once a property is set during configuration, its value cannot be overridden. The precedence order for setting properties is as follows, from highest precedence to lowest precedence:

    • Properties set on the command line when the configuration task is launched

    • Properties set in a parent properties file

    • Properties set in the wpconfig.properties file

    • Properties set in the XML configuration files themselves

  • You can add comments to the properties files as needed using the pound or hash symbol (#). This allows you to keep track of changes you have made and why.

 

Properties

  1. WAS properties
  2. Java properties
  3. Portal configuration properties
  4. Dependency Checking Properties
  5. Database properties
  6. Portal Info Sequence properties
  7. DB2 Content Manager Runtime Edition properties
  8. Personalization and Feedback Database properties
  9. Likeminds Database properties
  10. Member Manager properties
  11. Lotus Collaborative Components properties
  12. WebSphere Portal Security LTPA and SSO Configuration
  13. General Global Security Settings
  14. Custom User Registry Configuration
  15. LDAP Properties Configuration
  16. Advanced LDAP Configuration
  17. WebSphere Translation Server Properties
  18. Properties for Advanced Security Configuration using External Security Managers
  19. Virtual Portal Configuration properties
  20. Configuration task properties

 

WAS properties

Property Description
VirtualHostName Name of the WAS virtual host.

Type: Alphanumeric text string

Example: my_virtual_host
Default: default_host

WasAdminServer Name of the WAS administration server.

Type: Alphanumeric text string
Default: server1

WasHome Directory where WAS is installed.

Set by the installation program based on user input during installation.

Type: Directory path with elements delimited by forward slashes (/)

Example: /usr/WebSphere/AppServer.

WasUserHome Directory where WAS user data is created.

Set by the installation program based on user input during installation.

Type: Directory path with elements delimited by forward slashes (/)

Example: /usr/WebSphere/AppServer.

WasUserid The user ID for WAS security authentication.

If a value is specified for WasUserid, a value must also be specified for WasPassword. If WasUserid is left blank, WasPassword must also be left blank.

For LDAP configuration this value should not contain spaces.

Type: Alphanumeric text string

Examples: When using LDAP security:

IBM Directory Server: uid=wpsbind,cn=users,dc=setgetweb,dc=com
Domino: cn=wpsbind,o=setgetweb.com
Active Directory: cn=wpsbind,cn=users,dc=setgetweb,dc=com
SunOne: uid=wpsbind,ou=people,o=setgetweb.com
Novell eDirectory: uid=wpsbind,ou=people,o=setgetweb.com

 

Example: When using Custom User Registry (CUR):

  • CUR: wpsbind

Default: ReplaceWithYourWASUserID
WasPassword 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.

Type: Alphanumeric text string
Default: ReplaceWithYourWASUserPwd

WPSInstallLocation Directory where WebSphere Portal is installed.

Type: Directory path with elements delimited by forward slashes (/)

Example: /usr/WebSphere/AppServer

PrimaryNode Primary node in a clustered environment.

Do not change this property setting if you are not running a clustered environment.

Type: true, false

  • true - Master node
  • false - Not the master node

Default: true
CellName The WAS cell to which the WAS belongs.

Type: Alphanumeric text string
Default: cell

NodeName The node within the WAS cell to which the WAS belongs. This value must be unique among other node names in the same cell. Typically this value is the same as the host.name for the computer.

Type: Alphanumeric text string
Default: node

ServerName Name of the appserver where the WebSphere Portal application is deployed. This value must be unique among other appserver names in the same cell.

Type: Alphanumeric text string
Default: WebSphere_Portal

WpsHostName The fully-qualified host.name of the Web server that WAS is configured to use. Set by the installation program based on user input during installation.

http://WpsHostName:WpsHostPort/WpsContextRoot/WpsDefaultHome.

For example:

http://hostname.setgetweb.com:9081/wps/portal

Type: Host name, including domain

Example: hostname.setgetweb.com
Default: localhost

WpsHostPort Port number used to access the host machine identified by the WpsHostName property.

http://WpsHostName:WpsHostPort/WpsContextRoot/WpsDefaultHome

For example:

http://hostname.setgetweb.com:9081/wps/portal

Type: Port number
Default: 9081

WpsSoapPort The SOAP port used by WebSphere Portal Server

This property may not be used to reconfigure the SOAP port.

Type: Port number
Default: <none>

WpsAdminConsolePort Port used by WAS Administrative Console deployed on WebSphere Portal.

This property might not be used to reconfigure the WpsAdminConsolePort.

http://WpsHostName:WpsAdminConsolePort/admin

For example:

http://localhost:9091/admin

Type: Port number
Default: <none>

WpsAppName Name of the WebSphere Portal application, as deployed into WAS.

Type: Alphanumeric text string
Default: wps

WpsContextRoot The context root or base URI for the portal. All URLs beginning with this path will be reserved for the portal. The value of this property is part of the URL used to access WebSphere Portal from a browser:

http://WpsHostName:WpsHostPort/WpsContextRoot/WpsDefaultHome

Type: Alphanumeric text string

Example:

http://hostname.setgetweb.com:9081/wps/portal

Default: wps

WsrpContextRoot The context root or base URI for WSRP Producer.

Type: Alphanumeric text string
Default: wsrp

WpsDefaultHome The default portal page. This is the page for users who are not logged in. The value of this property is part of the URL used to access WebSphere Portal from a browser:

http://WpsHostName:WpsHostPort/WpsContextRoot/WpsDefaultHome

Type: Alphanumeric text string

Example:

http://www.setgetweb.com:9081/wps/portal

Default: portal
WpsPersonalizedHome Portal page for users who have already logged in to the portal. This page cannot be accessed by anonymous users. The value of this property is part of the URL used to access WebSphere Portal from a browser: http://WpsHostName:WpsHostPort/WpsContextRoot/WpsPersonalizedHome

Type: Alphanumeric text string

Example: http://hostname.setgetweb.com:9081/wps/myportal
Default: myportal

ContentAccessServiceProxyHost The fully-qualified hostname of the proxy server that WebSphere Portal should use, if the security configuration includes a proxy server.

Type: Host name, including domain

Example: proxyhostname.setgetweb.com
Default: <none>

ContentAccessServiceProxyPort Port number used to access the proxy server identified by the ContentAccessServiceProxyHost property.

Type: Port number
Default: <none>

[Back to top]

 

Java Properties

Property Value
JavaHome Directory where the WAS Java is installed.

Type: Directory path with elements delimited by forward slashes (/)

Example: /usr/WebSphere/AppServer

[Back to top]

 

Portal configuration properties

Property Value
PortalAdminId The user ID for the WebSphere Portal administrator.

For LDAP configuration this value should not contain spaces.

Type: Alphanumeric text string, conforming to the LDAP distinguished name format

Examples for LDAP:

IBM Directory Server: uid=<portaladminid>,cn=users,dc=setgetweb,dc=com
Domino: cn=<portaladminid>,o=setgetweb.com
Active Directory: cn=<portaladminid>,cn=users,dc=setgetweb,dc=com
SunOne: uid=<portaladminid>,ou=people,o=setgetweb.com
Novell eDirectory: uid=<portaladminid>,ou=people,o=setgetweb.com

Example for Custom User Registry (CUR): uid=<portaladminid>
Default: <none>

PortalAdminIdShort

The short form of the user ID for the WebSphere Portal administrator, as defined in the PortalAdminId property.

Type: Alphanumeric text string

Example: portaladminid
Default: <portaladminid>

PortalAdminPwd Password for the WebSphere Portal administrator, as defined in the PortalAdminId property.

Type: Alphanumeric text string

Example: theportaladminpwd
Default: <none>

PortalAdminGroupId The group ID for the group to which the WebSphere Portal administrator belongs.

Type: Alphanumeric text string, conforming to the LDAP distinguished name format

Examples for LDAP:

  • IBM Directory Server: cn=wpsadmins,cn=groups,dc=setgetweb,dc=com

  • Domino: cn=wpsadmins

  • Active Directory: cn=wpsadmins,cn=groups,dc=setgetweb,dc=com

  • SunOne: cn=wpsadmins,ou=groups,o=setgetweb.com

  • Novell eDirectory: cn=wpsadmins,ou=groups,o=setgetweb.com

Example for Custom User Registry (CUR): cn=wpsadmins,o=default organization
Default: cn=wpsadmins,o=default organization

PortalAdminGroupIdShort The short form of the group ID for the WebSphere Portal administrator, as defined in the PortalAdminGroupId property.

Type: Alphanumeric text string

Example: wpsadmins

Default: wpsadmins

PortalUniqueID An identifier that is unique to this Portal instance. Usually a MAC address from a communications adapter on this node.

Type: 12 hex digits
Default: 1234567890AB

CmConfigured Indicates whether content management functions are configured.

Type: true, false
Default: false

WpsContentAdministrators The group ID for the WebSphere Content Administrator group.

Type: Alphanumeric text string

Example values:

  • DEV (No security): WpsContentAdministrators=cn=wpsContentAdministrators,o=default organization

  • Member Manager User Repository database: WpsContentAdministrators=cn=wpsContentAdministrators,o=default organization

LDAP example values:

  • IBM Directory Server: cn=wpsContentAdministrators,cn=groups,dc=setgetweb,dc=com

  • Domino: cn=wpsContentAdministrators

  • Active Directory: cn=wpsContentAdministrators,cn=groups,dc=setgetweb,dc=com

  • SunOne: cn=wpsContentAdministrators,ou=groups,o=setgetweb.com

  • Novell eDirectory: cn=wpsContentAdministrators,ou=groups,o=setgetweb.com

Default: cn=wpsContentAdministrators,o=default organization
WpsContentAdministratorsShort The WebSphere Content Administrators group ID.

Type: Alphanumeric text string
Default: wpsContentAdministrators

wpsDocReviewer The group ID for the WebSphere Document Reviewer group

Type: Alphanumeric text string

Example values:

DEV (No security): WpsDocReviewer=cn=wpsDocReviewer,o=default organization
Member Manager User Repository database: WpsDocReviewer=cn=wpsDocReviewer,o=default organization

LDAP example values:

IBM Directory Server: cn=wpsDocReviewer,cn=groups,dc=setgetweb,dc=com
Domino: cn=wpsDocReviewer
Active Directory: cn=wpsDocReviewer,cn=groups,dc=setgetweb,dc=com
SunOne: cn=wpsDocReviewer,ou=groups,o=setgetweb.com
Novell eDirectory: cn=wpsDocReviewer,ou=groups,o=setgetweb.com

Default: cn=wpsDocReviewer,o=default organization

WpsDocReviewerShort The WebSphere Document Reviewer group ID.

Type: Alphanumeric text string
Default: wpsDocReviewer

[Back to top]

 

Dependency Checking Properties

Property Value
CheckVersions This property is used to enable/disable validation based on dependency rules. Most of the validations based on dependency rules deals with checking versions of installed components, for example WAS.

In most cases, this value should be set to true. (If a valid configuration is indicated as invalid, change the setting to false.)

Type: true, false
Default: true

DependencyRulesDirectory If you used special rules during the install process and some of the rules need to be used during configuration-time validation as well, you would use this property. It specifies a location of a unique set of rules to use for dependency rules based on validation tasks during configuration.

Type: Directory path with elements delimited by forward slashes (/)

Example: C:/Program Files/Cloudscape.
Default: <none>

[Back to top]

 

Database properties

Property Value
DbSafeMode This only applies to database-specific tasks. If set to true, database-specific tasks, such as create/modify/drop database, will not be performed. The property should be used if a pre-configured database (from a previous installation) already exists. If the property is set to false, the database will be updated and the pre-existing database configuration will be overwritten.

Type: true, false
Default: false

DbType The type of database used to store information for WebSphere Portal.

Type:

  • DB2: db2
  • Oracle: oracle
  • SQL Server: sqlserver
  • Cloudscape: cloudscape
  • DB2 for OS/390 and z/OS: db2_zos

Default: cloudscape
WpsDbName Database name where you want the WebSphere Portal objects created. (This value is also the database element in the DbUrl property.)

If you are configuring a remote DB2 for OS/390 and z/OS database, this property refers to the database subsystem. Name of the database is set with the WpsDbNameOnZos property.

Type: Alphanumeric text string

Notes:

  • For DB2 and DB2 for OS/390 and z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to the database documentation for more information.

  • If you change the name of the WebSphere Portal data source due to a database migration, manually update this property in the wp_root/config/wpconfig.properties file to maintain the proper the resource reference mapping.

Default: wpsdb
WpsDbNameOnZos Name of the WebSphere Portal database on DB2 for OS/390 and z/OS.

Required for DB2 for OS/390 and z/OS only.

  • If you are running DB2 for OS/390 and z/OS as a remote database, set this property to the name of the remote WebSphere Portal database.

Type: Alphanumeric text string
Default: WPSTST02

DbDriver Java class name for the JDBC provider. Alphanumeric text string, conforming to the Java namespace syntax for specifying classes. The following values can be specified:

Cloudscape: com.ibm.db2j.jdbc.DB2jDriver
DB2: COM.ibm.db2.jdbc.app.DB2Driver
DB2 for OS/390 and z/OS (remote): COM.ibm.db2.jdbc.app.DB2Driver
Oracle: oracle.jdbc.driver.OracleDriver
SQL Server: com.microsoft.jdbc.sqlserver.SQLServerDriver

Note that the above COM.* class name appears to be case sensitive. Strange.

Default: com.ibm.db2j.jdbc.DB2jDriver (Cloudscape)

DbDriverDs The data source for the JDBC provider that WebSphere Portal uses to communicate with its databases.

Alphanumeric text string, conforming to the Java namespace syntax for specifying classes. The following values can be specified:

Cloudscape: com.ibm.db2j.jdbc.DB2jXADataSource
DB2: COM.ibm.db2.jdbc.DB2XADataSource
DB2 for OS/390 and z/OS (remote): COM.ibm.db2.jdbc.DB2XADataSource
Oracle: oracle.jdbc.xa.client.OracleXADataSource
SQL Server: com.microsoft.jdbcx.sqlserver.SQLServerDataSource

Note that the COM.* data source is case sensitive. Strange.

Default: com.ibm.db2j.jdbc.DB2jXADataSource (Cloudscape)

JdbcProvider Name of the JDBC provider that WebSphere Portal uses to communicate with its databases.

Type: Alphanumeric text string
Default: wpsdbJDBC

DbUrl The database URL used to access the WebSphere Portal database with JDBC, where hostname is the name of the remote server and port is the port where the appropriate database instance is listening. The value must conform to standard JDBC URL syntax.

The database element of this value should match the value of WpsDbName.

Type: Alphanumeric text string, conforming to standard JDBC URL syntax

Example: jdbc:db2:wpsdb. The following values can be specified, where hostname indicates the server where the database is running:

  • Cloudscape: jdbc:db2j:wpsdb;create=true

  • DB2: jdbc:db2:wpsdb

  • DB2 for OS/390 and z/OS (remote): jdbc:db2:wpsdb

  • Oracle: jdbc:oracle:thin:@YourDatabaseServer:1521:wpsdb

  • SQL Server: jdbc:microsoft:sqlserver://YourDatabaseServer:1433;DatabaseName=wpsdb

Default: jdbc:db2j:wpsdb;create=true (Cloudscape)
DbUser The user ID for the database administrator.

Type: Alphanumeric text string
Default: db2admin

DbPassword Password for the database administrator.

Type: Alphanumeric text string
Default: ReplaceWithYourDbAdminPwd

DbLibrary The directory path where the classes for the JDBC provider are located.

Type: Directory path with elements delimited by forward slashes (/)

In UNIX environments, use a colon (:) instead of a semi-colon (;) to separate multiple paths.

Example:

Cloudscape: $WAS_HOME/PortalServer/shared/app/cloudscape/db2j.jar
DB2: SQLLIB/java/db2java.zip
Oracle: $ORACLE_HOME/jdbc/lib/ojdbc14.jar
SQL Server: SQLServerJDBC/lib/mssqlserver.jar
SQLServerJDBC/lib/msbase.jar
SQLServerJDBC/lib/msutil.jar

WpsDsName Name of the data source that WebSphere Portal uses to communicate with its databases.

If the WebSphere Portal data source name is changed due to database migration, which is reflected in...

wp_root/config/wpconfig.properties

...update the resource mappings by executing the following steps:

  1. Login to the WAS Administrative Console.

  2. Select...

    Application | Enterprise Applications | PortalApplication | Map resource references to resources

  3. Change the JNDI Name for reference binding jdbc/wpsDS to specify the new data source name.

  4. Click OK.

  5. Save the configuration changes.

Type: Alphanumeric text string
Default: wpsdbDS

WpsXDbName TCP/IP alias for the database to be used as data source name.

Required for non-Windows systems only.

Type: Alphanumeric text string
Default: wps5TCP

WpsDbNode This value is the node for the WebSphere Portal database

Type: Alphanumeric text string
Default: wpsNode

[Back to top]

 

Portal Information Sequence properties

Property Value
DcsRemoteHost The URL of the remote host that provides document conversion services. When Document Conversion Services have been delegated to a different host on the network, this property is used to specify the hostname of the machine.

Type: Alphanumeric text string

Example: DcsRmoteHost=http://myremotehost1:9080/dcs/dcs
Default: http://remotehostname:9080/dcs/dcs

[Back to top]

 

DB2 Content Manager Runtime Edition properties

Property Value
JcrDbName Name of the WebSphere Portal database for DB2 Content Manager Runtime Edition tables. (This value should also appear as the database element in JcrDbUrl.)

For remote DB2 for OS/390 and z/OS only, this setting represents the location name of the subsystem for the DB2 Content Manager Runtime Edition database on z/OS.

Type: Alphanumeric text string
Default: jcrdb

JcrDbUser 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.

Type: Alphanumeric text string
Default: icmadmin

JcrDbPassword The DB2 Content Manager Runtime Edition database administrator password.

Type: Alphanumeric text string
Default: ReplaceWithYourDbAdminPwd

JcrDbSaPassword The SQL Server System Administrator (SA) password. This password may not be the same as the password for the user that created the DB2 Content Manager Runtime Edition tables on this database.

Required for SQL Server only.

Type: Alphanumeric text string
Default: ReplaceWithYourDbAdminPwd

JcrDbUrl The URL used to access the DB2 Content Manager Runtime Edition database with JDBC.

The database element of this value should match the value of JcrDbName.

Type: Alphanumeric text string, conforming to standard JDBC URL syntax

Example: jdbc:db2:jcrdb. The following values can be specified, where hostname indicates the server where the database is running:

  • Cloudscape: jdbc:db2j:jcrdb;create=true

  • DB2: jdbc:db2:jcrdb

  • DB2 for OS/390 and z/OS: jdbc:db2:jcrdb

  • Oracle: jdbc:oracle:thin:@YourDatabaseServer:1521:jcrdb

  • SQL Server: jdbc:microsoft:sqlserver://YourDatabaseServer:1433;DatabaseName=jcrdb

Default: jdbc:db2j:jcrdb;create=true (Cloudscape)
JcrXDbName TCPIP Alias for the database.

Required for Non-Windows platforms when using DB2 only.

Value Type: Alphanumeric text string
Default: jcrdbTCP

JcrDbNode The node for the DB2 Content Manager Runtime Edition database.

Required for Non-Windows platforms when using DB2 only.

Value Type: Alphanumeric text string
Default: icmNode

JcrJdbcProvider Name of JDBC provider to be used for DB2 Content Manager Runtime Edition.

Type: Alphanumeric text string
Default: jcr51JDBC

JcrDsName Name of datasource to be used for DB2 Content Manager Runtime Edition.

If the WebSphere Portal data source name is changed due to database migration, which is reflected in wp_root/config/wpconfig.properties, update the resource mappings by executing the following steps:

  1. Login to the WAS Administrative Console.

  2. Select Application>Enterprise Applications.

  3. Select the WebSphere Portal application.

  4. Select the Map resource references to resources option.

  5. Change the JNDI Name for reference binding jdbc/wpsDS to specify the new data source name.

  6. Click OK.

  7. Save the configuration changes.

Type: Alphanumeric text string
Default: JCRDS

JcrGeneratedDDLPath Directory for the dynamic DDL files generated by DB2 Content Manager Runtime Edition.

Type: File directory path

Example: D:\wp_root\jcr\config\dynamic

(where wp_root is the installation directory of WebSphere Portal)
Default: ${WpsInstallLocation}/jcr/config/dynamic

(where ${WpsInstallLocation} is the installation directory of WebSphere Portal)

JcrBinaryValueFileDir Directory for the binary value files for DB2 Content Manager Runtime Edition.

Type: File directory path
Default: ${WpsInstallLocation}/jcr/binaryValues

JcrDebugLevel Debug level for DB2 Content Manager Runtime Edition database utilities. This property can be set to one of the following values:

    0 - INFO, prints status information

    1 - TRACE, provide method entry-exit information + INFO.

    2 - DEBUG, display command information and SQL statement output information.

    3 - DEBUG+, display processing information of DDL file as well as command that are been executed.

Type: 0, 1, 2, 3
Default: 2

JcrDbUnicode This property indicates whether or not the DB2 Content Manager Runtime Edition database is unicode.

Type: Y, N

    Y - is unicode

    N - is NOT unicode


Default: Y
JcrDbNameOnZos

 Name of the WebSphere Portal database on DB2 for OS/390 and z/OS used to store DB2 Content Manager Runtime Edition data.

Required for DB2 for OS/390 and z/OS only.

Type: Alphanumeric text string
Default: jcrdbzos

JcrDbHost The hostname (only) of remote system hosting the DB2 Content Manager Runtime Edition database.

Required for DB2 for OS/390 and z/OS only

Type: Alphanumeric text string
Default: hostname

JcrDbDomain The domain (not including hostname) of remote system hosting the DB2 Content Manager Runtime Edition database.

Required for DB2 for OS/390 and z/OS only

Type: Alphanumeric text string
Default: setgetweb.com

JcrBPCServerName

 Name of appserver with a configured Business Process Container.

Type: Alphanumeric text string
Default: server1

JcrJMSJAASUser

 User id for the Java Message Service (JMS) that the workflow engine will use to communicate with the DB2 Content Manager Runtime Edition.

Type: Alphanumeric text string
Default: ReplaceWithYourJMSUserId

JcrJMSJAASPassword

 Password for JcrJMSJAASUser.

Type: Alphanumeric text string
Default: ReplaceWithYourJMSPwd

JcrJMSType

 Type of Java Message Service (JMS) provider used.

Type: mq, embedded

    mq = WebSphere MQ JMS Provider

    embedded = WebSphere JMS Provider


Default: embedded
JcrMQQueueManager

 Name of the WebSphere MQ Queue Manager. This value is not needed for WebSphere Embedded Messaging.

Type: Alphanumeric text string
Default: <none>

[Back to top]

Personalization and Feedback Database properties
Property Description
InitializeFeedbackDb Specifies whether the Feedback schema and tables will be created on transfer.

Type: Boolean

  • false: To share a Feedback database across multiple instances of WebSphere Portal or to use a Feedback database that was initialized with a previous installation of WebSphere Portal, set this property to false and configure the remaining Feedback properties according to the pre-existing database. The data contained in the existing Feedback schema will then be preserved.

  • true: If set to true, then any existing Feedback database will be dropped and a new database will be created from scratch.

Default: true
PznDbNode

The node for the Feedback database.

Must be set for all non-Windows platforms when using DB2.

Type: Alphanumeric text string
Default: pznNode

FeedbackXDbName TCP/IP alias for the Feedback database. This value is used to specify the data source on machines that are not running Windows.

Must be set for all non-Windows platforms when using DB2.

Type: Alphanumeric text string
Default: fdbk5TCP

FeedbackDbHostName Fully-qualified host.name of the database server that is hosting the Feedback database.

Required for:

Type: Alphanumeric text string
Default: myserver

FeedbackDbName Name of the Feedback database. Storing Feedback data on the WebSphere Portal database is recommended. However, if you choose to store Feedback data in a separate database, change the default value to a new value such as fdbkdb. (This value is also the database element in the FeedbackDbUrl property.)

If you are configuring a remote DB2 for OS/390 and z/OS database, this property should refer to the database subsystem. Name of the database is set with the FeedbackDbNameOnZos property.

Type: Alphanumeric text string

For DB2 and DB2 for OS/390 and z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to the database documentation for more information.
Default: wpsdb

FeedbackDbNameOnZos Name of the remote Personalization Feedback database for DB2 for OS/390 and z/OS only.

Required only if using DB2 for OS/390 and z/OS as a remote database.

Type: Alphanumeric text string
Default: fdbk5zos

FeedbackDbTablespace Name of the Feedback database tablespace.

Required only if running on DB2 for OS/390 and z/OS, or if using DB2 for OS/390 and z/OS as a remote database.

Type: Alphanumeric text string
Default: fdbkdbts

FeedbackDbUser Database user for the Feedback database. This property is required for:

  • DB2

  • DB2 for OS/390 and z/OS

For SQL Server and Oracle, this value must be set to FEEDBACK, which corresponds to the user "FEEDBACK" in the SQL Server and Oracle database.

Type: Alphanumeric text string
Default: wcmdbadm

FeedbackDbPassword Database password for feedback database.

Type: Alphanumeric text string
Default: ReplaceWithYourDbAdminPwd

FeedbackDbUrl Database URL used to access the feedback database with JDBC, where hostname is the name of the remote server and portnumber is the port where the appropriate database instance is listening. The value must conform to the standard JDBC URL syntax.

The database element of this value should match the value of FeedbackDbName.

Type: Alphanumeric text string, conforming to standard JDBC URL syntax

Example: jdbc:db2:wcm. The following values can be specified, where hostname indicates the server where the database is running, portnumber indicates the port on which the database is communicating, and dbname indicates the name of the database as specified in the FeedbackDbName property.

  • Cloudscape: jdbc:db2j:fdbkdb;create=true

  • DB2: jdbc:db2:dbname

  • Oracle: jdbc:oracle:thin:@YourDatabaseServer:1521:fdbkdb

  • SQL Server: jdbc:microsoft:sqlserver://YourDatabaseServer:1433;DatabaseName=fdbkdb

Default: jdbc:db2j:fdbkdb;create=true (Cloudscape)

[Back to top]

 

Likeminds Database properties

Property Description
LikemindsXDbName TCPIP Alias for the LikeMinds database. This value is used to specify the data source on machines that are not running Windows.

Required for Non-Windows platforms when using DB2 only.

Type: Alphanumeric Text String
Default: lmdb5TCP

LikemindsDbHostName The fully-qualified host.name of the database server that is hosting the Likeminds database.

Required for:

Type: Alphanumeric text string
Default: myserver

LikemindsDbName Name of the Likeminds database. Storing Likeminds data on the WebSphere Portal database is recommended. However, if you choose to store Likeminds data in a separate database, change the default value to a new value such as lmdb. (This value is also the database element in the LikemindsDbUrl property.)

If you are configuring a remote DB2 for OS/390 and z/OS database, this property refers to the database subsystem. Name of the database is set with the LikemindsDbNameOnZos property.

DB2 note: For DB2 and DB2 for OS/390 and z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to the database documentation for more information.

Type: Alphanumeric text string
Default: wpsdb

LikemindsDbNameOnZos Name of the remote Likeminds database.

Required only if using DB2 for OS/390 and z/OS as a remote database.

Type: Alphanumeric text string
Default: lmdb5zos

LikemindsDbTablespace Name of the Likeminds database tablespace.

Required only if running on DB2 for OS/390 and z/OS, or if using DB2 for OS/390 and z/OS as a remote database.

Type: Alphanumeric text string
Default: lmdbts

LikemindsDbUser The database user for Likeminds database.

This property is required for

  • DB2

  • DB2 for OS/390 and z/OS

Type: Alphanumeric text string
Default: lmadmin

LikemindsDbPassword The database password for Likeminds database.

Type: Alphanumeric text string
Default: ReplaceWithYourDbAdminPwd

LikemindsDbUrl The database URL used to access the Likeminds database with JDBC, where hostname is the name of the remote server and portnumber is the port where the appropriate database instance is listening. The value must conform to the standard JDBC URL syntax.

The database element of this value should match the value of LikemindsDbName.

Type: Alphanumeric text string, conforming to standard JDBC URL syntax

Example: jdbc:db2:wcm. The following values can be specified, where hostname indicates the server where the database is running, portnumber indicates the port on which the database is communicating, and dbname indicates the name of the database as specified in the FeedbackDbName property.

  • Cloudscape: jdbc:db2j:lmdb;create=true

  • DB2: jdbc:db2:lmdb

  • Oracle: jdbc:oracle:thin:@wps10:1521:lmdb

  • SQL Server: jdbc:microsoft:sqlserver://YourDatabaseServer:1433;DatabaseName=lmdb

Default: jdbc:db2j:wpsdb;create=true (Cloudscape)

[Back to top]

 

Member Manager properties

Property Description
WmmDsName Name of the data source that WebSphere Portal uses to communicate with the Member Manager database.

Type: Alphanumeric text string
Default: wmmDS

WmmAppName Name of the Member Manager enterprise application, as deployed into WAS.

Type: Alphanumeric text string
Default: wmmApp

WmmDbName Name of the Member Manager database. This value is also the database element in the WmmDbUrl property.

If WebSphere Portal V5.1 and a previous version of WebSphere Portal coexist on the same box, this value must be different than the WebSphere Member Services database name in the previous version of WebSphere Portal.

DB2 note: For DB2 and DB2 for OS/390 and z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to the database documentation for more information.

Type: Alphanumeric text string
Default: wpsdb

WmmDbNameOnZos Name of the remote Member Manager database for DB2 for OS/390 and z/OS only.

Required only if using DB2 for OS/390 and z/OS as a remote database.

Type: Alphanumeric text string
Default: wps5zos

WmmDbUser The user ID for the database administrator.

If you are migrating from a previous version of WebSphere Portal, this value must match the database user name for the WebSphere Member Services database from the previous WebSphere Portal version.

Type: Alphanumeric text string
Default: ReplaceWithYourDbAdminId

WmmDbPassword Password for the database administrator.

Type: Alphanumeric text string
Default: ReplaceWithYourDbAdminPwd

WmmDbUrl The database URL used to access the Member Manager database with JDBC. The value must conform to standard JDBC URL syntax.

The database element of this value should match the value of WmmDbName. On z/OS, the database element of this value should match the location name of the database to be used when establishing connections with the DB2 datasource used by WebSphere Portal.

Type: Alphanumeric text string, conforming to standard JDBC URL syntax

Example: jdbc:db2:wmmdb. The following values can be specified, where hostname indicates the server where the database is running:

  • Cloudscape: jdbc:db2j:wpsdb;create=true

  • DB2: jdbc:db2:wpsdb

  • DB2 for OS/390 and z/OS (remote): jdbc:db2:wpsdb

  • Oracle: jdbc:oracle:thin:@YourDatabaseServer:1521:wpsdb

  • SQL Server: jdbc:microsoft:sqlserver://YourDatabaseServer:1433;DatabaseName=wpsdb

Default:jdbc:db2j:wpsdb;create=true (Cloudscape)
WmmEjbName The Enterprise Java Bean (like a classname) that other applications need to know it in order to communicate with it.

Type: Alphanumeric text string
Default: ejb/MemberServiceHome

[Back to top]

 

Lotus Collaborative Components Properties

Property Description
LCC.QuickPlace.Enabled Determines whether Lotus Lotus Team Workplace is enabled.

Type: true, false
Default: false

LCC.QuickPlace.Server Name of the Lotus Team Workplace server.

Type: Alphanumeric text string; must be the hostname or IP address
Default: my.server.com

LCC.QuickPlace.Protocol Protocol used to connect to the Lotus Team Workplace server.

Type: http, https
Default: http

LCC.QuickPlace.Port Port number for the Lotus Team Workplace server.

Type: Alphanumeric text string
Default: 80

LCC.Sametime.Enabled Determines whether IBM Lotus Instant Messaging and Web Conferencing is enabled.

Type: true, false
Default: false

LCC.Sametime.Server Name of the IBM Lotus Instant Messaging and Web Conferencing server.

Type: Alphanumeric text string; must be the hostname or IP address
Default: my.server.com

LCC.Sametime.Protocol Protocol used to connect to the IBM Lotus Instant Messaging and Web Conferencing server.

Type: http, https
Default: http

LCC.Sametime.Port Port number for the IBM Lotus Instant Messaging and Web Conferencing server.

Type: Alphanumeric text string
Default: 80

LCC.DiscoveryServer.Enabled Determines whether Lotus DiscoveryServer is enabled.

Type: true, false
Default: false

LCC.DiscoveryServer.Server Name of the Lotus DiscoveryServer server.

Type: Alphanumeric text string; must be the hostname or IP address
Default: my.server.com

LCC.DiscoveryServer.Protocol Protocol used to connect to the Lotus DiscoveryServer server.

Type: http, https
Default: http

LCC.DiscoveryServer.Port Port number for the Lotus DiscoveryServer server.

Type: Alphanumeric text string
Default: 80

LCC.DominoDirectory.Enabled Determines whether Lotus DominoDirectory is enabled.

Type: true, false
Default: false

LCC.DominoDirectory.Server Name of the Lotus DominoDirectory server.

Type: Alphanumeric text string; must be the hostname or IP address
Default: my.server.com

LCC.DominoDirectory.Port Port number for the Lotus DominoDirectory server.

Type: Alphanumeric text string
Default: 80

LCC.DominoDirectory.SSL Enable or disable the SSL connection to the Domino Directory

Type: true, false
Default: false

[Back to top]

 

WebSphere Portal Security LTPA and SSO configuration

Property Description
LTPAPassword Password for the LTPA bind.

Type: Alphanumeric text string
Default: <none>

LTPATimeout Number of minutes after which an LTPA token will expire.

Type: Numeric text string
Default: 120

SSORequiresSSL Specifies that Single Sign-On function is enabled only when requests are over HTTPS Secure Socket Layer (SSL) connections.

Type: true, false
Default: false

SSODomainName Domain name for all allowable single signon host domains.

  • Enter the part of the domain that is common to all servers that participate in single signon. For example, if WebSphere Portal has the domain...

    minneapolis.us.setgetweb.com

    ... and another server has the domain...

    stpaul.us.setgetweb.com

    ...enter setgetweb.com.

  • To specify multiple domains, use a semicolon ; to separate each domain name. For example, setgetweb.com;ibm.com.

Single signon (SSO) is achieved via a cookie that is sent to the browser during authentication. When connecting to other servers in the TCP/IP domain specified in the cookie, the browser sends the cookie. If no domain is set in the cookie, the browser will only send the cookie to the issuing server.

Type: Fully-qualified domain name
Default: <none>

[Back to top]

 

General Global Security Settings

Property Value
useDomainQualifiedUserNames Specifies if the user names should be qualified with the security domain where they reside. If set to true, AppServer will qualify user names with the security domain where they reside. If set to false, the security domain is not returned.

Type: true, false
Default: false

cacheTimeout Timeout value, in seconds, for the security cache.

Type: Alphanumeric text string, greater than 30
Default: 600

issuePermissionWarning Prompts for user credentials.

Type: true, false
Default: true

activeProtocol Active server level security authentication protocol that RMI/IIOP requests when security is enabled.

Type: CSI, BOTH

If all servers in the security domain are V5.0, it is best to specify Common Secure Interoperability (CSI) as the protocol. If some servers are V3.x or 4.x, it is best to specify BOTH, which specifies both CSI and Secure Authentication Service (SAS).
Default: BOTH

activeAuthMechanism Authentication mechanism for WAS.

Currently LTPA is the only supported mechanism within WebSphere Portal.

[Back to top]

 

Custom User Registry Configuration

Property Value
CUClassName Name of the class that implements the registry.

Type: Depends on the specific application
Default: com.ibm.websphere.wmm.registry.WMMCustomRegistry

[Back to top]

 

LDAP Properties Configuration

Property Value
LookAside You can either install with LDAP only or with LDAP using a Lookaside database. The purpose of a Lookaside database is to store attributes which cannot be stored in the LDAP server; this combination of LDAP plus a Lookaside database is needed to support Member Manager.

To enable a Lookaside database, set this property to true. If you intend to use a Lookaside database, set this value before configuring security, as it cannot be configured after security is enabled.

Using a Lookaside database can slow down performance.

Type: true, false

    true - LDAP + Lookaside database

    false - LDAP only


Default: false
WmmDefaultRealm The default realm of the Member Manager user registry (UR) configuration. Set this property before enabling security with enable-security-wmmur-ldap or enable-security-wmmur-db.

Type: Alphanumeric text string
Default: portal

LDAPHostName The host information for the LDAP server that WebSphere Portal will use.

Type: Fully qualified host.name of the LDAP server
Default: theldapserver.com

LDAPPort The server port of the LDAP directory.

Type: Alphanumeric text string

Example: 389 for non-SSL or 636 for SLL
Default: 389

LDAPAdminUId The user ID for the administrator of the LDAP directory. Member Manager uses this ID to bind to the LDAP to retrieve users attributes, create new users and groups in the LDAP and update user attributes. This ID is not required to be the LDAP admin DN, but rather an ID with sufficient authority for the use cases just cited. If this property is omitted, the LDAP is accessed anonymously and read-only.

Type: Alphanumeric text string, conforming to the LDAP distinguished name format. For example, cn=userid.
Default: cn=root

LDAPAdminPwd Password for the LDAP directory administrator, as defined in the LDAPAdminUId property. If the LDAPAdminUId is blank, this property must be blank as well.

Type: Alphanumeric text string
Default: <none>

LDAPServerType The type of LDAP Server to be used.

Type:


Default: IBM_DIRECTORY_SERVER
LDAPBindID The user ID for LDAP Bind authentication. This user ID is used by WAS to bind to the LDAP to retrieve user attributes required for authentication. If this property is omitted, the LDAP is access anonymously and is then read-only.

Type:


Default: uid=wpsbind,cn=users,dc=setgetweb,dc=com
LDAPBindPassword Password for LDAP Bind authentication. If the LDAPBindID is blank, this property must be blank as well.

Type: Alphanumeric text string
Default: <none>

WmmSystemID The fully-qualified distinguished name (DN) of a user in the LDAP. This DN is stored in the credential vault for PUMA's use to access the Member Manager Enterprise Java Bean (EJB). The Member Manager EJB is secured by WAS Security starting with WebSphere Portal 5.1. An authenticated security context is now established before WebSphere Portal can access Member Manager.

For an LDAP configuration, this value should not contain spaces and must not contain any suffixes in the custom user registry case.

Value type, where wmmsystemid is the Member Manager user registry database:


Default: <none>
WmmSystemIdPassword Password for LDAP Bind authentication.

Type: Alphanumeric text string
Default: <none>

[Back to top]

 

Advanced LDAP Configuration

Property Value
LDAPSuffix The LDAP Suffix. Choose a value appropriate for the LDAP server. This is the distinguished name (DN) of the node in the LDAP containing all user and group information for the Portal being configured. As such, it is the lowest container in the LDAP tree still containing all users that will log into the Portal and all Portal groups.

If WAS configuration tasks (e.g., enable-security-ldap) are used to activate WAS Security, this value will be used as the single Base Distinguished Name for the Application Server LDAP configuration. This value will be qualified with the LDAPUserSuffix and LDAPGroupSuffix values in order to configure Member Manager.

Type:
Default: dc=setgetweb,dc=com

LdapUserPrefix The RDN prefix attribute name for user entries. Choose a value appropriate for the LDAP server.

Type:


Default: uid
LDAPUserSuffix The DN suffix attribute name for user entries. Choose a value appropriate for the LDAP server. With the "LDAPSuffix" appended to this value, it is the DN of the common root node in the LDAP containing all user information for the Portal being configured. As such, it is the lowest container in the LDAP tree still containing all users that will log into the Portal including the Portal admin users (e.g., wpsadmin and wpsbind).

Type:


Default: cn=users
LdapGroupPrefix The RDN prefix attribute name for group entries.

Type: cn
Default: cn

LDAPGroupSuffix The DN suffix attribute name for group entries. Choose a value appropriate for the LDAP server. With the "LDAPSuffix" appended to this value, it is the DN of the common root node in the LDAP containing all group information for the Portal being configured. As such, it is the lowest container in the LDAP tree still containing all group entries for the Portal including the Portal admin group (e.g., wpsadmins).

Type:


Default: cn=groups
LDAPUserObjectClass The LDAP object class of the Portal users in the LDAP directory that will log into the Portal being configured.

Type:


Default: inetOrgPerson
LDAPGroupObjectClass The LDAP object class of all the groups in the LDAP directory that the Portal will access.

Type:


Default: groupOfUniqueNames
LDAPGroupMember The attribute name in the LDAP group object of the "membership" attribute. Choose a value appropriate for the LDAP server.

Type:


Default: uniqueMember
LDAPUserFilter The filter used by WAS for finding users in the LDAP.

Type:

  • IBM Tivoli Directory Server: (&(uid=%v)(objectclass=inetOrgPerson))

  • Domino: (&(|(cn=%v)(uid=%v))(objectclass=dominoPerson))

  • Domino 5.x without dominoUNID: (&(|(cn=%v)(uid=%v))(objectclass=inetOrgPerson))

  • Active Directory: (&(|(cn=%v)(samAccountName=%v))(objectclass=user))

  • Sun ONE: (&(uid=%v)(objectclass=inetOrgPerson))

  • Novell eDirectory: (&(uid=%v)(objectclass=inetOrgPerson))

Default: (&(uid=%v)(objectclass=inetOrgPerson))
LDAPGroupFilter The filter used by WAS for finding groups in the LDAP.

Type:

  • IBM Tivoli Directory Server: (&(cn=%v)(objectclass=groupOfUniqueNames))

  • Domino: (&(cn=%v)(objectclass=dominoGroup))

  • Domino 5 without dominoUNID: (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)(objectclass=dominoGroup)))

  • Active Directory: (&(cn=%v)(objectclass=group))

  • Sun ONE: (&(cn=%v)(objectclass=groupOfUniqueNames))

  • Novell eDirectory: (&(cn=%v)(objectclass=groupOfUniqueNames))

Default: (&(cn=%v)(objectclass=groupOfUniqueNames))
LDAPGroupMinimumAttributes These attributes are loaded for group search related to performance issues. This is an advanced configuration property, and this value is typically not required to change.

Type: Empty
Default: <none>

LDAPUserBaseAttributes These attributes are loaded for user login related to performance issues. This is an advanced configuration property, and this value is typically not required to change.

Type: Depends on the specific application
Default: cn,givenName,sn,preferredLanguage

LDAPUserMinimumAttributes These attributes specify the minimum user attributes and are loaded for user search related to performance issues.

Type: Depends on the specific application
Default: cn

LDAPsearchTimeout The timeout value, in seconds, for an LDAP server to respond before aborting a request.

Type: Numeric text string
Default: 120

LDAPreuseConnection Specifies whether the LDAP connection can be reused. If a load balancer is placed in front of the LDAP server farm and the connection is held across LDAP binds, this value should be set to false; otherwise use true.

Type: true, false
Default: true

LDAPIgnoreCase Specifies whether the LDAP search is case-sensitive or ignores case.

Type: true, false
Default: true

LDAPsslEnabled Specifies whether Secure Sockets communications is enabled for the LDAP server.

Type: true, false
Default: false

[Back to top]

 

WebSphere Translation Server Properties

Property Value
WTSserverPortList Port for the WebSphere Translation Server.

The entire list will be updated with the new value; it will not be appended to the existing values.

Type: Alphanumeric text string
Default: hostname: portname

[Back to top]

 

Properties for Advanced Security Configuration using External Security Managers

 

Namespace management parameters common to TAM and SiteMinder

Property Value
EACserverName

EACcellName

EACappName

(Optional) Namespace context information to further distinguish externalized portal role names from other role names in the external security manager namespace. This context information will be added to the namespace entry created upon role externalization.

If any of the 3 context values are null, none will be used.

Suggestion: If you choose to use the namespace context delimiters, use the WAS values for cellname, server name, and application name to ensure adequate differentiation in namespace entries.

Type: Alphanumeric text string
Default values:

    EACserverName=WebSphere_Portal

    EACcellName=vmwtest

    EACappName=wps

reorderRoles This field will allow you to either have the externalized Portal rolenames displayed with the resource type first or the role types first.

Examples:

  • true - the TAM namespace or SiteMinder protected resource would look similar to: 

    
 /WPSv51/wps.CONTENT_NODE/Welcome_Page/10_2E@Administrator/wps/WebSphere_Portal/vmwtest
 /WPSv51/wps.CONTENT_NODE/Welcome_Page/10_2E@Editor/wps/WebSphere_Portal/vmwtest
 /WPSv51/wps.CONTENT_NODE/Administration/15_AF@Administrator/wps/WebSphere_Portal/vmwtest
 /WPSv51/wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q@Administrator/wps/WebSphere_Portal/vmwtest
 /WPSv51/wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q@User/wps/WebSphere_Portal/vmwtest

  • false - the TAM namespace or SiteMinder protected resource would look similar to: 

    
 /WPSv51/Administrator@wps.CONTENT_NODE/Welcome_Page/10_2E/wps/WebSphere_Portal/vmwtest
 /WPSv51/Administrator@wps.CONTENT_NODE/Administration/15_AF/wps/WebSphere_Portal/vmwtest
 /WPSv51/Administrator@wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q/wps/WebSphere_Portal/vmwtest
 /WPSv51/Editor@wps.CONTENT_NODE/Welcome_Page/10_2E/wps/WebSphere_Portal/vmwtest
 /WPSv51/User@wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q/wps/WebSphere_Portal/vmwtest

Type: true, false
Default: false

 

Tivoli Access Manager: AMJRTE connection parameters

Property Value
PDAdminId The 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.

Type: Alphanumeric text string
Default: sec_master

PDAdminPw Password for the administrative TAM user.

Type: Alphanumeric text string
Default: ReplaceWithYourTAMAdminPwd

PDPermPath The location of the TAM AMJRTE properties file. This properties file is created by the TAM SvrSslCfgcommand and contains information such as: Policy Server hostname, ports, version of AMJRTE, path to encryption keys.

Type: Directory path with elements delimited by forward slashes (/)
Default: C:/WebSphere/AppServer/java/jre/PdPerm.properties

 

Tivoli Access Manager: SvrSslCfg command parameters

Property Value
PDServerName Unique application name used to create a new Tivoli server in the Access Manager Policy Server. This server will appear in the pdadmin server list after running the SvrSslCfg command.

If a server with the same name appears in the server list command, the SvrSslCfg command will fail.

Type: Alphanumeric text string
Default: amwps5

SvrSslCfgPort Configuration port for the application name. This parameter is currently ignored by the SvrSslCfg command.

Type: Numeric text string
Default: 7223

SvrSslCfgMode Configuration mode of the SvrSslCfg command. Currently, the only valid value is remote.

Type: remote
Default: remote

TamHost Defines the TAM Policy Server used when running PDJrteCfg.

Type: Alphanumeric text string; must be the hostname or IP address
Default: TAM.Policy.Server.hostname

PDPolicyServerList Defines a hostname, port, and priority combinations for the TAM Policy servers used when running SvrSslCfg. The format of this property is host:port:priority. For example, hosta.ibm.com:7135:1 or host1.ibm.com:7135:1, hostb.7135:2.

Type: Alphanumeric text string; must be the hostname or IP address with port and priority
Default: TAM.Policy.Server.hostname:7135:1

PDAuthzServerList Defines a hostname, port, and priority combination for the TAM authorization servers. The format of this property is host:port:priority. For example, hosta.ibm.com:7136:1.

Type: Alphanumeric text string; must be the hostname or IP address with port and priority
Default: TAM.Authorization.Server.hostname:7136:1

PDKeyPath Stores encryption keys used for the SSL communication between AMJRTE and Tivoli Access Manager. This file is generated as a result of the SvrSslCfg command.

Type: Directory path with elements delimited by forward slashes (/)
Default: C:/WebSphere/AppServer/java/jre/lib/security/pdperm.ks

 

Tivoli Access Manager: WebSEAL junction parameters

Property Value
JunctionType The type of junction to be created in TAM. Accepted values are tcp and ssl.

Type: tcp, ssl
Default: tcp

JunctionPoint The WebSEAL junction point to the WebSphere Portal instance.

Type: Alphanumeric text string
Default: /WPSv51

WebSealInstance WebSEAL instance used to create the junction. You can view different WebSEAL instances by issuing a server list from the pdadmin> command line.

Type: Alphanumeric text string; must be the hostname or IP address
Default: instance-webseald-thehost.com

TAICreds The headers inserted by WebSEAL that the TAI uses to identify the request as originating from WebSEAL.

Notes:

  • Inclusion of these headers is associated with the headers used by the WAS TAI to identify the request as one from WebSEAL.

  • If you are configuring Portal to use TAM as an external authorization engine, include at least the iv-user and iv-creds headers.

Type: Alphanumeric text string
Default: iv-user,iv-creds

 

Tivoli Access Manager: WAS WebSEAL TAI parameters

Property Value
WebSealHost Optional parameter that sets the WebSEAL TAI's hostnames parameter. You should include the hostname you provided when configuring the WebSEAL instance. Consider the following:

  • This value is case-sensitive.

  • This value may be a comma delimited list if more than one hostname is provided.

  • The default behavior when configuring a WebSEAL instance is to use the network short name. For example, hosta.setgetwebmpany.com may be represented as hosta when the WebSEAL instance is configured.

  • If any additional proxies are included, their hostnames must be added as well.

Presence of a this parameters will cause the TAI to evaluate the VIA header and only handle those requests that contain one of the provided hostname, and port combinations.

Include both the fully-qualified hostname as well as the short name in this comma-delimited list.

Type: Alphanumeric text string, comma-delimited
Default: <none>

WebSealPort Optional parameter that sets the WebSEAL TAI's ports parameter. (The default WebSEAL port is 443.) Presence of a this parameters will cause the TAI to evaluate the VIA header and only handle those requests that contain one of the provided hostname, and port combinations.

You should include the WebSEAL ports in this comma delimited list.

Type: Alphanumeric text string, comma-delimited
Default: <none>

WebSealUser When you create a TCP junction, this is the WebSEAL identity representing the reverse proxy on every request. WAS will use this identity to establish the "trust" that is required to validate the WebSEAL iv-* headers. The password for this user should be set in the WebSEAL instance's webseald.conf on the basicauth-dummy-passwd property.

Type: Alphanumeric text string
Default: wpsadmin

BaUserName When you create an SSL junction, this is the WebSEAL identity representing the reverse proxy on every request. WAS will use this identity to establish the "trust" that is required to validate the WebSEAL iv-* headers.

Type: Alphanumeric text string
Default: wpsadmin

BaPassword When you create an SSL junction, you can provide a password to the identity representing the reverse proxy on every request. WAS will use this identity to establish the "trust" that is required to validate the WebSEAL iv-* headers.

Type: Alphanumeric text string
Default: wpsadmin

 

Tivoli Access Manager: Portal authorization parameters

Property Value
PDRoot Root objectspace entry in the TAM namespace. All Portal roles will be installed under this objectspace entry.

Type: Alphanumeric text string
Default: /WPSv51

PDAction When the Tivoli Access Manager external authorization plugin is started, it will detect and, if necessary, create a custom action in Tivoli Access Manager. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles.

Type: Alphanumeric text string
Default: m

PDActionGroup When the Tivoli Access Manager external authorization plugin is started, it will detect and, if necessary, create a custom action group in Tivoli Access Manager. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles.

Type: Alphanumeric text string
Default: [WPS5]

PDCreateAcl When Portal externalizes a role, it can automatically create and attach a TAM ACL granting membership to the user doing the role. If you set this property to false, the TAM administrator will be responsible for creating TAM ACLs to allow access to Portal roles.

Type: true, false
Default: true

 

Tivoli Access Manager: Portal vault parameters

Property Value
vaultType New vault type identifier representing the Tivoli GSO lockbox vault. The value can be any string.

Type: Alphanumeric text string
Default: AccessManager

vaultProperties Defines a properties file to be used to configure the vault with TAM specific user and SSL connection information. This file will automatically be created in...

WP_ROOT/shared/app/config

...subdirectory and populated by the ant task based on previous task execution.

Type: Alphanumeric text string
Default: accessmanagervault.properties

manageResources Determines if the portal credential vault or any custom portlet is allowed to create new resource objects in TAM. If you select false, the Tivoli administrator must define the accessible resources to associate users with using the Tivoli command line or GUI.

Type: true, false
Default: true

readOnly Determines if the portal credential vault or any custom portlet is allowed to modify the secrets stored in TAM. If set to true ("Read Only"), the Tivoli administrator must change the credentials associated with resources using the Tivoli command line or GUI.

Type: true, false
Default: false

 

Netegrity SiteMinder: SiteMinder TAI parameters

Property Value
SMConfigFile Location of the SiteMinder TAI WebAgent.conf file.

Type: Directory path with elements delimited by forward slashes (/)
Default: e:/netegrity6/smwastai/conf/WebAgent.conf

 

Netegrity SiteMinder: Portal/SiteMinder authorization parameters

Property Value
SMDomain SiteMinder Domain containing all externalized portal resources.

Type: Alphanumeric text string
Default: WebSphere Portal v5

SMScheme SiteMinder Authentication scheme object name to use when creating realms.

Type: Alphanumeric text string
Default: Basic

SMAgent The SiteMinder custom or 4.x web agent created to allow communication between WebSphere Portal and SiteMinder.

Type: Alphanumeric text string
Default: ReplaceWithYourSiteMinderAgentName

SMAgentPw Password for SiteMinder custom or 4.x web agent.

Type: Alphanumeric text string
Default: ReplaceWithYourSiteMinderAgentPwd

SMAdminId SiteMinder administrative user. This administrator must have a scope of System, as new SiteMinder domains and realms will be created. In addition, creation of the realms representing Portal roles, reference to the webagent, which also requires System scope.

Type: Alphanumeric text string
Default: siteminder

SMAdminPw Password for SiteMinder administrative user.

Type: Alphanumeric text string
Default: ReplaceWithYourSiteMinderAdminPwd

SMUserDir SiteMinder User Directory object referencing the LDAP server used for Portal users and groups.

Type: Alphanumeric text string
Default: ReplaceWithYourSiteMinderUserDirectoryObject

SMFailover Failover mode of Siteminder Policy Server.

Must be set to true if more than one policy server is listed in the SMServers property.

Type: true, false
Default: false

SMServers Comma-delimited list of servers for SiteMinder agent.

If the Policy Servers are listening on non-default ports (ports other than 44441, 44442, 44443), add the port property for each policy server manually in the ExternalAccessControlService.properties.

Type: Alphanumeric text string; must be the hostname or IP address
Default: Policy.Server.ipaddress

[Back to top]

 

Virtual Portal Configuration properties

Property Value
VirtualPortalTitle Title of the Virtual Portal.

Type: Alphanumeric text string
Default: <none>

VirtualPortalRealm Realm of the Virtual Portal.

Type: Alphanumeric text string
Default: <none>

VirtualPortalContext Context of the Virtual Portal.

Type: Alphanumeric text string
Default: <none>

VirtualPortalNlsFile File which contains language-specific information for the Virtual Portal.

Type: Alphanumeric text string
Default: <none>

VirtualPortalObjectId Object identifier of the Virtual Portal. The Object ID is needed to modify, delete Virtual Portals and can be obtained by running task list-all-virtual-portals.

Type: Alphanumeric text string
Default: <none>

[Back to top]

 

parentProperties

Property Value
parentProperties Location of a parent properties file to be used when running the configuration program (WPSconfig script). When using a parent properties file, a property value from that file supersedes a value for the same property in the main properties file (wpconfig.properties).

Type: Path name
Default: <none>

SaveParentProperties When specified in conjunction with the parentProperties property, this property indicates that upon successful execution of the configuration task, the property values specified in the parent properties file will be copied to the main properties file (wpconfig.properties) to reflect the current state of the configuration information.

Type: True, False
Default: True

 

See also

 

 

 

 

 

 

 

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.

 

Tivoli is a trademark of the IBM Corporation in the United States, other countries, or both.