WebSphere

 

Portal Express, Version 6.0
Operating systems: i5/OS, Linux, Windows

 

Portal Configuration properties reference

 

+

Search Tips   |   Advanced Search

 

This topic describes the properties that are used with the configuration tasks during installation and configuration.

The specific properties required for installation and customization can vary, depending on how you are deploying WebSphere Portal Express and its related components. Refer to the installation and customization instructions for each component for information on which properties you should set.

The WebSphere Portal Express configuration properties are located in...

...in the following directory...

Depending on which database domain is to be configured, dbdomain will be replaced by:

Depending on which database type is used, dbtype will be replaced by...

There may be additional properties needed that are specific to your database domain or database type. These properties will be listed in a separate table that is specific to your database domain or type. Refer to the task you are running for a complete list of the properties required.

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 Express requires that you edit a properties file with component values that are unique to your environment. The following precautions should be taken when working with this file:

 

Properties

The following tables provide a description, value, and default for each of the associated properties:

WebSphere Application Server properties

Property Value
VirtualHostName The name of the WebSphere Application Server virtual host.

Type: Alphanumeric text string

Example: my_virtual_host

Default: default_host

WasAdminServer The name of the WebSphere Application Server administrative server.

Type: Alphanumeric text string

Windows and Linux default: server1

i5/OS default: profile_name

This value is defaulted to the WebSphere Application Server profile name. If your WebSphere Application Server profile was created with a different WebSphere Application Server administrative server name, you should change this value to reflect that.

WasHome The directory where WebSphere Application Server is installed.

This value is set by the installation program based on user input during installation.

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

Example: /usr/WebSphere/AppServer.

Windows and Linux default: D:/WebSphere/AppServer

i5/OS default: app_server_root

WasUserHome The directory where WebSphere Application Server user data is created.

This value is set by the installation program based on user input during installation.

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

Example: /usr/WebSphere/AppServer.

Windows and Linux default: D:/WebSphere/AppServer

i5/OS default: app_server_root

WasUserid The user ID for WebSphere Application Server security authentication. For an LDAP configuration this should be the fully qualified distinguished name (DN) of a current administrative user for the WebSphere Application Server. For a configuration using Member Manager User Registry database the short version of the distinguished name must be used.

Make sure to type the value in lower case, regardless of the case used in the distinguished name (DN). 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

Example: When using LDAP security:

  • Tivoli Directory Server: uid=wpsbind,cn=users,dc=example,dc=com

  • Lotus Domino: cn=wpsbind,o=example.com

  • Active Directory: cn=wpsbind,cn=users,dc=example,dc=com

  • Active Directory Application Mode: cn=wpsbind,cn=users,dc=example,dc=com

  • Sun Java System Directory Server: uid=wpsbind,ou=people,o=example.com

  • Novell eDirectory: uid=wpsbind,ou=people,o=example.com

Example: When using Custom User Registry (CUR):

  • CUR: wpsbind

Default: ReplaceWithYourWASUserID

WasPassword The password for WebSphere Application Server 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

Recommended: Set this value according to a environment.

Default: ReplaceWithYourWASUserPwd

WPSInstallLocation The directory where WebSphere Portal Express is installed.

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

Example: /usr/WebSphere/AppServer

Windows and Linux default: D:/WebSphere/PortalServer51

i5/OS default: portal_server_root_user

PrimaryNode This property specifies the primary node in a clustered environment.

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

Type:

  • true - it is the master node

  • false - it is not the master node

Default: true

ClusterName Use this property to specify the cluster name you want to use when creating the cluster.Type: alphanumeric

Do not use spaces or special characters in the cluster name.

Default: Set this value according to a environment

PushFrequency Dynamic cache service push frequency in seconds.

Type: numeric

Default: 1

ReplictionType Dynamic cache service replication Type.

Default: PUSH

DMgrHostName Specify the host name of the machine where the deployment manager is running.

Default: Set this value according to a environment

DMgrSoapPort Specify the port number where the deployment manager machine receives SOAP requests.

Default: Set this value according to a environment

CellName The WebSphere Application Server cell to which the WebSphere Application Server belongs.

Type: Alphanumeric text string

Windows and Linux default: cell

i5/OS default: your_system_profile_name

NodeName The node within the WebSphere Application Server cell to which the WebSphere Application Server 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

Windows and Linux default: node

i5/OS default: your_system_profile_name

ServerName The name of the application server where the WebSphere Portal Express application is deployed. This value must be unique among other application server names in the same cell.

Type: Alphanumeric text string

Windows and Linux default: WebSphere_Portal

i5/OS default: profile_name

WpsHostName The fully-qualified host name of the Web server that WebSphere Application Server is configured to use. This value is set by the installation program based on user input during installation. http://HostName:HostPort/ContextRoot/DefaultHome.

For example Windows and Linux: http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server.

For example i5/OS:http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server.

Type: Host name, including domain

Example: http://www.ibm.com:10038/wps/portal

Default: localhost

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

http://HostName:HostPort/ContextRoot/DefaultHome

For example: http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server.

Type: Port number

Windows and Linux default: 10038

i5/OS default: 80

WpsSoapPort

 

Description: The SOAP port used by WebSphere Portal Express Server

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

Type: Port number

Default: none

XmlAccessHost The name of the local WebSphere Portal Express host.

Default: localhost

XmlAccessPort The port used by the XMLAccess configuration task to connect to the XMLAccess server.

This property may not be used to reconfigure the XmlAccess port. The basic WebSphere Portal Express configuration task sets this value.

Type: Port number

Default: Set this value according to a environment

XmlAccessProtocol The protocol used to connect to the XMLAccess server.

Type: http or https

Default: http

WpsAppName The name of the WebSphere Portal Express application, as deployed into WebSphere Application Server.

Type: Alphanumeric text string

Default: wps

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

Type: Alphanumeric text string

 

Example (Windows and Linux): http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server.

 

Example (i5/OS): http://hostname.example.com:80/wps/portal

Default: wps

WsrpContextRoot The context root or base URI for WSRP Producer.

Type: Alphanumeric text string

Default: wsrp

WpsDefaultHome The default 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 Express from a browser: http://HostName:HostPort/ContextRoot/DefaultHome

Type: Alphanumeric text string

 

Example (Windows and Linux): http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server.

 

Example (i5/OS): http://hostname.example.com:80/wps/portal

Default: portal

WpsPersonalizedHome The page for users who have already logged in. This page cannot be accessed by anonymous users. The value of this property is part of the URL used to access WebSphere Portal Express from a browser: http://HostName:HostPort/ContextRoot/PersonalizedHome

Type: Alphanumeric text string

 

Example (Windows and Linux): http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server.

 

Example (i5/OS): http://hostname.example.com:80/wps/myportal

Default: myportal

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

Type: Host name, including domain

Example: proxyhostname.example.com

Default: none

ContentAccessServiceProxyPort The 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 The directory where the WebSphere Application Server Java is installed.

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

Example: /usr/WebSphere/AppServer

Windows and Linux default: D:/WebSphere/AppServer/Java

i5/OS default: /QIBM/ProdData/Java400/jdk14

[Back to top]

WebSphere Portal Express configuration properties

Property Value
PortalAdminId The user ID for the WebSphere Portal Express administrator, which should be the fully qualified distinguished name (DN).

Notes:

  • For LDAP configuration this value should not contain spaces.

  • Make sure to type the value in lower case, regardless of the case used in the distinguished name (DN).

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

 

Examples for LDAP:

  • Tivoli Directory Server: uid=portaladminid,cn=users,dc=example,dc=com

  • Lotus Domino: cn=portaladminid,o=example.com

  • Active Directory and Active Directory Application Mode: cn=portaladminid,cn=users,dc=example,dc=com

  • Sun Java System Directory Server: uid=portaladminid,ou=people,o=example.com

  • Novell eDirectory: uid=portaladminid,ou=people,o=example.com

Custom User Registry example: uid=portaladminid

Windows and Linux default: none

i5/OS default: uid=portaladminid,o=default organization

PortalAdminPwd The password for the WebSphere Portal Express administrator, as defined in the PortalAdminId property.

Type: Alphanumeric text string

Example: yourportaladminpwd

Default: none

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

Make sure to type the value in lower case, regardless of the case used in the distinguished name (DN).

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

 

Examples for LDAP:

  • Tivoli Directory Server: cn=wpsadmins,cn=groups,dc=example,dc=com

  • Lotus Domino: cn=wpsadmins

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

  • Active Directory Application Mode: cn=wpsadmins,cn=groups,dc=example,dc=com

  • Sun Java System Directory Server: cn=wpsadmins,ou=groups,o=example.com

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

Custom User Registry example: cn=wpsadmins,o=default organization

Default: cn=wpsadmins,o=default organization

PortalUniqueID An identifier of this WebSphere Portal Express installation. Usually a MAC address from a communications adapter on this node.

Type: 12 hex digits

Windows and Linux default: 1234567890AB

i5/OS default: 12-character ID

CmConfigured Indicates whether content management functions are configured.

Type: true, false

Default: true

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:

  • Tivoli Directory Server: cn=wpsContentAdministrators,cn=groups,dc=example,dc=com

  • Lotus Domino: cn=wpsContentAdministrators

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

  • Active Directory Application Mode: cn=wpsContentAdministrators,cn=groups,dc=example,dc=com

  • Sun Java System Directory Server: cn=wpsContentAdministrators,ou=groups,o=example.com

  • Novell eDirectory: cn=wpsContentAdministrators,ou=groups,o=example.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

  • Database user registry: WpsDocReviewer=cn=wpsDocReviewer,o=default organization

 

LDAP example values:

  • Tivoli Directory Server: cn=wpsDocReviewer,cn=groups,dc=example,dc=com

  • Lotus Domino: cn=wpsDocReviewer

  • Active Directory: cn=wpsDocReviewer,cn=groups,dc=example,dc=com

  • Active Directory Application Mode: cn=wpsDocReviewer,cn=groups,dc=example,dc=com

  • Sun Java System Directory Server: cn=wpsDocReviewer,ou=groups,o=example.com

  • Novell eDirectory: cn=wpsDocReviewer,ou=groups,o=example.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 WebSphere Application Server.

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 (/)

Default: none

[Back to top]

WebSphere Portal Express 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: DcsRemoteHost=http://myremotehost1:9080/dcs/dcs

Default: http://remotehostname:9080/dcs/dcs

[Back to top]

Lotus Collaborative Components Properties

Property Value
LCC.QuickPlace.Enabled The property that determines whether Lotus Lotus QuickPlace is enabled.

Type: true, false

Default: false

LCC.QuickPlace.Server The name of the Lotus QuickPlace server.

Type: Alphanumeric text string; must be the hostname or IP address

Default: my.server.com

LCC.QuickPlace.Protocol The protocol used to connect to the Lotus QuickPlace server.

Type: http, https

Default: http

LCC.QuickPlace.Port The port number for the Lotus QuickPlace server.

Type: Alphanumeric text string

Default: 80

LCC.Sametime.Enabled The property that determines whether IBM Lotus® Sametime® is enabled.

Type: true, false

Default: false

LCC.Sametime.Server The name of the IBM Lotus Sametime server.

Type: Alphanumeric text string; must be the hostname or IP address

Default: my.server.com

LCC.Sametime.Protocol The protocol used to connect to the IBM Lotus Sametime server.

Type: http, https

Default: http

LCC.Sametime.Port The port number for the IBM Lotus Sametime server.

Type: Alphanumeric text string

Default: 80

LCC.DiscoveryServer.Enabled The property that determines whether Lotus DiscoveryServer is enabled.

Type: true, false

Default: false

LCC.DiscoveryServer.Server The name of the Lotus DiscoveryServer server.

Type: Alphanumeric text string; must be the hostname or IP address

Default: my.server.com

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

Type: http, https

Default: http

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

Type: Alphanumeric text string

Default: 80

LCC.DominoDirectory.Enabled The property that determines whether Lotus DominoDirectory is enabled.

Type: true, false

Default: false

LCC.DominoDirectory.Server The name of the Lotus DominoDirectory server.

Type: Alphanumeric text string; must be the hostname or IP address

Default: my.server.com

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

Type: Alphanumeric text string

Windows and Linux default: 80

i5/OS default: 389

LCC.DominoDirectory.SSL Use this property to enable or disable the SSL connection to the Domino Directory

Type: true, false

Default: false

[Back to top]

WebSphere Portal Express Security LTPA and SSO configuration

Property Value
LTPAPassword The password for the LTPA bind.

Type: Alphanumeric text string

Default: none

LTPATimeout The number of minutes after which an LTPA token will expire.

Type: Numeric text string

Default: 120

SSORequiresSSL The property that 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 The 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 Express has the domain portal.us.ibm.com and another server has the domain another_server.ibm.com, enter ibm.com.

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

Single signon (SSO) is achieved using 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. See the WebSphere Application Server documentation for further details about this setting.

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 This property specifies the timeout value, in seconds, for the security cache.

Type: Alphanumeric text string, greater than 30

Default: 600

issuePermissionWarning The property that prompts for user credentials.

Type: true, false

Default: true

activeProtocol This property specifies the active server level security authentication protocol that RMI/IIOP requests when security is enabled.

Type: CSI, BOTH

If all servers in your security domain are Version 5.0, it is best to specify Common Secure Interoperability (CSI) as your protocol. If some servers are Version 3.x or 4.x, it is best to specify BOTH, which specifies both CSI and Secure Authentication Service (SAS).

Default: BOTH

activeAuthMechanism The property that sets the authentication mechanism for WebSphere Application Server.

 

Value type: LTPA

Currently, this is the only supported mechanism within WebSphere Portal Express.

Default: LTPA

[Back to top]

Custom User Registry Configuration

Property Value
CUClassName The 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 your LDAP server; this combination of LDAP plus a Lookaside database is needed to support the Database user registry.

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.

Set Lookaside to true if you are using IBM Workplace Web Content Management.

Using a Lookaside database can slow down performance.

Type:

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 Express will use.

Type: Fully qualified host name of the LDAP server

Default: yourldapserver.com

LDAPPort The server port of the LDAP directory.

Type: Alphanumeric text string

Example: 389 for non-SSL or 636 for SSL

Default: 389

Configuration tasks only work against a non-SSL port. After configuring security, you will need to manually configure security over SSL and change this value to the SSL value.

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.

Make sure to type the value in lower case, regardless of the case used in the distinguished name (DN).

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

Default: cn=root

LDAPAdminPwd The 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.

 

Example values:

Default: IBM_DIRECTORY_SERVER

LDAPBindID The user ID for LDAP Bind authentication. This user ID is used by WebSphere Application Server 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.

Make sure to type the value in lower case, regardless of the case used in the distinguished name (DN).

 

Example values:

  • Tivoli Directory Server: uid=wpsbind,cn=users,dc=example,dc=com

  • Lotus Domino: cn=wpsbind,o=example.com

  • Active Directory: cn=wpsbind,cn=users,dc=example,dc=com

  • Active Directory Application Mode: cn=wpsbind,cn=users,dc=example,dc=com

  • Sun Java System Directory Server: uid=wpsbind,ou=people,o=example.com

  • Novell eDirectory: uid=wpsbind,ou=people,o=example.com

Default: uid=wpsbind,cn=users,dc=example,dc=com

LDAPBindPassword The password for LDAP Bind authentication. If the LDAPBindID is blank, this property must be blank as well.

Type: Alphanumeric text string

Default: none

[Back to top]

Advanced LDAP Configuration

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

If WebSphere Application Server configuration tasks (for example, enable-security-ldap) are used to activate WebSphere Application Server 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.

Make sure to set the value of the suffix to the exact case of the suffix as set in the LDAP directory. For example, if a users' DN in LDAP is returned as uid=tuser,CN=Users,DC=example,DC=com, set this value to DC=example,DC=com. Using dc=example,dc=com will cause awareness problems. For more information on this see technical note 1174297.

 

Example values:

Default: dc=example,dc=com

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

 

Example values:

Default: uid

LDAPUserSuffix The DN suffix attribute name for user entries. Choose a value appropriate for your LDAP server. With LDAPSuffix appended to this value, it is the DN of the common root node in the LDAP containing all user information for the configuration. As such, it is the lowest container in the LDAP tree still containing all users that will log into WebSphere Portal Express including the administrative users (for example, wpsadmin and wpsbind)

Make sure to type the value in lower case, regardless of the case used in the distinguished name (DN).

 

Example values:

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 your LDAP server. With LDAPSuffix appended to this value, it is the DN of the common root node in the LDAP containing all group information for the configuration. As such, it is the lowest container in the LDAP tree still containing all group entries for WebSphere Portal Express including the administrative group (., wpsadmins).

Make sure to type the value in lower case, regardless of the case used in the distinguished name (DN).

 

Example values:

Default: cn=groups

LDAPUserObjectClass The LDAP object class of the users in your LDAP directory that will log into WebSphere Portal Express.Example values:

Default: inetOrgPerson

LDAPGroupObjectClass The LDAP object class of all the groups in your LDAP directory that WebSphere Portal Express will access.Example values:

  • Tivoli Directory Server: groupOfUniqueNames

  • Lotus Domino: dominoGroup

  • Active Directory: group

  • Active Directory Application Mode: group

  • Sun Java System Directory Server: groupOfUniqueNames

  • Novell eDirectory: groupOfNames

  • Shared UserRegistry with WebSeal/IBM Tivoli® Access Manager for e-business Version 5.1: accessGroup

  • Shared UserRegistry with WebSeal/IBM Tivoli Access Manager for e-business Version 6: groupOfNames

Default: groupOfUniqueNames

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

  • Tivoli Directory Server: uniqueMember

  • Lotus Domino: member

  • Active Directory: member

  • Active Directory Application Mode: member

  • Sun Java System Directory Server: uniqueMember

  • Novell eDirectory: uniqueMember

  • Shared UserRegistry with WebSeal/Tivoli Access Manager: member

Default: uniqueMember

LDAPUserFilter The filter used by WebSphere Application Server for finding users in the LDAP.

 

Example values:

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

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

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

  • Active Directory Application Mode: { (&(cn=%v)(objectclass=user)) }

  • Sun Java System Directory Server: (&(uid=%v)(objectclass=inetOrgPerson))

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

Default: (&(uid=%v)(objectclass=inetOrgPerson))

LDAPGroupFilter The filter used by WebSphere Application Server for finding groups in the LDAP.

 

Example values:

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

  • Lotus Domino: (&(cn=%v)(|(objectclass=dominoGroup)(objectclass=groupOfNames) (objectclass=groupOfUniqueNames)))

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

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

  • Sun Java System Directory Server: (&(cn=%v)(objectclass=groupOfUniqueNames))

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

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

Windows and Linux default: cn,givenName,sn,preferredLanguage

i5/OS default: 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

Windows and Linux default: cn

i5/OS default: none

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

Type: Numeric text string

Default: 120

LDAPreuseConnection The property that specifies whether the LDAP connection can be reused. If a load balancer is placed in front of your 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 The property that specifies whether the LDAP search is case-sensitive or ignores case.

Type: true, false

Default: true

[Back to top]

IBM Workplace Web Content Management Properties

Property Value
WcmAdminGroupId The group ID for the Web Content Management Administrators group. This should be the fully qualified distinguished name (DN) of a current administrative user for the WebSphere Application Server. For LDAP configuration this value should not contain spaces.

Type: Alphanumeric text string

 

Example values:

  • DEV (No security): WcmAdminGroupId=cn=wcmadmins,o=default organization

  • Database user registry: WcmAdminGroupId=cn=wcmadmins,o=default organization

 

LDAP example values:

  • Tivoli Directory Server: cn=wcmadmins,cn=groups,dc=example,dc=com

  • Lotus Domino: cn=wcmadmins

  • Active Directory: cn=wcmadmins,cn=groups,dc=example,dc=com

  • Active Directory Application Mode: cn=wcmadmins,cn=groups,dc=example,dc=com

  • Sun Java System Directory Server: cn=wcmadmins,ou=groups,o=example.com

  • Novell eDirectory: cn=wcmadmins,ou=groups,o=example.com

Default: cn=wcmadmins,o=default organization

WcmAdminGroupIdShort The Web Content Management Administrators group ID.

Type: Alphanumeric text string

Default: wcmadmins

[Back to top]

 

Properties for Advanced Security Configuration using External Security Managers

 

eTrust SiteMinder: TAI parameters

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

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

Default: e:/netegrity6/smwastai/conf/WebAgent.conf

 

Properties for Advanced Security Configuration using External Security Managers

 

eTrust SiteMinder: WebSphere Portal Express/eTrust SiteMinder authorization parameters

Property Value
SMDomain eTrust SiteMinder Domain containing all externalized resources.

Type: Alphanumeric text string

Default: WebSphere Portal v6

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

Type: Alphanumeric text string

Default: Basic

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

Type: Alphanumeric text string

Default: ReplaceWithYourSiteMinderAgentName

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

Type: Alphanumeric text string

Default: ReplaceWithYourSiteMinderAgentPwd

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

Type: Alphanumeric text string

Default: siteminder

SMAdminPw Password for eTrust SiteMinder administrative user.

Type: Alphanumeric text string

Default: ReplaceWithYourSiteMinderAdminPwd

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

Type: Alphanumeric text string

Default: ReplaceWithYourSiteMinderUserDirectoryObject

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.

Type: true, false

Default: false

SMServers Comma-delimited list of servers for eTrust SiteMinder agent.

If your Policy Servers are listening on non-default ports (ports other than 44441, 44442, 44443), change the port property value for each policy server in the External Access Control Service, as described in Setting configuration properties.

Type: Alphanumeric text string; must be the hostname or IP address

Default: your.Policy.Server.ipaddress

Virtual Portal Configuration properties

Property Value
VirtualPortalTitle Title of the Multiple virtual portals.

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]

Configuration Task Properties

Property Value
parentProperties This property specifies the 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

[Back to top]

Miscellaneous

CCSID value If the CCSID on an i5/OS is set to 65535, some configuration commands will not work correctly. Configuration run under a job with CCSID of 65535 will be changed by default to CCSID 37. The CCSID value property can be used to change the default CCSID to something other than 37. This property is only used when the configuration job CCSID is 65535.

Type: Alphanumeric text string

Default: 37

[Back to top]

Database domain properties

For these properties, dbdomain will be replaced with the database domain you are configuring. Depending on which database domain has to be configured, dbdomain will be replaced by:

dbdomain.DbType

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

Type: Alphanumeric text string

Recommended value for all domains:

  • DB2: db2

  • Oracle: oracle

  • SQL Server: sqlserver

  • SQL Server 2005: sqlserver2005

  • DB2 for i5/OS: db2_iseries

dbdomain.DbName

The name of the WebSphere Portal Express domain database and schema.

Notes:

  • This value is also the database element in the dbdomain.DbUrl property.

  • For non-Windows platforms when using DB2, this value is the TCPIP Alias for the database.

  • For Oracle, this value should match your 'ORACLE_SID'.

Type: Alphanumeric text string

Notes:

  • For DB2 this value cannot exceed 8 characters and can only contain letters and numbers. Refer to your database documentation for more information.

  • For DB2, this value must be different from the value of dbdomain.XDbName.

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

  • Version 6.0.1 and later For DB2 for z/OS with a JDBC Type 4 connection, set this value to the location of your database.

Recommended value for all domains:

  • Release: release

  • Community: comm

  • Customization: cust

  • JCR: jcrdb

  • WMM: wmmdb

  • Feedback: fdbkdb

  • LikeMinds: lmdb

Recommended value for local DB2 for i5/OS:

  • For non-Member Manager databases:

    • Release: *LOCAL/REL60

    • Customization: *LOCAL/CUST60

    • Community: *LOCAL/COMM60

    • JCR: *LOCAL/JCR60

    • Feedback: *LOCAL/FDB60

    • LikeMinds: *LOCAL/LKM60

  • For Member Manager databases: *LOCAL/DbUser, where *LOCAL is the database and DbUser is the Member Manager database administrator user ID (the schema you will use to connect to the database).

Recommended value for remote DB2 for i5/OS:

  • For non-Member Manager databases:

    • Release: hostName/REL60

    • Customization: hostName/CUST60

    • Community:hostName/COMM60

    • JCR: hostName/JCR60

    • Feedback: hostName/FDB60

    • LikeMinds: hostName/LKM60

  • For Member Manager databases: hostName/DbUser , where DbUser is the Member Manager database administrator user ID (the schema you will use to connect to the database).

dbdomain.DbSchema

The schema name of the database domain.

Notes:

  • For i5/OS: dbdomain.DbSchema must match the postfix of dbdomain.DbName after /. For example, if release.DbName=*LOCAL/REL60, then release.DbSchema=REL60.

  • Follow the documentation of the target database management system in order to define a valid schema name as restrictions apply for some database management systems, for example on i5/OS.

Notes:

  • This property is not used on Member Manager, which only uses the dbdomain.DbUser name as the schema.

  • Follow the documentation of the target database management system in order to define a valid schema name as restrictions apply for some database management systems.

  • For SQL Server and non-wmm databases only, unless you are the system administrator, the values for dbdomain.DbUser and dbdomain.DbSchema must be the same.

  • For Oracle only: For non-feedback domains, DbSchema and DbUser MUST be the same. For Feeback domains, the default schema name is FEEDBACK. If the value is set to something besides FEEDBACK, you also have to set the schemaName property in <wps_home>/shared/app/config/services/FeedbackService.properties to the new schema.

Type: Alphanumeric text string

Default value: dbdomain

dbdomain.DataSourceName

The name of the data store that WebSphere Portal Express uses to communicate with its databases.

Notes:

  • If the DbUser, DbUrl, and DbPassword are not the same across domains, this value must differ from the DataSourceName of the other domains. In other words, this value must be unique for the database domain.

  • The value for dbdomain.DataSourceName should not be set to the same value as dbdomain.DbName.

  • i5/OS: The value for dbdomain.DataSourceName must match the postfix of dbdomain.DbSchema name. For example, if release.DbSchema=REL60, then release.DataSourcename=REL60. This name must be unique for each database schema.

  • Follow the documentation of the target database management system in order to define a valid schema name, as restrictions apply for some database management systems.

Type: Alphanumeric text string

Default values:

  • Release: wpsdbDS

  • Community: wpsdbDS

  • Customization: wpsdbDS

  • JCR: JCRDS

  • WMM: wpsdbDS

  • Feedback: feedback5

  • LikeMinds: lmdbDS

dbdomain.DbUrl

The database URL used to access the WebSphere Portal Express database with JDBC. The value must conform to standard JDBC URL syntax.

For Oracle, Oracle RAC, and SQL Server, hostname is the name of the remote server and port is the port where the appropriate database instance is listening.

The database element of this value should match the value of dbdomain.DbName.

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

 

Recommended values (for all domains):

  • DB2:

    • jdbc:db2:wpsdb

    • Version 6.0.1 and later jdbc:db2://db2server.mycompany.com:50000/wpsdb:returnAlias=0;

    Please refer to the DB2 documentation for the correct syntax of the JDBC URL.

  • DB2 for i5/OS (local):

    • For non-Member Manager databases: jdbc:db2:*LOCAL/dbdomain.DbName

    • For Member Manager databases: jdbc:db2:*LOCAL/DbUser, where *LOCAL is the database and DbUser is the Member Manager database administrator user ID (the schema you will use to connect to the database).

  • DB2 for i5/OS (remote):

    • For non-Member Manager databases: jdbc:as400:hostName/dbdomain.DbName

    • For Member Manager databases: jdbc:as400:hostname/DbUser, where DbUser is the Member Manager database administrator user ID (the schema you will use to connect to the database).

  • Version 6.0.1 and later DB2 for z/OS with JDBC type 4 connection: jdbc:db2://mvshost:port/location

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

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

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

dbdomain.DbUser

The user ID for the database administrator.

Notes:

  • For SQL Server and non-wmm databases only, unless you are the system administrator, the values for dbdomain.DbUser and dbdomain.DbSchema must be the same.

  • For Oracle and SQL Server, if the user you are using is an administrative user that has authority over the FEEDBACK schema, the administrative user should be entered for the dbdomain.DbUser property.

  • For Oracle only: For non-feedback domains, DbSchema and DbUser MUST be the same. For Feeback domains, the default schema name is FEEDBACK. If the value is set to something besides FEEDBACK, you also have to set the schemaName property in <wps_home>/shared/app/config/services/FeedbackService.properties to the new schema.

Type: Alphanumeric text string

Default for all domains: wpdb2ins ReplacewithyourDBAdminUser

Recommended:

  • Release: releaseusr

  • Community: communityusr

  • Customization: customizationusr

  • JCR: icmadmin

  • WMM: wmmdbusr

  • Feedback: feedback

  • LikeMinds: lmdbusr

dbdomain.DbPassword

The password for the database administrator.

A value must be set for this property; it cannot be empty.

Type: Alphanumeric text string

Default for all domains: ReplaceWithYourDbAdminPwd

dbdomain.XDbName

The database loop back alias that needs to be set if you plan to use the create-local-database-db2 task.

Notes:

  • For DB2, this value must be different from the value of dbdomain.DbName.

Type: Alphanumeric text string

Default value:

  • Release: wps6TCP

  • Community: wps6TCP

  • Customization: wps6TCP

  • WMM: wps6TCP

  • JCR: wps6TCP

  • Feedback: fdbk6TCP

  • LikeMinds: lmdb6TCP

dbdomain.DbNode

The value for the node database.

Required for non-Windows platforms when using DB2 only.

Type: Alphanumeric text string

Default values:

  • Release: wpsNode

  • Community: wpsNode

  • Customization: wpsNode

  • JCR: wpsNode

  • WMM: wpsNode

  • Feedback value: pznNode

  • LikeMinds value: pznNode

[Back to top]

[Back to top]

DB2 Content Manager Runtime Edition Database properties for SQL Server and SQL Server 2005

Property Description
jcr.DbSaPassword The SQL Server System Administrator password.

This property is optional for SQL Server and SQL Server 2005

Default value: ReplaceWithYourDbAdminPwd

[Back to top]

Personalization and Feedback Database properties

Property Value
feedback.DbHostName The fully-qualified host name of the database server that is hosting the Feedback database.

Required for:

Type: Alphanumeric text string

Default: myserver

feedback.DbTablespace The name of the Feedback database tablespace.

Required for DB2 for z/OS only.

Type: Alphanumeric text string

Default: fdbkdbts

[Back to top]

LikeMinds Database properties

Property Value
likeminds.DbHostName The fully-qualified host name of the database server that is hosting the Likeminds database.

Required for:

Type: Alphanumeric text string

Default: myserver

[Back to top]

Database type properties

For these properties, dbtype will be replaced with the database type you are using. Depending on which database type is used, dbtype will be replaced by:

There may be additional properties needed that are specific to your database domain or database type. These properties will be listed in a separate table that is specific to your database domain or type. Refer to the task you are running for a complete list of the properties required.

Property Value
dbtype.DbSafeMode

This property only applies to database-specific tasks. If this property is 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, such as 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 value: false

dbtype.DbDriver The Java class name for the JDBC provider that WebSphere Portal Express uses to communicate with its databases.

The JDBC driver class name depends on the JDBC connection type that will be used.

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

  • DB2:

    • For JDBC type 2 connections: COM.ibm.db2.jdbc.app.DB2Driver

    • Version 6.0.1 and later For JDBC type 4 connections: com.ibm.db2.jcc.DB2Driver

  • Oracle: oracle.jdbc.driver.OracleDriver

  • SQL Server: com.microsoft.jdbc.sqlserver.SQLServerDriver

  • DB2 for i5/OS (local):com.ibm.db2.jdbc.app.DB2Driver

  • DB2 for i5/OS (remote): com.ibm.as400.access.AS400JDBCDriver

  • Version 6.0.1 and later DB2 for z/OS with a JDBC Type 4 connection: com.ibm.db2.jcc.DB2Driver

DB2 for i5/OS Recommended:

  • For local databases: com.ibm.db2.jdbc.app.DB2Driver

  • For remote databases: com.ibm.as400.access.AS400JDBCDriver

dbtype.DbLibrary The directory and name of the .zip or .jar file that contains the JDBC driver class.

 

For DB2: The value depends on the JDBC connection type that will be used. For JDBC type 2 connections the JDBC driver archive is named db2java.zip, but for type 4 connections the archive is split into two files: db2jcc.jar, which contains the JDBC driver, and db2jcc_license_*.jar, which contains the corresponding license. The name of the license archive depends on the actual license. For licensed connections to DB2 on Windows, Linux and Linux the file may be named db2jcc_license_cu.jar. The JDBC driver archives can be found in the DB2 installation directory in the "sqllib/java" subdirectory.

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

In Linux environments, use a colon (:) instead of a semi-colon (;) to separate multiple paths. Example: The following values can be specified:

  • DB2:

    • JDBC Type 2 connection: db2_install/java/db2java.zip

    • Version 6.0.1 and later JDBC Type 4 connection: db2_install/java/db2jcc.jar:db2_install/java/db2jcc_license_cu.jar

  • Oracle: Oracle/jdbc/lib/ojdbc14.jar

  • SQL Server: SQLServerJDBC/lib/mssqlserver.jar; SQLServerJDBC/lib/msbase.jar;SQLServerJDBC/lib/msutil.jar

  • DB2 for i5/OS: /QIBM/ProdData/Java400/ext/db2_classes.jar

  • DB2 for i5/OS (remote): For the UserData path of the installed edition of WebSphere Application Server:portal_server_root_user/IBMTrans/lib/jt400.jar

i5/OS Recommended: DB2 for i5/OS:

  • Local: /QIBM/ProdData/Java400/ext/db2_classes.jar

  • Remote: For the UserData path of the installed edition of WebSphere Application Server:portal_server_root_user/IBMTrans/lib/jt400.jar

For remote DB2 configuration, for the UserData path of the installed edition of WebSphere Application Server this value should be: portal_server_root_user/IBMTrans/lib/jt400.jar

i5/OS Default value: /QIBM/ProdData/Java400/ext/db2_classes.jar

dbtype.JdbcProviderName The name of the JDBC provider that WebSphere Portal Express uses to communicate with its databases.

Type: Alphanumeric text string

Version 6.0.1 and later dbtype.DbDriverType The driver type being used.

For DB2 for z/OS only. Recommended:

  • JDBC Type 2 connection: 2

  • Version 6.0.1 and later JDBC Type 4 connection: 4

dbtype.DbLocationName The DB2 location name on DB2 for z/OS. The location name is set in the DB2 installation job DSNTIJUZ on z/OS.

Required when DB2 is running on z/OS only.

Default: LOC1

Recommended: Set this value according to your environment.

[Back to top]

DB2 for i5/OS Database type properties

Property Value
db2_iseries.DbDriverType

The database driver type for local and remote

Type: Numeric text string; 2 for local, 4 for remote

i5/OS Default value: 2

[Back to top]

Property Description
source.dbdomain.DbPassword The password for the source database.

Type: Alphanumeric text string

Recommended: Set this value according to a environment.

This value is the same as the administrator password if the default user was used during install.

 

Related information

 

Parent topic:

Configuration program