Global property group

This group contains general settings, including server names, addresses, mail properties, and portal properties.

Properties are listed in alphabetical order for ease of reference.

Global property name	Default value	Description
alwaysValidateSession	true	(true/false) When this value is set to “true,” the user’s portal session is validated on every request. There is a slight performance penalty for this. When this value is set to “false,” the session is checked only when security configuration requires an explicit authorization.
Anonymous.Roles	everybody PortalGuest	Lists the J2EE role values for anonymous users. Values are comma separated.
catalog_cache_refresh_list	127.0.0.1:8080/onepage	Keep the default entry for a single-machine installation. For a multimachine installation, enter the list of machines with catalogs that should be refreshed when a cache refresh is triggered. Use commas to separate entries in the list. If you use the machine name, there must be a DNS entry inside the machine to resolve the entry. This comma-separated list should consist of machine names that are internally addressable from within the servers themselves and should include the port number followed by the name of the Web application. Example: `"catalog_cache_refresh_list= demo1.$DOMAIN:8080/onepage, demo2.$DOMAIN:8080/onepage"` If the `xml_catalog_serialize` property is set to “yes,” you must also set a value for `catalog_cache_refresh_list`.
changeMyInfo	true	(true/false) When this value is set to “false”, the MyInfo links for “change password”, “personal information”, and “join now” do not display.
client_virtual_path	/onepage/	Used for JSP forward/include; for example: BEA=/onepage/ iplanet=/onepage/
default_http_port	8080	The application server port number. You provide the initial value at installation. This value must match the default application server HTTP port number and must be the same as the application server settings. If you change EAServer listener port numbers, you must also change this value to match.
default_https_port	8081	The application server HTTPS port number. This value must match the default application server HTTP port number and must line up with the application server settings. If you change listener port numbers, you must also change this value.
default_tile_href	“ “	Default HREF that appears on portlet title bars. The default is none. If you wanted the same HREF to display on most portlet title bars, enter that HREF here. This value can be overridden during portlet creation.
DefaultResourceID	1	The resource ID (RID) that is used if one is not included in a request.
DefaultUserID	1	The user ID that is used if one is not included in a request.
deferupdate	on	(on/off) When this value is set to “on”, the user’s view is updated only during login. When an operation to update user pages is performed, the command is recorded for later execution instead of executing immediately.
disableAutomaticReauthentication	false	(true/false) Set to “true” to disable the automatic re-authentication feature of the portal when using EPSecurity. The PortalSession Primary Key information will not be wrapped in the SessionID (SID) parameter.
DocumentRoot	/PortletDocs	Indicates the directory where portlet documents reside.
domain	subdomain.domain	The DNS name of your portal Web server in the format “.xxx.xxx”. Include any subdomain. This value is used by the portal’s servers. If you change your installation’s domain, you must change the value here to the new domain name.
ep_security_eas_guest_pwd	guest	Password of EP guest account used to connect to EAServer during self-registration.
ep_security_eas_url	iiop://hostname.domain: 9000	URL for EAServer IIOP service when EP security is remotely installed. This may be a semicolon separated list if security is deployed to a cluster.
https.playback	on	(on/off) Enables secure bypass for Web applications. Turn “off” when using Oracle as the portal database.
javascript.domain	domain	DNS name of your portal JavaScript Web server in the same format as the “domain” without the leading period (.) Included any subdomain. This value is used by the browser from which you are running the portal.
mail.host	10.22.97.100	Fully qualified DNS name or IP address of the mail server. This should be a server that is internally available to you. You must change this value after installation to enter your own mail.host. The default entry is not a valid mail host.
mail.transport.protocol	smtp	(smtp/imap) Mail protocol. Currently, only SMTP is supported.
markupNoJSFile	/config/noJavascript OcMarkup.txt	If you cannot navigate through a Web site because of JavaScript, enter that site here and Web Studio ignores or removes the JavaScript.
maxPageName	25	Maximum number of characters allowed per tab/page name.
maxTabSetChar	5000	Maximum number of characters per tabset.
maxTabSets	99	Maximum number of page groups (tabsets) allowed. Valid range is 1- 99.
multipleGuestPages	true	(true/false) Controls the number of guest pages to display. Set to “false” to display only one guest page.
page.group	on	(off/on) Set to “on” to enable page groups in the portal.
passwordExpirationWarningWindow	30	When the portal.epSecurity property is set to “true,” users see warning messages a number of days prior to their password expiration equal to the value of this property. Set this property to 0 (zero) to disable password expiration warnings.
PortalAdministrationRole	PortalAdmin	The J2EE role required to administer the portal, perform export/import and update operations. WARNING! This property is designed for a single role and not a list of roles. There is no parsing of the string to look for multiple roles.
portal.defaultRID	1	Default resource ID (RID) for the portal. If a request does not include a RID, the systems falls back to the RID specified here. When you add a new resource in Web Studio, you may want to change the value here.
portal.epSecurity	true	(true/false) Set to “true” to register users with Enterprise Security.
portal.host	hostname	Host name of the page playback server. The initial value is supplied at installation.
portal.portlet_create_lock	E,T,U	Lists the page types on which create, add, and move portlet cannot be done: E – default T – catalog U – guest page
proxy	off	(on/off) Set this value to “on” only if you are planning to use a HTTP proxy server, and this proxy server is installed and configured.
proxy.bypass_list	127.0.0.1 \| localhost	Value – host1\|host2 The addresses and host names of Enterprise Portal machines that must bypass the proxy server. When there are machines that cannot go through the proxy server (typically for internal sites), create the list of machines names; separate machine names using a bar (\|). See the HTTPConnection Javadocs for information on dontProxyFor() method.
proxy.host	127.0.0.1	IP address of the proxy server. Enter this value only if the proxy property is set to “on.”
proxy.password	DefaultProxyUserPassword	Configure this property only if the proxy property is set to “on” and the user exists on the proxy server
proxy.port	3128	Port number of the proxy server cache. Configure this property only if the proxy property is set to “on” and the user exists on the proxy server.
proxy.user	DefaultProxyUserName	Configure this property only if the proxy property is set to “on” and the user exists on the proxy server
redirfile	/config/redirlist.txt	The location and content to which a user is redirected if he or she enters a URL that does not exist or is unavailable.
registration.organization	o=Sybase Inc,c=us"	Defines the EP security organization where self-registered users are added. The default organization is the root organization
registration.userJ2EERoles	“ “	Lists the J2EE role values. Values are comma-separated.
RequiredRoles	everybody	Lists required J2EE role values in conjunction with roles specified in web.xml. Values are comma-separated.
resetPasswordEmail	pso@yourCompany.com	A semicolon-delimited list of e-mail addresses to which reset password notifications are to be sent.
RoleBaseDisplay	true	(true/false) Indicates whether listings should show objects with only the same role as the user.
RoleBaseDisplaySeeAllRoles	superuser	Supersedes the RoleBaseDisplay property. Any roles listed here see every item as if RoleBaseDisplay was set to “false”. Values are comma-separated.
secure	off	(off/on) Set to “on” to enable HTTPS for the Web container. HTTPS will be used for log in and registration.
SecureHostname	LoadBalanceSecure Serverhost.domain	Fully qualified host name for the load-balanced secure publish/subscribe server used by Web Studio and the portlet playback server (UWP or UPP).
secure_login	off	(off/on) Set to “off” to have Portal Interface login and self-registration occur over HTTP. When this value is set to “on”, Portal Interface uses HTTPS during login and self-registration. Before setting this value to “on”, you must configure EAServer for HTTPS. See the Enterprise Security Administration Guide for more information.
secure.tile.host	hostname	Hostname of the secure HTTPS portlet playback server. The initial value is supplied at installation. This value should be the same as tile.host.
send.mail	true	(true/false) Set this value to “true” if you want SMTP-based e-mail sent when you create a new accounts in Web Studio, or when Portal Interface users register for the first time or request to change their password. If set to “false,” e-mail content is written to the workroot/e-mail directory. You can leave this value set to “true,” then set the value to “false” for individual portals in the cobrands.xml file. See Chapter 14, “Creating Co-brands.”
server_virtual_path	/	Used for JSP forward/include; for example: BEA=/ JRun=/ iplanet=/onepage/
sharePage	on	(on/off) Enables page sharing in Portal Interface.
SOAPServer	127.0.0.1	The SOAP server machine name.
tabingChar	4	The number of characters that tabs use for the corners.
tabset	on	(off/on) Enables tabsets.
tile.host Tile is synonymous with portlet.	hostname	Host name of the portlet playback server. The initial value is supplied at installation.
tile_style	3	Values – 1, 2, 3 <IFRAME> tag only. Defines an inline frame for the inclusion of external objects including other HTML documents. Unlike frames created using <FRAMESET> and <FRAME>, <IFRAME> creates a frame that sits in the middle of a regular nonframed Web page. <IFRAME> works like <IMG>, only instead of putting a picture on the page, it puts another Web page on the page. Internet Explorer versions 5.x and 6.x support <IFRAME>. Netscape 6 supports <IFRAME> but not all of the attributes. Versions of Netscape earlier than version 6 do not support <IFRAME>. <DIV> tag only. The <DIV> tag has a single attribute—align—with four possible values—left, center, right, and justify. The <DIV> tag is used primarily to create divisions that require the same alignment attribute within an HTML document. Does not work on Netscape 7, which does not support Web data within <DIV> tags. Mixed mode. The portlet is formatted using either an <IFRAME> or a <DIV> tag, depending on which tag is more appropriate to the portlet’s content.
turnOffSecurePassword	secure_passwd_off	(on/off) Toggles use of secure password prompt by Portal Interface when using http portlets created from Web Studio.
use_https	on	(on/off) Enables secure navigation.
versioning	on	(on/off) Enables versioning of portlets and catalogs.
WebServiceRoot	/ws	This property indicates the root directory for web services. There are two ways to enter this information: Enter an absolute location. For example, if you enter d:\work\service\ws on Windows or /work0-/service/ws on UNIX, the system adds files directly to the specified location. You must ensure that the location can be accessed from a URL, like http://localhost:8085/onepage/ws. Enter a relative location. For example, if you enter service\ws on Windows or service/ws on UNIX, the system adds files to the location relative to the current Web application; specifically, root/work0/tomcat/webapps/onepage/service/ws (on UNIX). You must ensure that the location can be accessed from a URL, like http://localhost:8085/onepage/service/ws.
wireless_portal	off	(on/off) Set to “on” to enable wireless_portal, which uses the Windows player to play captured portlets.
WorkRoot	/tmp	Base working directory to which the portal can write log files, upload files, and so on.
xml_catalog_serialize	yes	(yes/no) Enter “yes” to create local serialized objects of the XML catalog in your local /onepage/lib directory. This allows a quicker-loading catalog. Enter “no” to disable catalog serialization.

Global property name

Default value

Description

alwaysValidateSession

true

(true/false) When this value is set to “true,” the user’s portal session is validated on every request. There is a slight performance penalty for this. When this value is set to “false,” the session is checked only when security configuration requires an explicit authorization.

Anonymous.Roles

everybody

PortalGuest

Lists the J2EE role values for anonymous users. Values are comma separated.

catalog_cache_refresh_list

127.0.0.1:8080/onepage

Keep the default entry for a single-machine installation.

For a multimachine installation, enter the list of machines with catalogs that should be refreshed when a cache refresh is triggered. Use commas to separate entries in the list.

If you use the machine name, there must be a DNS entry inside the machine to resolve the entry.

This comma-separated list should consist of machine names that are internally addressable from within the servers themselves and should include the port number followed by the name of the Web application.

Example:

"catalog_cache_refresh_list= demo1.$DOMAIN:8080/onepage, demo2.$DOMAIN:8080/onepage"

If the xml_catalog_serialize property is set to “yes,” you must also set a value for catalog_cache_refresh_list.

changeMyInfo

true

(true/false) When this value is set to “false”, the MyInfo links for “change password”, “personal information”, and “join now” do not display.

client_virtual_path

/onepage/

Used for JSP forward/include; for example:

BEA=/onepage/

iplanet=/onepage/

default_http_port

8080

The application server port number. You provide the initial value at installation.

This value must match the default application server HTTP port number and must be the same as the application server settings.

If you change EAServer listener port numbers, you must also change this value to match.

default_https_port

8081

The application server HTTPS port number.

This value must match the default application server HTTP port number and must line up with the application server settings.

If you change listener port numbers, you must also change this value.

default_tile_href

“ “

Default HREF that appears on portlet title bars. The default is none. If you wanted the same HREF to display on most portlet title bars, enter that HREF here. This value can be overridden during portlet creation.

DefaultResourceID

The resource ID (RID) that is used if one is not included in a request.

DefaultUserID

The user ID that is used if one is not included in a request.

deferupdate

(on/off) When this value is set to “on”, the user’s view is updated only during login. When an operation to update user pages is performed, the command is recorded for later execution instead of executing immediately.

disableAutomaticReauthentication

false

(true/false) Set to “true” to disable the automatic re-authentication feature of the portal when using EPSecurity. The PortalSession Primary Key information will not be wrapped in the SessionID (SID) parameter.

DocumentRoot

/PortletDocs

Indicates the directory where portlet documents reside.

domain

subdomain.domain

The DNS name of your portal Web server in the format “.xxx.xxx”. Include any subdomain.

This value is used by the portal’s servers. If you change your installation’s domain, you must change the value here to the new domain name.

ep_security_eas_guest_pwd

guest

Password of EP guest account used to connect to EAServer during self-registration.

ep_security_eas_url

iiop://hostname.domain: 9000

URL for EAServer IIOP service when EP security is remotely installed. This may be a semicolon separated list if security is deployed to a cluster.

https.playback

(on/off) Enables secure bypass for Web applications. Turn “off” when using Oracle as the portal database.

javascript.domain

domain

DNS name of your portal JavaScript Web server in the same format as the “domain” without the leading period (.) Included any subdomain. This value is used by the browser from which you are running the portal.

mail.host

10.22.97.100

Fully qualified DNS name or IP address of the mail server. This should be a server that is internally available to you.

You must change this value after installation to enter your own mail.host. The default entry is not a valid mail host.

mail.transport.protocol

smtp

(smtp/imap) Mail protocol. Currently, only SMTP is supported.

markupNoJSFile

/config/noJavascript OcMarkup.txt

If you cannot navigate through a Web site because of JavaScript, enter that site here and Web Studio ignores or removes the JavaScript.

maxPageName

Maximum number of characters allowed per tab/page name.

maxTabSetChar

5000

Maximum number of characters per tabset.

maxTabSets

Maximum number of page groups (tabsets) allowed. Valid range is 1- 99.

multipleGuestPages

true

(true/false) Controls the number of guest pages to display. Set to “false” to display only one guest page.

page.group

(off/on) Set to “on” to enable page groups in the portal.

passwordExpirationWarningWindow

When the portal.epSecurity property is set to “true,” users see warning messages a number of days prior to their password expiration equal to the value of this property. Set this property to 0 (zero) to disable password expiration warnings.

PortalAdministrationRole

PortalAdmin

The J2EE role required to administer the portal, perform export/import and update operations.

WARNING! This property is designed for a single role and not a list of roles. There is no parsing of the string to look for multiple roles.

portal.defaultRID

Default resource ID (RID) for the portal. If a request does not include a RID, the systems falls back to the RID specified here. When you add a new resource in Web Studio, you may want to change the value here.

portal.epSecurity

true

(true/false) Set to “true” to register users with Enterprise Security.

portal.host

hostname

Host name of the page playback server. The initial value is supplied at installation.

portal.portlet_create_lock

E,T,U

Lists the page types on which create, add, and move portlet cannot be done:

E – default

T – catalog

U – guest page

proxy

off

(on/off) Set this value to “on” only if you are planning to use a HTTP proxy server, and this proxy server is installed and configured.

proxy.bypass_list

127.0.0.1 | localhost

Value – host1|host2

The addresses and host names of Enterprise Portal machines that must bypass the proxy server. When there are machines that cannot go through the proxy server (typically for internal sites), create the list of machines names; separate machine names using a bar (|).

See the HTTPConnection Javadocs for information on dontProxyFor() method.

proxy.host

127.0.0.1

IP address of the proxy server. Enter this value only if the proxy property is set to “on.”

proxy.password

DefaultProxyUserPassword

Configure this property only if the proxy property is set to “on” and the user exists on the proxy server

proxy.port

3128

Port number of the proxy server cache. Configure this property only if the proxy property is set to “on” and the user exists on the proxy server.

proxy.user

DefaultProxyUserName

Configure this property only if the proxy property is set to “on” and the user exists on the proxy server

redirfile

/config/redirlist.txt

The location and content to which a user is redirected if he or she enters a URL that does not exist or is unavailable.

registration.organization

o=Sybase Inc,c=us"

Defines the EP security organization where self-registered users are added. The default organization is the root organization

registration.userJ2EERoles

“ “

Lists the J2EE role values. Values are comma-separated.

RequiredRoles

everybody

Lists required J2EE role values in conjunction with roles specified in web.xml. Values are comma-separated.

resetPasswordEmail

pso@yourCompany.com

A semicolon-delimited list of e-mail addresses to which reset password notifications are to be sent.

RoleBaseDisplay

true

(true/false) Indicates whether listings should show objects with only the same role as the user.

RoleBaseDisplaySeeAllRoles

superuser

Supersedes the RoleBaseDisplay property. Any roles listed here see every item as if RoleBaseDisplay was set to “false”. Values are comma-separated.

secure

off

(off/on) Set to “on” to enable HTTPS for the Web container. HTTPS will be used for log in and registration.

SecureHostname

LoadBalanceSecure Serverhost.domain

Fully qualified host name for the load-balanced secure publish/subscribe server used by Web Studio and the portlet playback server (UWP or UPP).

secure_login

off

(off/on) Set to “off” to have Portal Interface login and self-registration occur over HTTP.

When this value is set to “on”, Portal Interface uses HTTPS during login and self-registration.

Before setting this value to “on”, you must configure EAServer for HTTPS. See the Enterprise Security Administration Guide for more information.

secure.tile.host

hostname

Hostname of the secure HTTPS portlet playback server. The initial value is supplied at installation. This value should be the same as tile.host.

send.mail

true

(true/false) Set this value to “true” if you want SMTP-based e-mail sent when you create a new accounts in Web Studio, or when Portal Interface users register for the first time or request to change their password.

If set to “false,” e-mail content is written to the workroot/e-mail directory.

You can leave this value set to “true,” then set the value to “false” for individual portals in the cobrands.xml file. See Chapter 14, “Creating Co-brands.”

server_virtual_path

Used for JSP forward/include; for example:

BEA=/

JRun=/

iplanet=/onepage/

(on/off) Enables page sharing in Portal Interface.

SOAPServer

127.0.0.1

The SOAP server machine name.

tabingChar

The number of characters that tabs use for the corners.

tabset

(off/on) Enables tabsets.

tile.host

Tile is synonymous with portlet.

hostname

Host name of the portlet playback server. The initial value is supplied at installation.

tile_style

Values – 1, 2, 3

<IFRAME> tag only. Defines an inline frame for the inclusion of external objects including other HTML documents. Unlike frames created using <FRAMESET> and <FRAME>, <IFRAME> creates a frame that sits in the middle of a regular nonframed Web page. <IFRAME> works like <IMG>, only instead of putting a picture on the page, it puts another Web page on the page.

Internet Explorer versions 5.x and 6.x support <IFRAME>. Netscape 6 supports <IFRAME> but not all of the attributes. Versions of Netscape earlier than version 6 do not support <IFRAME>.
<DIV> tag only. The <DIV> tag has a single attribute—align—with four possible values—left, center, right, and justify. The <DIV> tag is used primarily to create divisions that require the same alignment attribute within an HTML document.

Does not work on Netscape 7, which does not support Web data within <DIV> tags.
Mixed mode. The portlet is formatted using either an <IFRAME> or a <DIV> tag, depending on which tag is more appropriate to the portlet’s content.

turnOffSecurePassword

secure_passwd_off

(on/off) Toggles use of secure password prompt by Portal Interface when using http portlets created from Web Studio.

use_https

(on/off) Enables secure navigation.

versioning

(on/off) Enables versioning of portlets and catalogs.

WebServiceRoot

/ws

This property indicates the root directory for web services.

There are two ways to enter this information:

Enter an absolute location. For example, if you enter d:\work\service\ws on Windows or /work0-/service/ws on UNIX, the system adds files directly to the specified location. You must ensure that the location can be accessed from a URL, like http://localhost:8085/onepage/ws.
Enter a relative location. For example, if you enter service\ws on Windows or service/ws on UNIX, the system adds files to the location relative to the current Web application; specifically, root/work0/tomcat/webapps/onepage/service/ws (on UNIX). You must ensure that the location can be accessed from a URL, like http://localhost:8085/onepage/service/ws.

wireless_portal

off

(on/off) Set to “on” to enable wireless_portal, which uses the Windows player to play captured portlets.

WorkRoot

/tmp

Base working directory to which the portal can write log files, upload files, and so on.

xml_catalog_serialize

yes

(yes/no) Enter “yes” to create local serialized objects of the XML catalog in your local /onepage/lib directory. This allows a quicker-loading catalog.

Enter “no” to disable catalog serialization.