wkplc_comp.properties file

wkplc_comp.properties reference

Overview

Property values can be defined in three ways:

enter the following to change directories: cd
In wkplc_comp.properties
In a build file

The configuration task uses the following order to determine the property value:

command line values. Specifying (-DMyNode=somenode) takes precedence.
property file values.
build file property values.

Properties

WebSphere Portal URLs
Define the URL used to access the portal.

WpsDefaultHome Create the WebSphere Portal default home URL.
Value: string
Examples: If you specify "portal" as the value for this property, the following is the URL for the WebSphere Portal server:
http://localhost:80/wps/portal

In this example localhost is the Websphere Portal host name (WpsHostName), 80 is the Websphere Portal host port (WpsHostPort), and wps is the context root (WpsContextRoot).
Default: portal
WpsPersonalizedHome The personalized home is for users that have already logged in to the portal and cannot be accessed by anonymous users. The value you specify is used to create the WebSphere Portal URL for logged in users.
Value: string
Examples: If you specify "myportal" as the value for this property, the following URL is the page that logged
in users are directed to: http://localhost:80/wps/myportal. In this example
localhost is the Websphere Portal host name (WpsHostName),
80 is the Websphere Portal host port (WpsHostPort), and
wps is the context root (WpsContextRoot).

Default: myportal

Properties for WebSphere Portal integration with WebSphere Process Server

Configure integration with WebSphere Process Server. You must provide information about the already installed WebSphere Process Server.

pi.IsCrossCell Set to true if the WebSphere Process Server installation that WebSphere Portal connects to is located in another cell. If WebSphere Process Server is not in another cell, set the value to false.
Value: true or false
Examples: No examples are available.
Default: true
pi.ProcessServerHostAddress This property is used only if the pi.IsCrossCell value is set to true. The server host name address of the WebSphere Process Server installation in another cell.
Value: No values are available.
Examples: No examples are available.
Default: No default
pi.ProcessServerBootstrapPort This property is used only if the pi.IsCrossCell value is set to true. The bootstrap port of the WebSphere Process Server installation in another cell.
Value: port number
Examples: No examples are available.
Default: No default
pi.ProcessArtifactsLocation This property is used only if the pi.IsCrossCell value is set to true. The directory in which the process artifacts are located.
Value: directory path
Examples: No examples are available.
Default: ${USER_INSTALL_ROOT}/processArtifacts
pi.IsWPSCluster This property is used only if the pi.IsCrossCell value is set to false. Set to true if WebSphere Portal connects to a WebSphere Process Server cluster in the same cell. If WebSphere Portal connects to a WebSphere Process Server cluster in different cell, set the value to false.
Value: true or false
Examples: No examples are available.
Default: No default.
pi.ClusterName This property is used only if the pi.IsCrossCell value is set to false AND pi.IsWPSCluster value is set to true. The name of the WebSphere Process Server cluster.
Value: cluster name
Examples: No examples are available.
Default: No default.
pi.NodeName This property is used only if the pi.IsCrossCell value is set to false AND pi.IsWPSCluster value is set to false. Name of the node of the WebSphere Process Server server.
Value: node name
Examples: No examples are available.
Default: No default.
pi.ServerName This property is used only if the pi.IsCrossCell value is set to false AND pi.IsWPSCluster value is set to false. Name of the WebSphere Process Server server.
Value: server name
Examples: No examples are available.
Default: No default.

XMLAccess properties

Specific to XMLAccess.

XmlAccessHost The local host name of WebSphere Portal. You do not need to modify this value.
Value: string
Examples: No examples are available.
Default: localhost
XmlAccessPort The port used by XML Access configuration tasks to connect to the XMLAccess server Do not use this parameter to reconfigure the XmlAccessPort port. The value is set by the basic WebSphere Portal configuration task.
Value: port number
Examples: 10040
Default: 10040
XmlAccessProtocol The protocol used to connect to the XMLAccess server.
Value: http or https
Examples: http
Default: http

Advanced Security Configuration using External Security Managers

The following parameters are used for advanced security configuration using external security managers. Use the properties to specify namespace management parameters that are common to TAM and SiteMinder

wp.ac.impl.EACserverName Optional) You can set different "contexts" to further distinguish externalized role names from other role names in the Tivoli Access Manager namespace. This context information will be added to the namespace entry created upon role externalization. If any of the three context values (EACserverName, EACcellName, or EACappName) are null, none will be used.
Value: server name
Examples: No examples are available.
Default: WebSphere_Portal
wp.ac.impl.EACcellName One of the three context values used to set a different context to further distinguish the externalized role name
Value: cell name
Examples: No examples available.
Default: No default value provided.
wp.ac.impl.EACappName One of the three context values used to set a different context to further distinguish the externalized role name
Value: application name
Examples: wps
Default: wps
wp.ac.impl.reorderRoles Allows you to either have externalized Portal rolenames displayed with the resource type first, or the role types first.
Value: true or false
Examples: true example: /WPv70/wps.CONTENT_NODE/Welcome_Page/10_2E@Aministrator/app/server/cell
true example: /WPv70/wps.CONTENT_NODE/Welcome_Page/10_2E@Editor/app/server/cell
true example: /WPv70/wps.CONTENT_NODE/Administration/15_AF@Aministrator/app/server/cell
true example: /WPv70/wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q@Aministrator/app/server/cell
true example: /WPv70/wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q@User/app/server/cell
false example: /WPv70/Aministrator@wps.CONTENT_NODE/Welcome_Page/10_2E/app/server/cell
false example: /WPv70/Administrator@wps.CONTENT_NODE/Administration/15_AF/app/server/cell
false example: /WPv70/Administrator@wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q/app/server/cell
false example: /WPv70/Editor@wps.CONTENT_NODE/Welcome_Page/10_2E/app/server/cell
false example: /WPv70/User@wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q/app/server/cell

Default: false

Tivoli Access Manager: AMJRTE connection parameters

Provide authentication information to enable WebSphere Portal to connect with TAM.

wp.ac.impl.PDAdminId An administrative user ID for Tivoli Access Manager (TAM) that has access to create new TAM servers, new Tivoli protected objectspaces, and new Tivoli protected objects.
Value: Alphanumeric text string
Examples: sec_master
Default: sec_master
wp.ac.impl.PDAdminPwd Password for the administrative TAM user ID.
Value: Alphanumeric text string
Examples: No examples are available.
Default: ReplaceWithYourTAMAdminPwd
wp.ac.impl.PDPermPath Location of the TAM AMJRTE properties file. This properties file is created by the portal utility run-svrssl-config, which calls the TAM SvrSslCfg command, and contains information such as: Policy Server host name, ports version of AMJRTE path to encryption keys.
Value: No values are available.
Examples: No examples are available.
Default: ${WasHome}/java/jre/PdPerm.properties

Tivoli Access Manager: PDJrteCfg command and filesystem parameters
The following parameter locations depend on WAS installation structure.

wp.ac.impl.PDClasspath The location of the TAM PD.jar file, which contains the classes required to establish a connection to the policy server and is passed into the classpath of the command.
Value: No values are available.
Examples: No examples are available.
Default: ${WasHome}/java/jre/lib/ext/PD.jar
wp.ac.impl.PDHome Location of the TAM AMJRTE, which is the same as the pd.home system property in a manual execution.
Value: No values are available.
Examples: No examples are available.
Default: ${WasHome}/java/jre/PolicyDirector
wp.ac.impl.JavaHome Location of the Java runtime in which to configure, which is the same as the -java_home command line argument in a manual execution.
Value: No values are available.
Examples: No examples are available.
Default: ${WasHome}/java/jre/
wp.ac.impl.CfgFilesPath Required filesystem directory location of the generated TAM AMJRTE properties. The properties files are created by the TAM PdjrteCfg command, which is the same as the -cfgfiles_path command line argument in a manual execution.
Value: No values are available.
Examples: No examples are available.
Default: ${WasHome}/java/jre
wp.ac.impl.TamHost TAM Policy Server used when running PDJrteCfg.
Value: No values are available.
Examples: No examples are available.
Default: your.TAM.Policy.Server.hostname

Tivoli Access Manager: SvrSslCfg command parameters
WebSphere Portal requires the following information to run the SvrSslCfg command

wp.ac.impl.PDServerName The unique application name and will be 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.
Value: No values are available.
Examples: No examples are available.
Default: amwp70
wp.ac.impl.SvrSslCfgPort Configuration port for the application name. This parameter is currently ignored by the SvrSslCfg command.
Value: numeric
Examples: No examples are available.
Default: 7223
wp.ac.impl.SvrSslCfgMode Configuration mode of the SvrSslCfg command. Currently, the only valid value is remote.
Value: remote
Examples: No examples are available.
Default: remote
wp.ac.impl.PDPolicyServerList Host name, port, and priority combinations for TAM Policy servers used when running SvrSslCfg.
Value: host:port:priority
Examples: hosta.ibm.com:7135:1 or host1.ibm.com:7135:1, hostb.7135:2
Default: your.TAM.Policy.Server.hostname:7135:1
wp.ac.impl.PDAuthzServerList Host name, port, and priority combination for TAM authorization servers.
Value: host:port:priority
Examples: hosta.ibm.com:7136:1
Default: your.TAM.Authorization.Server.hostname:7136:1
wp.ac.impl.PDKeyPath File used to store encryption keys used for the SSL communication between AMJRTE and Tivoli Access manager. This file is generated as a result of the SvrSslCfg command.
Value: No values are available.
Examples: No examples are available.
Default: ${WasHome}/java/jre/lib/pdperm.ks

Tivoli Access Manager: WebSEAL junction parameters
WebSphere Portal requires the following information to create WebSEAL junction.

wp.ac.impl.JunctionType Type of junction to create in TAM.
Value: tcp or ssl
Examples: No examples are available.
Default: tcp
wp.ac.impl.JunctionPoint WebSEAL junction point to the WebSphere Portal instance. In order to create a valid TAM junction, this value must begin with a / character.
Value: No values are available.
Examples: No examples are available.
Default: /wpsv70
wp.ac.impl.WebSealInstance WebSEAL instance used to create the junction. You can view the different WebSEAL instances by issuing a server list command from the pdadmin> command line.
Value: No values are available.
Examples: No examples are available.
Default: instance-webseald-yourhost.com
wp.ac.impl.TAICreds 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.
Value: No values are available.
Examples: No examples are available.
Default: iv-user,iv-creds
wp.ac.impl.JunctionHost This value is the backend server host name to supply to the junction create command
Value: No values are available.
Examples: No examples are available.
Default: ${WpsHostName}
wp.ac.impl.JunctionPort This value is the backend server port to supply to the junction create command.
Value: No values are available.
Examples: No examples are available.
Default: ${WpsHostPort}

Tivoli Access Manager: WAS WebSEAL TAI parameters
WebSphere Portal uses the following information for WebSEAL.

wp.ac.impl.hostnames Optional) Sets the WebSEAL TAI's hostnames parameter. You should include the host name you provided when configuring the WebSEAL instance. 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 and if any additional proxies are included, their host names must be added as well. Presence of this parameter will cause the TAI to evaluate the VIA header and only handle those requests that contain one of the provided host name, and port combinations.
Value: This value is case-sensitive and may be a comma-delimited list if more than one host name is provided.
Examples: hosta.yourcompany.com or hosta
Default: No default.
wp.ac.impl.ports Optional) Sets the WebSEAL TAI's ports parameter. You should include the WebSEAL ports in this comma-delimited list. The default WebSEAL port is 443. Presence of this parameter will cause the TAI to evaluate the VIA header and only handle those requests that contain one of the provided host name and port combinations.
Value: numeric
Examples: 443
Default: No default.
wp.ac.impl.loginId When you create a TCP junction, this value is 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.
Value: Alphanumeric text string
Examples: No examples are available.
Default: wpsadmin
wp.ac.impl.BaUserName When you create an SSL junction, this value 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.
Value: Alphanumeric text string
Examples: No examples are available.
Default: wpsadmin
wp.ac.impl.BaPassword When you create an SSL junction, you can provide a password to the identity representing the reverse proxy on every request. WAS will use this identity to establish the "trust" that is required to validate the WebSEAL iv-* headers.
Value: Alphanumeric text string
Examples: No examples are available.
Default: wpsadmin
wp.ac.impl.checkViaHeader You can configure TAI so that the VIA header can be ignored when validating trust for a request. Set this property to false if none of the hosts in the VIA header need to be trusted. When set this value to false you do not need to set the trusted host names and host ports properties. The only mandatory property to check when using header is false is com.ibm.websphere.security.webseal.loginId.
Value: true false
Examples: No examples are available.
Default: false
wp.ac.impl.viaDepth This value is a positive integer that specifies the number of source hosts in the VIA header to check for trust. By default, every host in the VIA header is checked, and if any host is not trusted, trust cannot be established. The VIA depth property is used when only some of the hosts in the VIA header have to be trusted. The setting indicates the number of hosts that are required to be trusted.
Value: positive integer.
Examples: No examples are available.
Default: 0
wp.ac.impl.ssoPwdExpiry After trust is established for a request, the single sign-on user password is cached, eliminating the need to have the TAI re-authenticate the single sign-on user with Tivoli Access Manager for every request. You can modify the cache timeout period by setting the single sign-on password expiry property to the required time in seconds. If the password expiry property is set to 0, the cached password never expires.
Value: time in seconds
Examples: No examples are available.
Default: 600
wp.ac.impl.ignoreProxy This property can be used to tell the TAI to ignore proxies as trusted hosts. If set to true the comments field of the hosts entry in the VIA header is checked to determine if a host is a proxy. Remember that not all proxies insert comments in the via header indicating that they are proxies. If the checkViaHeader property is set to false, then the ignoreProxy property has no influence in establishing trust.
Value: true or false
Examples: No examples are available.
Default: false

Tivoli Access Manager: Portal authorization parameters
The following information is used to authenticate with TAM.

wp.ac.impl.PDRoot Root objectspace entry in the TAM namespace. All Portal roles will be installed under this objectspace entry.
Value: No values are available.
Examples: No examples are available.
Default: /WPv70
wp.ac.impl.PDAction When the Tivoli Access Manager external authorization plugin is started, it will detect and, if necessary, create a custom action in Tivoli Access Manager. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles.
Value: No values are available.
Examples: No examples are available.
Default: m
wp.ac.impl.PDActionGroup When the Tivoli Access Manager external authorization plugin is started, it will detect and, if necessary, create a custom action group in Tivoli Access Manager. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles.
Value: No values are available.
Examples: No examples are available.
Default: [WP70]
wp.ac.impl.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 select No, the TAM administrator will be responsible for creating TAM ACLs to allow access to Portal roles.
Value: true or false
Examples: No examples are available.
Default: true

Tivoli Access Manager: Portal vault parameters
The following information is used to confgure a vault for Tivoli Access Manager.

wp.ac.impl.vaultType
Value: No value specified
Examples: None available
Default: No default value
wp.ac.impl.vaultProperties Properties file used to configure the vault with TAM specific user and SSL connection information. This file will automatically be created in the wp_profile/shared/app/config subdirectory and populated by the ant task based on previous task execution.
Value: No values are available.
Examples: No examples are available.
Default: accessmanagervault.properties
wp.ac.impl.manageResources Determines if the portal credential vault or any custom portlet is allowed to create new resource objects in TAM. If you set this value to false, Tivoli administrator must define the accessible / resources to associate users with using the Tivoli command line or GUI.
Value: true false
Examples: No examples are available.
Default: true
wp.ac.impl.readOnly Determines if the portal credential vault or any custom portlet is allowed to modify the secrets stored in TAM. If you set this value to true ("Read Only"), the Tivoli administrator must change the credentials associated with resources using the Tivoli command line or GUI.
Value: true false
Examples: No examples are available.
Default: false

Netegrity SiteMinder: Portal/SiteMinder authorization parameters
The following parameters enables WebSphere Portal to authenticate wit Netegrity SiteMinder.

wp.ac.impl.SMDomain This value is the SiteMinder Domain containing all externalized portal resources.
Value: Alphanumeric text string.
Examples: No examples are available.
Default: WebSphere Portal v70
wp.ac.impl.SMScheme This value is the SiteMinder Authentication scheme object name to use when creating realms.
Value: No values are available.
Examples: No examples are available.
Default: Basic
wp.ac.impl.SMAgent This value is the SiteMinder custom or 4.x web agent created to allow communication between WebSphere Portal and SiteMinder.
Value: Alphanumeric text string
Examples: No examples are available.
Default: ReplaceWithYourSiteMinderAgentName
wp.ac.impl.SMAgentPwd This value is the SiteMinder custom or 4.x agent password.
Value: Alphanumeric text string
Examples: No examples are available.
Default: ReplaceWithYourSiteMinderAgentPwd
wp.ac.impl.SMAgentGroup An externalized portal resource is assigned to a SiteMinder custom agent for SiteMinder isProtected and isAuthorized calls. In a non-cluster, the agent specified in the wp.ac.impl.SMAgent parameter is used. However, in a cluster, specify a common SiteMinder Agent Group to be assigned to the resource.
Value: No values are available.
Examples: No examples are available.
Default: no default
wp.ac.impl.SMAdminId This value is the SiteMinder administrator who must have a scope of System because new SiteMinder domains and realms will be created, as well as the realms representing Portal roles and reference to the webagent.
Value: Alphanumeric text string.
Examples: No examples are available.
Default: siteminder
wp.ac.impl.SMAdminPwd Password for the SiteMinder administrative user.
Value: Alphanumeric text string
Examples: No examples are available.
Default: ReplaceWithYourSiteMinderAdminPwd
wp.ac.impl.SMUserDir This value is the SiteMinder User Directory object referencing the LDAP server used for Portal users and groups.
Value: No values are available.
Examples: No examples are available.
Default: ReplaceWithYourSiteMinderUserDirectoryObject
wp.ac.impl.SMFailover Failover mode for the Siteminder Policy Server. SMFailover must be set to true if more than 1 policy server is listed in the SMServers property below.
Value: true false
Examples: No examples are available.
Default: false
wp.ac.impl.SMServers Comma delimited list of server for the SiteMinder agent. Important: If Policy Servers are listening on non-default ports (for example: not 44441,44442,44443), add the port property for each policy server manually in the ExternalAccessControlService.properties file.
Value: IP address
Examples: No examples are available.
Default: your.Policy.Server.ipaddress

WSRP configuration parameters
The following parameter defines the context root for Web services for remote portlets.

WsrpContextRoot The context root for Web services for remote portlets.
Value: string
Examples: In the following URL, wsrp is the context root: http://localhost:80/wsrp/portal
Default: wsrp

HTTP Basic Authentication Trust Association Interceptor (TAI) settings
WebSphere Portal using the following information to configure an HTTP Basic Authentication Trust Association Interceptor (TAI) to authenticate incoming requests using the HTTP Basic Authentication Protocol described in RFC 2617.

wp.sitem.cmd.BasicAuthEnabled Defines whether the basic authentication TAI is active or not.
Value: Valid values include:
true: means the TAI authenticates requests
false: means the TAI does not authenticate requests.

Examples: false
Default: true
wp.sitem.cmd.BasicAuthRealm The name of an authentication realm as defined in RFC 2617. The TAI challenges the client to authenticate against this realm. The default value for this property is the same authentication realm name as the one used by portal HTTP form based login.
Value: string
Examples: No examples are available.
Default: WPS
wp.sitem.cmd.BasicAuthUseRegExp Determine whether or not the patterns that you specified for the black list and white list properties above are to be interpreted as Java regular expressions. For more information see: http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html. - If Java regular expressions are not used, then only astericks are supported as wild cards. The following applies to astericks:
The asterisk ( * ) wildcard can appear anywhere in the pattern.
You can use multiple asterisk ( * ) wildcards within the same pattern.
To represent an asterisk as an actual character for matches in the pattern instead of using it as a wildcard, prefix it with a backslash like this: /* .
To represent the backslash as a character for matching, code it by using a double backslash: // .

Value: Valid values include:
true: means all the patterns in the black and white lists are interpreted as Java regular expressions.
false: means all patterns support only the asterisk ( * ) as a wildcard character that matches against any string.

Examples: Examples are provided for both Java regular expressions and astericks:
Java regular expressions examples:

[^X]* will match every user agent that does not contain an uppercase X in its product name.

.*my_browser.* will match every user agent that contains my_browser in its product name.

.*%5bX%5d is URL encoded for .*[X] and will match every URL that ends with X.

Examples: using astericks: ul>

*my_browser* will match every user agent that contains my_browser in its product name.

/myprefix*mysuffix will match every URL that starts with /myprefix and ends with mysuffix.

Fun/* Ag//ent will only match a user agent hat has Fun* Ag/ent as product name.

Default: false
wp.sitem.cmd.BasicAuthLoginTarget The alias of the JAAS login configuration used by the TAI. The default value is the same JAAS login configuration as the one used by portal HTTP form based login. The value is the target to execute to populate the Subject with portal specific Principals when logging on using the TAI.
Value: string
Examples: No examples are available.
Default: Portal_LTPA
wp.sitem.cmd.BasicAuthUserAgentBlackList List of patterns for which you do not want the TAI to handle the requests. Separate the patterns using a whitespaces. Every product name in the HTTP header field User-Agent of incoming requests is compared with each of the patterns specified for this property. If the TAI is enabled and the URL matches at least one of the patterns specified for the userAgentBlackList property, the TAI will not handle the request. To use Java regular expressions, set the property wp.sitem.cmd.BasicAuthUseRegExp = true.
Value: You can specify the patterns with an asterisk ( * ) as a wild card character. You can also define the patterns as Java regular expressions.
Examples: No examples are available.
Default: AllAgentsAllowed
wp.sitem.cmd.BasicAuthUserAgentWhiteList List of patterns for which you want the TAI to handle the requests. Separate the patterns by whitespaces. Every product name in the HTTP header field User-Agent of the incoming request is compared with each of the patterns specified for this property.If the TAI is enabled and the pattern specified for this property has at least one match and neither of the userAgentBlackList or the urlBlackList have a match, then the TAI handles the request. To use Java regular expressions, set the property wp.sitem.cmd.BasicAuthUseRegExp = true
Value: You can specify the patterns with an asterisk ( * ) as a wild card character. You can also define the patterns as Java regular expressions.
Examples: No examples are available.
Default: NoAgentSpecified
wp.sitem.cmd.BasicAuthUrlBlackList List of URI patterns this TAI will never handle. Separate the patterns by whitespaces. The full path information of the URL of the incoming request is compared with each of the patterns specified for this parameter. Before comparing the URL to the patterns, the protocol, server, port, and query information is removed from the URL. If the TAI is enabled and the URL matches at least one of the patterns specified for the urlBlackList property, the TAI will not handle the request. To use Java regular expressions, set the property wp.sitem.cmd.BasicAuthUseRegExp = true.
Value: Use the following syntax rules for specifying the patterns:
You can use URI encoded patterns, such as using %20 to encode blank spaces.
Use only characters that are valid within a URI, and encode all other characters.
You can use an asterisk ( * ) as a wild card character.

Examples: No examples are available
Default: /${WpsContextRoot}/myportal*
wp.sitem.cmd.BasicAuthUrlWhiteList List of patterns for which you want the TAI to handle the requests. Separate the patterns by whitespaces. The full path information of the URL of the incoming request is compared with each of the patterns specified for this parameter. Before comparing the URL to the patterns, the protocol, server, port, and query information is removed from the URL. If the TAI is enabled and the pattern specified for this property has at least one match and neither of the userAgentBlackList or the urlBlackList have a match, then the TAI handles the request. To use Java regular expressions, set the property wp.sitem.cmd.BasicAuthUseRegExp = true.
Value: Use the following syntax rules for specifying the patterns:
You can use URI encoded patterns, such as using %20 to encode blank spaces.
Use only characters that are valid within a URI, and encode all other characters.
You can use an asterisk ( * ) as a wild card character.

Examples: No examples are available.
Default: /${WpsContextRoot}/mycontenthandler*

Parent
Configuration properties reference

+
Search Tips | Advanced Search

pi.IsCrossCell	Set to true if the WebSphere Process Server installation that WebSphere Portal connects to is located in another cell. If WebSphere Process Server is not in another cell, set the value to false. Value: true or false Examples: No examples are available. Default: true
pi.ProcessServerHostAddress	This property is used only if the pi.IsCrossCell value is set to true. The server host name address of the WebSphere Process Server installation in another cell. Value: No values are available. Examples: No examples are available. Default: No default
pi.ProcessServerBootstrapPort	This property is used only if the pi.IsCrossCell value is set to true. The bootstrap port of the WebSphere Process Server installation in another cell. Value: port number Examples: No examples are available. Default: No default
pi.ProcessArtifactsLocation	This property is used only if the pi.IsCrossCell value is set to true. The directory in which the process artifacts are located. Value: directory path Examples: No examples are available. Default: ${USER_INSTALL_ROOT}/processArtifacts
pi.IsWPSCluster	This property is used only if the pi.IsCrossCell value is set to false. Set to true if WebSphere Portal connects to a WebSphere Process Server cluster in the same cell. If WebSphere Portal connects to a WebSphere Process Server cluster in different cell, set the value to false. Value: true or false Examples: No examples are available. Default: No default.
pi.ClusterName	This property is used only if the pi.IsCrossCell value is set to false AND pi.IsWPSCluster value is set to true. The name of the WebSphere Process Server cluster. Value: cluster name Examples: No examples are available. Default: No default.
pi.NodeName	This property is used only if the pi.IsCrossCell value is set to false AND pi.IsWPSCluster value is set to false. Name of the node of the WebSphere Process Server server. Value: node name Examples: No examples are available. Default: No default.
pi.ServerName	This property is used only if the pi.IsCrossCell value is set to false AND pi.IsWPSCluster value is set to false. Name of the WebSphere Process Server server. Value: server name Examples: No examples are available. Default: No default.

wp.ac.impl.EACserverName	Optional) You can set different "contexts" to further distinguish externalized role names from other role names in the Tivoli Access Manager namespace. This context information will be added to the namespace entry created upon role externalization. If any of the three context values (EACserverName, EACcellName, or EACappName) are null, none will be used. Value: server name Examples: No examples are available. Default: WebSphere_Portal
wp.ac.impl.EACcellName	One of the three context values used to set a different context to further distinguish the externalized role name Value: cell name Examples: No examples available. Default: No default value provided.
wp.ac.impl.EACappName	One of the three context values used to set a different context to further distinguish the externalized role name Value: application name Examples: wps Default: wps
wp.ac.impl.reorderRoles	Allows you to either have externalized Portal rolenames displayed with the resource type first, or the role types first. Value: true or false Examples: true example: /WPv70/wps.CONTENT_NODE/Welcome_Page/10_2E@Aministrator/app/server/cell true example: /WPv70/wps.CONTENT_NODE/Welcome_Page/10_2E@Editor/app/server/cell true example: /WPv70/wps.CONTENT_NODE/Administration/15_AF@Aministrator/app/server/cell true example: /WPv70/wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q@Aministrator/app/server/cell true example: /WPv70/wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q@User/app/server/cell false example: /WPv70/Aministrator@wps.CONTENT_NODE/Welcome_Page/10_2E/app/server/cell false example: /WPv70/Administrator@wps.CONTENT_NODE/Administration/15_AF/app/server/cell false example: /WPv70/Administrator@wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q/app/server/cell false example: /WPv70/Editor@wps.CONTENT_NODE/Welcome_Page/10_2E/app/server/cell false example: /WPv70/User@wps.PORTLET_APPLICATION/Welcome_Portlet/09_2Q/app/server/cell Default: false

wp.ac.impl.PDClasspath	The location of the TAM PD.jar file, which contains the classes required to establish a connection to the policy server and is passed into the classpath of the command. Value: No values are available. Examples: No examples are available. Default: ${WasHome}/java/jre/lib/ext/PD.jar
wp.ac.impl.PDHome	Location of the TAM AMJRTE, which is the same as the pd.home system property in a manual execution. Value: No values are available. Examples: No examples are available. Default: ${WasHome}/java/jre/PolicyDirector
wp.ac.impl.JavaHome	Location of the Java runtime in which to configure, which is the same as the -java_home command line argument in a manual execution. Value: No values are available. Examples: No examples are available. Default: ${WasHome}/java/jre/
wp.ac.impl.CfgFilesPath	Required filesystem directory location of the generated TAM AMJRTE properties. The properties files are created by the TAM PdjrteCfg command, which is the same as the -cfgfiles_path command line argument in a manual execution. Value: No values are available. Examples: No examples are available. Default: ${WasHome}/java/jre
wp.ac.impl.TamHost	TAM Policy Server used when running PDJrteCfg. Value: No values are available. Examples: No examples are available. Default: your.TAM.Policy.Server.hostname

wp.ac.impl.PDServerName	The unique application name and will be 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. Value: No values are available. Examples: No examples are available. Default: amwp70
wp.ac.impl.SvrSslCfgPort	Configuration port for the application name. This parameter is currently ignored by the SvrSslCfg command. Value: numeric Examples: No examples are available. Default: 7223
wp.ac.impl.SvrSslCfgMode	Configuration mode of the SvrSslCfg command. Currently, the only valid value is remote. Value: remote Examples: No examples are available. Default: remote
wp.ac.impl.PDPolicyServerList	Host name, port, and priority combinations for TAM Policy servers used when running SvrSslCfg. Value: host:port:priority Examples: hosta.ibm.com:7135:1 or host1.ibm.com:7135:1, hostb.7135:2 Default: your.TAM.Policy.Server.hostname:7135:1
wp.ac.impl.PDAuthzServerList	Host name, port, and priority combination for TAM authorization servers. Value: host:port:priority Examples: hosta.ibm.com:7136:1 Default: your.TAM.Authorization.Server.hostname:7136:1
wp.ac.impl.PDKeyPath	File used to store encryption keys used for the SSL communication between AMJRTE and Tivoli Access manager. This file is generated as a result of the SvrSslCfg command. Value: No values are available. Examples: No examples are available. Default: ${WasHome}/java/jre/lib/pdperm.ks

wp.ac.impl.JunctionType	Type of junction to create in TAM. Value: tcp or ssl Examples: No examples are available. Default: tcp
wp.ac.impl.JunctionPoint	WebSEAL junction point to the WebSphere Portal instance. In order to create a valid TAM junction, this value must begin with a / character. Value: No values are available. Examples: No examples are available. Default: /wpsv70
wp.ac.impl.WebSealInstance	WebSEAL instance used to create the junction. You can view the different WebSEAL instances by issuing a server list command from the pdadmin> command line. Value: No values are available. Examples: No examples are available. Default: instance-webseald-yourhost.com
wp.ac.impl.TAICreds	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. Value: No values are available. Examples: No examples are available. Default: iv-user,iv-creds
wp.ac.impl.JunctionHost	This value is the backend server host name to supply to the junction create command Value: No values are available. Examples: No examples are available. Default: ${WpsHostName}
wp.ac.impl.JunctionPort	This value is the backend server port to supply to the junction create command. Value: No values are available. Examples: No examples are available. Default: ${WpsHostPort}

wp.ac.impl.hostnames	Optional) Sets the WebSEAL TAI's hostnames parameter. You should include the host name you provided when configuring the WebSEAL instance. 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 and if any additional proxies are included, their host names must be added as well. Presence of this parameter will cause the TAI to evaluate the VIA header and only handle those requests that contain one of the provided host name, and port combinations. Value: This value is case-sensitive and may be a comma-delimited list if more than one host name is provided. Examples: hosta.yourcompany.com or hosta Default: No default.
wp.ac.impl.ports	Optional) Sets the WebSEAL TAI's ports parameter. You should include the WebSEAL ports in this comma-delimited list. The default WebSEAL port is 443. Presence of this parameter will cause the TAI to evaluate the VIA header and only handle those requests that contain one of the provided host name and port combinations. Value: numeric Examples: 443 Default: No default.
wp.ac.impl.loginId	When you create a TCP junction, this value is 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. Value: Alphanumeric text string Examples: No examples are available. Default: wpsadmin
wp.ac.impl.BaUserName	When you create an SSL junction, this value 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. Value: Alphanumeric text string Examples: No examples are available. Default: wpsadmin
wp.ac.impl.BaPassword	When you create an SSL junction, you can provide a password to the identity representing the reverse proxy on every request. WAS will use this identity to establish the "trust" that is required to validate the WebSEAL iv-* headers. Value: Alphanumeric text string Examples: No examples are available. Default: wpsadmin
wp.ac.impl.checkViaHeader	You can configure TAI so that the VIA header can be ignored when validating trust for a request. Set this property to false if none of the hosts in the VIA header need to be trusted. When set this value to false you do not need to set the trusted host names and host ports properties. The only mandatory property to check when using header is false is com.ibm.websphere.security.webseal.loginId. Value: true false Examples: No examples are available. Default: false
wp.ac.impl.viaDepth	This value is a positive integer that specifies the number of source hosts in the VIA header to check for trust. By default, every host in the VIA header is checked, and if any host is not trusted, trust cannot be established. The VIA depth property is used when only some of the hosts in the VIA header have to be trusted. The setting indicates the number of hosts that are required to be trusted. Value: positive integer. Examples: No examples are available. Default: 0
wp.ac.impl.ssoPwdExpiry	After trust is established for a request, the single sign-on user password is cached, eliminating the need to have the TAI re-authenticate the single sign-on user with Tivoli Access Manager for every request. You can modify the cache timeout period by setting the single sign-on password expiry property to the required time in seconds. If the password expiry property is set to 0, the cached password never expires. Value: time in seconds Examples: No examples are available. Default: 600
wp.ac.impl.ignoreProxy	This property can be used to tell the TAI to ignore proxies as trusted hosts. If set to true the comments field of the hosts entry in the VIA header is checked to determine if a host is a proxy. Remember that not all proxies insert comments in the via header indicating that they are proxies. If the checkViaHeader property is set to false, then the ignoreProxy property has no influence in establishing trust. Value: true or false Examples: No examples are available. Default: false

wp.ac.impl.PDRoot	Root objectspace entry in the TAM namespace. All Portal roles will be installed under this objectspace entry. Value: No values are available. Examples: No examples are available. Default: /WPv70
wp.ac.impl.PDAction	When the Tivoli Access Manager external authorization plugin is started, it will detect and, if necessary, create a custom action in Tivoli Access Manager. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles. Value: No values are available. Examples: No examples are available. Default: m
wp.ac.impl.PDActionGroup	When the Tivoli Access Manager external authorization plugin is started, it will detect and, if necessary, create a custom action group in Tivoli Access Manager. The combination of the action group and the action determines the TAM permission string required to assign membership to externalized Portal roles. Value: No values are available. Examples: No examples are available. Default: [WP70]
wp.ac.impl.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 select No, the TAM administrator will be responsible for creating TAM ACLs to allow access to Portal roles. Value: true or false Examples: No examples are available. Default: true

wp.ac.impl.vaultType	Value: No value specified Examples: None available Default: No default value
wp.ac.impl.vaultProperties	Properties file used to configure the vault with TAM specific user and SSL connection information. This file will automatically be created in the wp_profile/shared/app/config subdirectory and populated by the ant task based on previous task execution. Value: No values are available. Examples: No examples are available. Default: accessmanagervault.properties
wp.ac.impl.manageResources	Determines if the portal credential vault or any custom portlet is allowed to create new resource objects in TAM. If you set this value to false, Tivoli administrator must define the accessible / resources to associate users with using the Tivoli command line or GUI. Value: true false Examples: No examples are available. Default: true
wp.ac.impl.readOnly	Determines if the portal credential vault or any custom portlet is allowed to modify the secrets stored in TAM. If you set this value to true ("Read Only"), the Tivoli administrator must change the credentials associated with resources using the Tivoli command line or GUI. Value: true false Examples: No examples are available. Default: false

wp.ac.impl.SMDomain	This value is the SiteMinder Domain containing all externalized portal resources. Value: Alphanumeric text string. Examples: No examples are available. Default: WebSphere Portal v70
wp.ac.impl.SMScheme	This value is the SiteMinder Authentication scheme object name to use when creating realms. Value: No values are available. Examples: No examples are available. Default: Basic
wp.ac.impl.SMAgent	This value is the SiteMinder custom or 4.x web agent created to allow communication between WebSphere Portal and SiteMinder. Value: Alphanumeric text string Examples: No examples are available. Default: ReplaceWithYourSiteMinderAgentName
wp.ac.impl.SMAgentPwd	This value is the SiteMinder custom or 4.x agent password. Value: Alphanumeric text string Examples: No examples are available. Default: ReplaceWithYourSiteMinderAgentPwd
wp.ac.impl.SMAgentGroup	An externalized portal resource is assigned to a SiteMinder custom agent for SiteMinder isProtected and isAuthorized calls. In a non-cluster, the agent specified in the wp.ac.impl.SMAgent parameter is used. However, in a cluster, specify a common SiteMinder Agent Group to be assigned to the resource. Value: No values are available. Examples: No examples are available. Default: no default
wp.ac.impl.SMAdminId	This value is the SiteMinder administrator who must have a scope of System because new SiteMinder domains and realms will be created, as well as the realms representing Portal roles and reference to the webagent. Value: Alphanumeric text string. Examples: No examples are available. Default: siteminder
wp.ac.impl.SMAdminPwd	Password for the SiteMinder administrative user. Value: Alphanumeric text string Examples: No examples are available. Default: ReplaceWithYourSiteMinderAdminPwd
wp.ac.impl.SMUserDir	This value is the SiteMinder User Directory object referencing the LDAP server used for Portal users and groups. Value: No values are available. Examples: No examples are available. Default: ReplaceWithYourSiteMinderUserDirectoryObject
wp.ac.impl.SMFailover	Failover mode for the Siteminder Policy Server. SMFailover must be set to true if more than 1 policy server is listed in the SMServers property below. Value: true false Examples: No examples are available. Default: false
wp.ac.impl.SMServers	Comma delimited list of server for the SiteMinder agent. Important: If Policy Servers are listening on non-default ports (for example: not 44441,44442,44443), add the port property for each policy server manually in the ExternalAccessControlService.properties file. Value: IP address Examples: No examples are available. Default: your.Policy.Server.ipaddress

wp.sitem.cmd.BasicAuthEnabled	Defines whether the basic authentication TAI is active or not. Value: Valid values include: true: means the TAI authenticates requests false: means the TAI does not authenticate requests. Examples: false Default: true
wp.sitem.cmd.BasicAuthRealm	The name of an authentication realm as defined in RFC 2617. The TAI challenges the client to authenticate against this realm. The default value for this property is the same authentication realm name as the one used by portal HTTP form based login. Value: string Examples: No examples are available. Default: WPS
wp.sitem.cmd.BasicAuthUseRegExp	Determine whether or not the patterns that you specified for the black list and white list properties above are to be interpreted as Java regular expressions. For more information see: http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html. - If Java regular expressions are not used, then only astericks are supported as wild cards. The following applies to astericks: The asterisk ( * ) wildcard can appear anywhere in the pattern. You can use multiple asterisk ( * ) wildcards within the same pattern. To represent an asterisk as an actual character for matches in the pattern instead of using it as a wildcard, prefix it with a backslash like this: /* . To represent the backslash as a character for matching, code it by using a double backslash: // . Value: Valid values include: true: means all the patterns in the black and white lists are interpreted as Java regular expressions. false: means all patterns support only the asterisk ( * ) as a wildcard character that matches against any string. Examples: Examples are provided for both Java regular expressions and astericks: Java regular expressions examples: [^X]* will match every user agent that does not contain an uppercase X in its product name. .my_browser. will match every user agent that contains my_browser in its product name. .%5bX%5d is URL encoded for .[X] and will match every URL that ends with X.
Examples: using astericks:	ul> my_browser will match every user agent that contains my_browser in its product name. /myprefixmysuffix will match every URL that starts with /myprefix and ends with mysuffix. Fun/ Ag//ent will only match a user agent hat has Fun* Ag/ent as product name. Default: false
wp.sitem.cmd.BasicAuthLoginTarget	The alias of the JAAS login configuration used by the TAI. The default value is the same JAAS login configuration as the one used by portal HTTP form based login. The value is the target to execute to populate the Subject with portal specific Principals when logging on using the TAI. Value: string Examples: No examples are available. Default: Portal_LTPA
wp.sitem.cmd.BasicAuthUserAgentBlackList	List of patterns for which you do not want the TAI to handle the requests. Separate the patterns using a whitespaces. Every product name in the HTTP header field User-Agent of incoming requests is compared with each of the patterns specified for this property. If the TAI is enabled and the URL matches at least one of the patterns specified for the userAgentBlackList property, the TAI will not handle the request. To use Java regular expressions, set the property wp.sitem.cmd.BasicAuthUseRegExp = true. Value: You can specify the patterns with an asterisk ( * ) as a wild card character. You can also define the patterns as Java regular expressions. Examples: No examples are available. Default: AllAgentsAllowed
wp.sitem.cmd.BasicAuthUserAgentWhiteList	List of patterns for which you want the TAI to handle the requests. Separate the patterns by whitespaces. Every product name in the HTTP header field User-Agent of the incoming request is compared with each of the patterns specified for this property.If the TAI is enabled and the pattern specified for this property has at least one match and neither of the userAgentBlackList or the urlBlackList have a match, then the TAI handles the request. To use Java regular expressions, set the property wp.sitem.cmd.BasicAuthUseRegExp = true Value: You can specify the patterns with an asterisk ( * ) as a wild card character. You can also define the patterns as Java regular expressions. Examples: No examples are available. Default: NoAgentSpecified
wp.sitem.cmd.BasicAuthUrlBlackList	List of URI patterns this TAI will never handle. Separate the patterns by whitespaces. The full path information of the URL of the incoming request is compared with each of the patterns specified for this parameter. Before comparing the URL to the patterns, the protocol, server, port, and query information is removed from the URL. If the TAI is enabled and the URL matches at least one of the patterns specified for the urlBlackList property, the TAI will not handle the request. To use Java regular expressions, set the property wp.sitem.cmd.BasicAuthUseRegExp = true. Value: Use the following syntax rules for specifying the patterns: You can use URI encoded patterns, such as using %20 to encode blank spaces. Use only characters that are valid within a URI, and encode all other characters. You can use an asterisk ( * ) as a wild card character. Examples: No examples are available Default: /${WpsContextRoot}/myportal*
wp.sitem.cmd.BasicAuthUrlWhiteList	List of patterns for which you want the TAI to handle the requests. Separate the patterns by whitespaces. The full path information of the URL of the incoming request is compared with each of the patterns specified for this parameter. Before comparing the URL to the patterns, the protocol, server, port, and query information is removed from the URL. If the TAI is enabled and the pattern specified for this property has at least one match and neither of the userAgentBlackList or the urlBlackList have a match, then the TAI handles the request. To use Java regular expressions, set the property wp.sitem.cmd.BasicAuthUseRegExp = true. Value: Use the following syntax rules for specifying the patterns: You can use URI encoded patterns, such as using %20 to encode blank spaces. Use only characters that are valid within a URI, and encode all other characters. You can use an asterisk ( * ) as a wild card character. Examples: No examples are available. Default: /${WpsContextRoot}/mycontenthandler*