Configuration properties reference

 

+
Search Tips   |   Advanced Search

 

WebSphere Portal configuration properties are located in...

...in the following directory...

For database related properties, the variables dbdomain and dbtype will need to be modified as follows:

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

  • release
  • customization
  • community
  • jcr
  • feedback
  • likeminds
  • wmm

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

  • cloudscape
  • db2
  • oracle
  • sqlserver
  • db2_zos
  • db2_iseries

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 the 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 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:

  • 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 you should make a backup copy. We can back up the file manually or by using the configuration task:

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

  • i5/OS:

    • 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:

    • We 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

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

     

    WAS properties

    Property Value
    VirtualHostName Name of the WAS virtual host.

    Alphanumeric text string

    Example: my_virtual_host

    Default: default_host

    WasAdminServer Name of the WAS administrative server.

    Alphanumeric text string

    Windows and UNIX Default value: server1

    i5/OS Default: profile

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

    WasHome The directory where WAS is installed.

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

    Directory path with elements delimited by forward slashes (/)

    Example: /usr/WebSphere/AppServer.

    Windows and UNIX Default value: D:/WebSphere/AppServer

    i5/OS Default: app_server_root

    WasUserHome The directory where WAS user data is created.

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

    Directory path with elements delimited by forward slashes (/)

    Example: /usr/WebSphere/AppServer.

    Windows and UNIX Default value: D:/WebSphere/AppServer

    i5/OS Default: app_server_root

    WasUserid The user ID for WAS security authentication. The fully qualified distinguished name (DN) of a current administrative user for the WAS. 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 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.

    Alphanumeric text string

    Examples...

    Tivoli Directory Server: uid=wpsbind,cn=users,dc=example,dc=com
    Domino cn=wpsbind,o=example.com
    Active Directory cn=wpsbind,cn=users,dc=example,dc=com
    Sun Java System Directory 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 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.

    Alphanumeric text string

    Recommended: Set this value according to your own environment.

    Default: ReplaceWithYourWASUserPwd

    WPSInstallLocation The directory where WebSphere Portal is installed.

    Directory path with elements delimited by forward slashes (/)

    Example: /usr/WebSphere/AppServer

    Windows and UNIX Default value: D:/WebSphere/PortalServer51

    i5/OS Default value: portal_server_root

    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. Value 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. alphanumeric

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

    Default: Set this value according to your own environment

    PushFrequency Dynamic cache service push frequency in seconds.

    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 your own environment

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

    Default: Set this value according to your own environment

    CellName The WAS cell to which the WAS belongs.

    Alphanumeric text string

    Windows and UNIX Default: cell

    i5/OS Default value: your_system_profile

    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.

    Alphanumeric text string

    Windows and UNIX Default value: node

    i5/OS Default: your_system_profile

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

    Alphanumeric text string

    Windows and UNIX Default: WebSphere_Portal

    i5/OS Default value: profile

    WpsHostName Fully-qualified host name of the Web server that WAS is configured to use. This value is set by the installation program based on user input during installation.

    http://WpsHostName:WpsHostPort/WpsContextRoot/WpsDefaultHome

    For example...

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

    Host name, including domain

    Example: hostname.example.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.example.com:9081/wps/portal

    Port number

    Windows and UNIX Default value: 9081

    i5/OS Default: 80

    WpsSoapPort SOAP port used by WebSphere Portal Server

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

    Port number

    Default: none

    XmlAccessHost Name of the local WebSphere Portal host.

    Default: localhost

    XmlAccessPort 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 configuration task sets this value.

    Port number

    Default: Set this value according to your own environment

    XmlAccessProtocol The protocol used to connect to the XMLAccess server.

    http or https

    Default: http

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

    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

    Alphanumeric text string

    Example (Windows and UNIX): http://hostname.example.com:9081/wps/portal

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

    Default: wps

    WsrpContextRoot The context root or base URI for WSRP Producer.

    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

    Alphanumeric text string

    Example (Windows and UNIX): http://hostname.example.com:9081/wps/portal

    Example (i5/OS ): http://hostname.example.com:80/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

    Alphanumeric text string

    Example (Windows and UNIX): http://hostname.example.com:9081/wps/myportal

    Example (i5/OS ): http://hostname.example.com:80/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.

    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.

    Port number

    Default: none

    [Back to top]


    Java Properties

    Property Value
    JavaHome

    The directory where the WAS Java is installed.

    Directory path with elements delimited by forward slashes (/)

    Example: /usr/WebSphere/AppServer

    Windows and UNIX Default value: D:/WebSphere/AppServer/Java

    i5/OS Default value:

    /QIBM /ProdData/Java400/jdk14

    [Back to top]


     

    Portal configuration properties

    Property Value
    PortalAdminId The user ID for the WebSphere Portal administrator, which should be the fully qualified 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 DN.

    Alphanumeric text string, conforming to the LDAP distinguished name format

    Examples for LDAP:

    Tivoli Directory Server: uid=portaladminid,cn=users,dc=example,dc=com
    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 uid=portaladminid,ou=people,o=example.com
    Novell eDirectory uid=portaladminid,ou=people,o=example.com

    Example for Custom User Registry (CUR):

    uid=portaladminid

    Windows and UNIX Default value: none

    i5/OS Default value:

    uid=portaladminid,o=default organization

    PortalAdminPwd

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

    Alphanumeric text string

    Example: yourportaladminpwd

    Default: none

    PortalAdminGroupId

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

    Make sure to type the value in lower case, regardless of the case used in the DN.

    Alphanumeric text string, conforming to the LDAP distinguished name format

    Examples for LDAP:

    Tivoli Directory Server: cn=wpsadmins,cn=groups,dc=example,dc=com
    Domino cn=wpsadmins
    Active Directory cn=wpsadmins,cn=groups,dc=example,dc=com
    Sun Java System Directory cn=wpsadmins,ou=groups,o=example.com
    Novell eDirectory cn=wpsadmins,ou=groups,o=example.com

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

    Default: cn=wpsadmins,o=default organization

    PortalUniqueID

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

    12 hex digits

    Windows and UNIX Default: 1234567890AB

    i5/OS Default value: 12-character ID

    CmConfigured

    Indicates whether content management functions are configured.

    true, false

    Default: true

    WpsContentAdministrators

    The group ID for the WebSphere Content Administrator group.

    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
    Domino cn=wpsContentAdministrators
    Active Directory cn=wpsContentAdministrators,cn=groups,dc=example,dc=com
    Sun Java System Directory 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.

    Alphanumeric text string

    Default: wpsContentAdministrators

    WpsDocReviewer

    The group ID for the WebSphere Document Reviewer group

    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
    Domino cn=wpsDocReviewer
    Active Directory cn=wpsDocReviewer,cn=groups,dc=example,dc=com
    Sun Java System Directory 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.

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

    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.

    Directory path with elements delimited by forward slashes (/)

    Example: C:/Program Files/Cloudscape.

    Default: none

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

    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.

    true, false

    Default: false

    LCC.QuickPlace.Server

    Name of the Lotus QuickPlace server.

    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.

    http, https

    Default: http

    LCC.QuickPlace.Port

    The port number for the Lotus QuickPlace server.

    Alphanumeric text string

    Default: 80

    LCC.Sametime.Enabled

    The property that determines whether IBM Lotus Sametime is enabled.

    true, false

    Default: false

    LCC.Sametime.Server Name of the IBM Lotus Sametime server.

    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.

    http, https

    Default: http

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

    Alphanumeric text string

    Default: 80

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

    true, false

    Default: false

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

    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.

    http, https

    Default: http

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

    Alphanumeric text string

    Default: 80

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

    true, false

    Default: false

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

    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.

    Alphanumeric text string

    Windows and UNIX Default: 80

    i5/OS Default value: 389

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

    true, false

    Default: false

    [Back to top]


    WebSphere Portal Security LTPA and SSO configuration

    Property Value
    LTPAPassword The password for the LTPA bind.

    Alphanumeric text string

    Default: none

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

    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.

    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 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 WAS documentation for further details about this setting.

    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.

    true, false

    Default: false

    cacheTimeout This property specifies the timeout value, in seconds, for the security cache.

    Alphanumeric text string, greater than 30

    Default: 600

    issuePermissionWarning The property that prompts for user credentials.

    true, false

    Default: true

    activeProtocol

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

    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

    The property that sets the authentication mechanism for WAS.

    LTPA

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

    Default: LTPA

    [Back to top]

     

    Custom User Registry Configuration

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

    Depends on the specific application

    Default: com.ibm.websphere.wmm.registry.WMMCustomRegistry

    [Back to top]

     

    LDAP Properties Configuration

    Property Value
    LookAside Set to true to install LDAP using a Lookaside database.

    Set to true if you are using IWWCM , the Common Mail portlet, or the Common Calendar portlet.

    Turn off security while configuring the LookAside database.

    Using a Lookaside database can slow down performance.

    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.

    Alphanumeric text string

    Default: portal

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

    Fully qualified host name of the LDAP server

    Default: yourldapserver.com

    LDAPPort The server port of the LDAP directory.

    Alphanumeric text string

    Example: 389 for non-SSL or 636 for SSL

    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.

    Make sure to type the value in lower case, regardless of the case used in the DN.

    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.

    Alphanumeric text string

    Default: none

    LDAPServerType Type of LDAP Server to be used.

    Tivoli Directory Server: IBM _DIRECTORY_SERVER
    Domino DOMINO502
    Active Directory ACTIVE_DIRECTORY
    Sun Java System Directory IPLANET
    Novell eDirectory NDS

    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.

    Make sure to type the value in lower case, regardless of the case used in the DN.

    Tivoli Directory Server: uid=wpsbind,cn=users,dc=example,dc=com
    Domino cn=wpsbind,o=example.com
    Active Directory cn=wpsbind,cn=users,dc=example,dc=com
    Sun Java System Directory 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.

    Alphanumeric text string

    Default: none

    [Back to top]

    Advanced LDAP Configuration

    Property Value
    LDAPSuffix The LDAP Suffix.

    This is the 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, for example, enable-security-ldap, are used to activate WAS security, this value will be used as the single Base Distinguished Name for the WAS LDAP configuration.

    This value will be qualified with the LDAPUserSuffix and LDAPGroupSuffix values in order to configure Member Manager.

    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 problems with awareness in portal.

    Tivoli Directory Server: dc=example,dc=com
    Lotus Domino: Null
    Active Directory dc=example,dc=com
    Sun Java System Directory o=example.com
    Novell eDirectory o=example.com

    Default: dc=example,dc=com

    LdapUserPrefix The RDN prefix attribute name for user entries.

    Tivoli Directory Server: uid
    Domino cn
    Active Directory cn
    Sun Java System Directory uid
    Novell eDirectory uid

    Default: uid

    LDAPUserSuffix The DN suffix attribute name for user entries.

    With 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 (for example, wpsadmin and wpsbind)

    Make sure to type the value in lower case, regardless of the case used in the DN.

    Tivoli Directory Server: cn=users
    Domino o=example.com
    Active Directory cn=users
    Sun Java System Directory ou=people
    Novell eDirectory ou=people

    Default: cn=users

    LdapGroupPrefix The RDN prefix attribute name for group entries.

    cn

    Default: cn

    LDAPGroupSuffix The DN suffix attribute name for group entries.

    With 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 (., wpsadmins).

    Make sure to type the value in lower case, regardless of the case used in the DN.

    Tivoli Directory Server: cn=groups
    Domino this value is null
    Active Directory cn=groups
    Sun Java System Directory ou=groups
    Novell eDirectory ou=groups

    Default: cn=groups

    LDAPUserObjectClass LDAP object class of all users in the LDAP directory that the Portal will access.

    Tivoli Directory Server: inetOrgPerson
    Domino dominoPerson
    Active Directory user
    Sun Java System Directory inetOrgPerson
    Novell eDirectory inetOrgPerson

    Default: inetOrgPerson

    LDAPGroupObjectClass LDAP object class of all groups in the LDAP directory that the Portal will access.

    Tivoli Directory Server: groupOfUniqueNames
    Domino dominoGroup
    Active Directory group
    Sun Java System Directory groupOfUniqueNames
    Novell eDirectory groupOfNames

  • Shared UserRegistry with WebSeal/IBM TAM for e-business: accessGroup

  • Default: groupOfUniqueNames

    LDAPGroupMember The attribute name in the LDAP group object of the "membership" attribute.

    Tivoli Directory Server: uniqueMember
    Domino member
    Active Directory member
    Sun Java System Directory uniqueMember
    Novell eDirectory uniqueMember

    Shared UserRegistry with WebSeal/TAM: member

    Default: uniqueMember

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

    Tivoli Directory Server: (&(uid=%v)(objectclass=inetOrgPerson))
    Domino (&(|(cn=%v)(uid=%v))(|(objectclass=dominoPerson)(objectclass=inetOrgPerson)))
    Active Directory (&(|(cn=%v)(samAccountName=%v))(objectclass=user))
    Sun Java System Directory (&(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.

    Tivoli Directory Server: (&(cn=%v)(objectclass=groupOfUniqueNames))
    Domino (&(cn=%v)(|(objectclass=dominoGroup)(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)))
    Active Directory (&(cn=%v)(objectclass=group))
    Sun Java System Directory (&(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.

    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.

    Depends on the specific application

    Windows and UNIX Default value: cn,givenName,sn,preferredLanguage

    i5/OS Default value: givenName,sn,preferredLanguage

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

    Depends on the specific application

    Windows and UNIX Default value: cn

    i5/OS Default: none

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

    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 the LDAP server farm and the connection is held across LDAP binds, this value should be set to false; otherwise use true.

    true, false

    Default: true

    LDAPIgnoreCase The property that specifies whether the LDAP search is case-sensitive or ignores case.

    true, false

    Default: true

    [Back to top] IWWCM Properties

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

    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
    Domino cn=wcmadmins
    Active Directory cn=wcmadmins,cn=groups,dc=example,dc=com
    Sun Java System Directory 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.

    Alphanumeric text string

    Default: wcmadmins


    [Back to top]

    Properties for Advanced Security Configuration using External Security Managers

    Namespace management parameters common to TAM and Computer Associates eTrust 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.

    Alphanumeric text string Default values:

    • EACserverName=WebSphere_Portal
    • EACcellName=vmwtest
    • EACappName=wps

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

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

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

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

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

    true, false

    Default: false

     

    Properties for Advanced Security Configuration using External Security Managers

    TAM: 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.

    Alphanumeric text string

    Default: sec_master

    PDAdminPw The password for the administrative TAM user.

    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.

    Directory path with elements delimited by forward slashes (/)

    Default: C:/WebSphere/AppServer/java/jre/PdPerm.properties

     

    Properties for Advanced Security Configuration using External Security Managers

    TAM: 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.

    Alphanumeric text string

    Default: amwps5

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

    Numeric text string

    Default: 7223

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

    remote

    Default: remote

    TamHost Defines the TAM Policy Server used when running PDJrteCfg.

    Alphanumeric text string; must be the hostname or IP address

    Default: your.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.

    Alphanumeric text string; must be the hostname or IP address with port and priority

    Default: your.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.

    Alphanumeric text string; must be the hostname or IP address with port and priority

    Default: your.TAM.Authorization.Server.hostname:7136:1

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

    Directory path with elements delimited by forward slashes (/)

    Default: C:/WebSphere/AppServer/java/jre/lib/security/pdperm.ks

     

    Properties for Advanced Security Configuration using External Security Managers

    TAM: WebSEAL junction parameters

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

    tcp, ssl

    Default: tcp

    JunctionPoint The WebSEAL junction point to the WebSphere Portal profile.

    Alphanumeric text string

    Default:

    /wpsv6

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

    Alphanumeric text string; must be the hostname or IP address

    Default: instance-webseald-yourhost.com

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

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

    Alphanumeric text string

    Default: iv-user,iv-creds

     

    Properties for Advanced Security Configuration using External Security Managers

    TAM: 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.yourcompany.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.

    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.

    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.

    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.

    Alphanumeric text string

    Default: wpsadmin

    BaPassword When you create an SSL junction, we 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.

    Alphanumeric text string

    Default: wpsadmin

     

    Properties for Advanced Security Configuration using External Security Managers

    TAM: Portal authorization parameters

    Property Value
    PDRoot Root objectspace entry in the TAM namespace. All Portal roles will be installed under this objectspace entry. If you will be using TAM for multiple portal profiles, choose a unique name for each root objectspace entry to distinguish one entry from another portal profile entry. This value is stored in the externalaccesscontrolservice.properties file.

    Alphanumeric text string

    Default:

    /WPSv6

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

    Alphanumeric text string

    Default: m

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

    Alphanumeric text string

    Default: [WPS6]

    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.

    true, false

    Default: true

     

    Properties for Advanced Security Configuration using External Security Managers

    TAM: Portal vault parameters

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

    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 the portal_server_root/shared/app/config subdirectory and populated by the ant task based on previous task execution.

    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.

    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 this property is set to true ("Read Only"), the Tivoli administrator must change the credentials associated with resources using the Tivoli command line or GUI.

    true, false

    Default: false

     

    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.

    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/eTrust SiteMinder authorization parameters

    Property Value
    SMDomain eTrust SiteMinder Domain containing all externalized portal resources.

    Alphanumeric text string

    Default: WebSphere Portal v6

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

    Alphanumeric text string

    Default: Basic

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

    Alphanumeric text string

    Default: ReplaceWithYourSiteMinderAgentName

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

    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 Portal roles, reference to the webagent, which also requires System scope.

    Alphanumeric text string

    Default: siteminder

    SMAdminPw Password for eTrust SiteMinder administrative user.

    Alphanumeric text string

    Default: ReplaceWithYourSiteMinderAdminPwd

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

    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.

    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.

    Alphanumeric text string; must be the hostname or IP address

    Default: your.Policy.Server.ipaddress

    [Back to top]

     

    Virtual Portal Configuration properties

    Property Value
    VirtualPortalTitle Title of the Multiple virtual portals.

    Alphanumeric text string

    Default: none

    VirtualPortalRealm Realm of the Virtual Portal.

    Alphanumeric text string

    Default: none

    VirtualPortalContext Context of the Virtual Portal.

    Alphanumeric text string

    Default: none

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

    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.

    Alphanumeric text string

    Default: none

    [Back to top]

     

    Configuration Task Properties

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

    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.

    True, False

    Default: True

    [Back to top]

     

    Miscellaneous

    CCSID value If the CCSID on an iSeries 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.

    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:

    • release

    • customization

    • community

    • jcr

    • wmm

    • feedback

    • likeminds

    dbdomain.DbType

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

    Alphanumeric text string

    Recommended value for all domains:

    • Cloudscape: cloudscape

    • DB2: db2

    • Oracle: oracle

    • MS SQL Server: sqlserver

    • DB2 for i5/OS: db2_iseries

    • DB2 for z/OS and OS/390: db2_zos

    dbdomain.DbName

    The name of the WebSphere Portal domain database and schema.

    Notes:

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

    • Non-Windows platforms when using DB2 only. This value is the TCPIP Alias for the database.

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

    Alphanumeric text string

    Notes:

    • For DB2 and DB2 for z/OS, this value cannot exceed 8 characters and can only contain letters and numbers. Refer to the 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 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.

    Default value for all domains: wpsdb

    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/wmmDbUser, where *LOCAL is the database and wmmDbUser 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:hostNameCOMM60

      • JCR: hostName/JCR60

      • Feedback: hostName/FDB60

      • LikeMinds: hostName/LKM60

    • For Member Manager databases: hostName/wmmDbUser, where wmmDbUser 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, it must also have 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 only, unless you are the system administrator, the values for dbdomain.DbUser and dbdomain.DbSchema must be the same.

    • For Oracle and SQL Server servers, the value must be set to FEEDBACK.

    Alphanumeric text string

    Default: dbdomain

    dbdomain.DbNameOnZos

    The name of the WebSphere Portal database on DB2 for z/OS.

    Alphanumeric text string

    Default:

    • Release: WPSTST02

    • Customization: WPSTST02

    • Community: WPSTST02

    • JCR: WPSTST02

    • WMM: WPSTST02

    • Feedback: WPSTST02

    • LikeMinds: WPSTST02

    dbdomain.DataSourceName

    The name of the data store that WebSphere Portal 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.

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

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

    Alphanumeric text string, conforming to standard JDBC URL syntax

    Recommended values (for all domains):

    • Cloudscape:

      jdbc:db2j:wpsdb;create=true

    • DB2:

      jdbc:db2:wpsdb

    • DB2 for i5/OS (local):

      • For non-Member Manager databases:

        jdbc:db2:*LOCAL/dbdomain.DbName

      • For Member Manager databases:

        jdbc:db2:*LOCAL/wmmDbUser, where *LOCAL is the database and wmmDbUser 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/wmmDbUser, where wmmDbUser is the Member Manager database administrator user ID (the schema you will use to connect to the database).

    • DB2 for z/OS (local):

      jdbc:db2:location

    • DB2 for z/OS (remote):

      jdbc:db2:wpsdb

    • Oracle:

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

    • SQL Server:

      jdbc:microsoft: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 servers, this value must be set to FEEDBACK, which corresponds to the user FEEDBACK in the database. 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.

    Alphanumeric text string

    Default:

    • Release: db2admin

    • Community: db2admin

    • Customization: db2admin

    • JCR: db2admin

    • WMM: db2admin

    • Feedback: db2admin

    • LikeMinds: db2admin

    Recommended: wpsdbusr (for databases other than DB2 )

    dbdomain.DbPassword

    The password for the database administrator.

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

    Value type: Alphanumeric text string

    Default value 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:

    Alphanumeric text string

    Default:

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

    Alphanumeric text string

    Default values:

    • Release: wpsNode

    • Community: wpsNode

    • Customization: wpsNode

    • JCR: wpsNode

    • WMM: wpsNode

    • Feedback value: pznNode

    • LikeMinds value: pznNode

    [Back to top]

     

    DB2 Content Manager Runtime Edition Database properties

    Property Value
    jcr.DbHost The hostname of the system hosting the DB2 Content Manager Runtime Edition database.

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

    Alphanumeric text string

    jcr.DbDomain The domain of the system hosting the DB2 Content Manager Runtime Edition database.

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

    Alphanumeric text string

    jcr.ZosDbPrefix Common prefix of Node Type database names for the DB2 Content Manager Runtime Edition database.

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

    Recommended: Set this value according to your own environment, to match the value used when executing the commands to create the database found in the file Creating the DB2 Content Manager Runtime Edition database.

    Default: ICM

    jcr.ZosDbMaxTables Maximum number of User Defined Tables to be stored in a particular Node Type DB in the DB2 Content Manager Runtime Edition database.

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

    Recommended: 400.

    Default: 400

    jcr.DbStorageGroup The storage group for the DB2 Content Manager Runtime Edition database.

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

    Recommended: Set this value according to your own environment, to match the value used when executing the commands to create the database found in the file Creating the DB2 Content Manager Runtime Edition database.

    Default: WPSSG

    jcr.DbVolumes The volumes for the DB2 Content Manager Runtime Edition database.

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

    Recommended: Set this value according to your own environment, to match the value used when executing the commands to create the database found in the file Creating the DB2 Content Manager Runtime Edition database.

    Default: *

    jcr.DbVcat The VCAT for the DB2 Content Manager Runtime Edition database.

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

    Recommended: Set this value according to your own environment, to match the value used when executing the commands to create the database found in the file Creating the DB2 Content Manager Runtime Edition database.

    Default: DSN810

    jcr.Db4KBufferPoolName The 4K bufferpool name for the DB2 Content Manager Runtime Edition database.

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

    Recommended: Set this value according to your own environment, to match the value used when executing the commands to create the database found in the file Creating the DB2 Content Manager Runtime Edition database.

    Default: BP0

    jcr.Db32KBufferPoolName The 32K bufferpool name for the DB2 Content Manager Runtime Edition database.

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

    Recommended: Set this value according to your own environment, to match the value used when executing the commands to create the database found in the file Creating the DB2 Content Manager Runtime Edition database.

    Default: BP32K

    jcr.DbPort Port number of the DB2 Content Manager Runtime Edition database, if not on the local system (required for Driver Type 4 only).

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

    Recommended: Set this value according to your own environment.

    Default: 446

    jcr.DbSaPassword The SQL Server System Administrator password.

    Required for SQL Server only.

    Default: 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:

    Alphanumeric text string

    Default: myserver

    feedback.DbTablespace Name of the Feedback database tablespace.

    Required for SQL Server only.

    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:

    Alphanumeric text string

    Default: myserver

    likeminds.DbTablespace Name of the Likeminds database tablespace.

    Alphanumeric text string

    Default: lmdbts

    [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:

    • cloudscape
    • db2
    • oracle
    • sqlserver
    • db2_zos
    • db2_iseries

    There may be additional properties needed that are specific to the database domain or database type. These properties will be listed in a separate table that is specific to the 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.

    true, false

    Default: false

    dbtype.DbDriver The Java class name 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. For example: COM.ibm.db2.jdbc.app.DB2Driver. The following values can be specified:

    • Cloudscape: com.ibm.db2j.jdbc.DB2jDriver

    • DB2: com.ibm.db2.jdbc.app.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

    Windows and UNIX Default value: com.ibm.db2j.jdbc.DB2jDriver (Cloudscape)

    DB2 for i5/OS Recommended:

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

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

    Default: com.ibm.db2.jdbc.app.DB2Driver

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

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

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

    Example: The following values can be specified:

    • Cloudscape: PortalServershared/app/cloudscape/db2j.jar

    • DB2: SQLLIBjava/db2java.zip

    • 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 WAS:portal_server_root/IBM Trans/lib/jt400.jar

    i5/OS Recommended value: DB2 for i5/OS:

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

    • Remote: For the UserData path of the installed edition of WAS:portal_server_root/IBM Trans/lib/jt400.jar

    Windows and UNIX Default value:

    d:/websphere/portalserver/shared/app/cloudscape/db2j.jar

    i5/OS Default value:

    /QIBM /ProdData/Java400/ext/db2_classes.jar

    For remote DB2 configuration, for the UserData path of the installed edition of WAS this value should be: portal_server_root/IBM Trans/lib/jt400.jar

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

    Alphanumeric text string

    Default: wpdbJDBC_cloudscape

    [Back to top]

     

    DB2 for iSeries Database type properties

    Property Value
    db2_iseries.DbDriverType The database driver type for local and remote

    Numeric text string; 2 for local, 4 for remote

    i5/OS Default value: 2

    [Back to top]

     

    Related information

     

    Parent topic:

    Configuration program