Part II Configuration Files

• Chapter 12, Desktop Configuration Properties File

• Chapter 13, Search Configuration Properties File

• Chapter 14, XML and Schema Files

• Chapter 15, Community Properties Files

Chapter 12 Desktop Configuration Properties File

This chapter contains the following sections:

• Overview

• Parameters

Overview

The desktopconfig.properties file defines server-specific parameters that the Desktop reads during initialization. The server has to be restarted for the file changes to take effect. By default, this file is in the /var/opt/SUNWportal/portals/portal_id/config directory.

Parameters

You cannot customize the parameters, which are marked as Internal. So, you can only configure the debug level and the base directory for additional classes. The parameters available in the desktopconfig.properties file and their description are:

defaultDesktopType=default

[Internal]

Default desktop type used by the ErrorProvider when DesktopAppContext is available but DesktopContext is not available.

getterPoolMinSize=0

[Internal]

getterPoolMaxSize=0

[Internal]

getterPoolPartitionSize=0

[Internal]

callerPoolMinSize=0

[Internal]

callerPoolMaxSize=0

[Internal]

callerPoolPartitionSize=0

[Internal]

cookiePrefix=desktop

[Internal]

Prefix used for all desktop cookies.

lb.cookie.name=

Value of this cookie is <portal_id>.<instance_id>. If Portal Server and Access Manager are running on separate nodes and both of them are available at load-balancer URLs, such cookie will not be set by the Portal Server. Portal Server works with some performance hit in terms of resource consumption and response times. The recommended value, if used, is <cookiePrefixPropertyValue>.lb.cookie.

templateScanInterval=30

Defines the number of seconds between scans (checking for changes) of the template files in the /var/opt/SUNWportal/portals/<protalid>/config directory. This interval can improve the performance and scalability because the server uses the cached information between scans. The default value is 30 seconds.

dpScanInterval=0

DP scan interval controls how often DP updates done by someone other than the user. For example, Administrator is selected before serving portal request. If a DP document (user or shared) is present in the cache, and DP scan interval has not yet elapsed, then the cached copy will be used and the check for modified DP documents does not happen.

The values are:

• -1 — Scan happens only when the user logs in or the membership changes.

• 0 — Scan happens for every request.

• n — After n seconds from previous scan, any updates to user DP or shared DP will be reflected in system behavior.

community.contributor.types=jdo

This property tells the type of DP documents should be present as community request parameter to Desktop when membership is determined for DP merge. Contributor types can be separated by | as in communitymc.properties.

classLoaderRevalidateInterval=3600

Provider class loader re-validate time interval in seconds, for authless anonymous session only.

maxEventGenerations=5

Maximum number of event generations.

portletRenderModeParallel=true

This is the Application Server execution mode. To turn off the parallel execution of the portlets in Application Server, set this parameter to off.

jspScratchDir=/var/opt/SUNWportal/portals/<portal_id>/desktop/compiled

JSP Scratch directory is used for placing compiled JSPs.

jspCompilerWARClassPath=<Used only on application server>

[Internal]

Used only on application server. For more information on jspCompileWARClassPath, see the desktopconfig.propertiesfile in the /var/opt/SUNWportal/portals/<portal_id>/config directory.

templateBaseDir=/var/opt/SUNWportal/portals/<portal_id>/desktop/

Root directory under which all template files are located.

communityTemplateBaseDir=/var/opt/SUNWportal/portals/<portal_id>communitytemplates

This is the community template base directory.

providerClassBaseDir=/var/opt/SUNWportal/portals/<portal_id>/desktop/classes

Root directory under which the customer is allowed to place provider classes, whether those are overriding the bundled providers, or their own new providers (usually the case). They must be placed in this directory, either in a jar at the top level, or in a com (or whatever) package directory.

serviceAppContextClassName=com.sun.portal.desktop.context.DSAMEServiceAppContext

[Internal]

Chapter 13 Search Configuration Properties File

This chapter contains the following sections:

• Overview

• Parameters

Overview

In the default installation, the search.conf file is in the /var/opt/SUNWportal/searchservers/<searchserver_id>/config directory. The search.conf file lists all the specific search values you have set. The /var/opt/SUNWportal/samples/config directory contains a sample search.conf file.

The default install assigns $CSROOT to /var/opt/SUNWportal/searchservers/search1, $CSBIN to /var/opt/SUNWportal/bin, and $CSLIB to /var/opt/SUNWportal/lib.

Parameters

The parameters available in the search.conf file and their description are:

search.conf File Parameters

csid=x-catalog://$ HOST:$PORT/$N ICK

Defined at installation. Server identifier string, mainly for backward compatibility with Search Server.

bindir=$CSBIN

Defined at installation. Location of binaries.

database-directory=$CSROOT/db

Defined at installation. Location of database (used by server).

database-root=$CSROOT/db

Defined at installation. Location of database (used by indexer).

database-max-concurrent=8

Limits the number of server threads that can access the database at any time. You can change this value for performance reasons, but it should be set to about 1.25 times the number of index threads for best performance.

database-name=default

The logical database name. You can change this value to another database including an external one.

database-logdir=db

Directory where database transaction logs are kept.

security-mode=OFF

Enables or disables document level security. Can be reset in the administration console under Server Settings.

security-manager=com.sun.porta l.search.rdmserver.DSameSecurityManager

Security manager class name. Do not edit.

security-dsame-group=OFF

Whether to use group in addition to user role for security control.

debug-logfile=$CSROOT/logs/rdmserver.log

Logs internal server activity. Defined at installation. Can be reset in the administration console under Server Advanced Settings.

debug-loglevel=1

Sets the default log level. Can be reset in the administration console under Server Advanced Settings.

filters-check-dns=on

Checks for number of servers aliased to the same address. Can be reset in the administration console under Robot Simulator.

filters-check-redirect=on

Checks for any server redirects. Can be reset in the administration console under Robot Simulator.

import-config=$CSROOT/config/import.conf

Defined at installation. Contents generated by the Search server when you define an import agent in the administration console under Database Import.

libdir=$CSLIB

Defined at installation.

logfile=$CSROOT/logs/rdm.log

Log of RDM server requests. Defined at installation. Can be reset in the administration console under Server Advanced Settings.

disable-rdm-log=false

Disables RDM request logging. Can be reset in the administration console under Server Advanced Settings.

classification-stats-durin g-browse=true

If true, server records how many documents are found in each browse category.

browse-root-classification=false

Whether to browse for documents at the root of the category tree.

search-logfile=$CSROOT/logs/ searchengine.log

Search engine log file. Defined at installation. Can be reset in the administration console under Server Advanced Settings.

search-max-index-batch=2000

Maximum number of documents in each index batch.

search-query-threads=6

Number of search query threads. Should be set to 3-6 threads per CPU that you wish to utilize.

search-index-threads=1

Number of search index threads. Usually left at 1.

search-index-type=AWord

The format of the search engine index. Do not edit.

search-index-partition-size=32

The blocking factor used during index merges. Do not edit.

search-dictionary-type=partial

Format of the search dictionary. Do not edit.

search-lookup-limit=-1

Controls the timeout (milliseconds) of slow wildcard searches.

-1 means unlimited.

search-highlights=true

Enable search result highlighting.

search-max-passages=3

Maximum number of dynamic summary passages to generate.

search-passage-context=6

Size of context (in words) around each highlight passage.

#search-field-multipliers="title 1.0"

Search weights assigned to different document fields. Can be a comma separated list.

rdmgr-logfile=$CSROOT/logs/ rdmgr.log

Log file for the indexer process. Defined at installation. Can be reset in the administration console under Server Advanced Settings.

schema-description=$CSROOT/config/schema.rdm

The default Search Engine Schema. Defined at installation.

server-description=$CSROOT/config/server.rdm

The RDM server description returned by server description requests. Defined at installation.

server-root=$CSROOT

Server instance root directory. Defined at installation. Can be reset in the administration console under Server Settings.

taxonomy-database-name=taxonomy

The logical name of the taxonomy index database.

taxonomy-description-refre sh-rate=3600 -> 60

Polling interval for automatic taxonomy reloads.

taxonomy-description=$CSROOT/config/taxonomy.rdm

The RDM Taxonomy definition. Edit using the Category Editor under Categories. Defined at installation.

tmpdir=$CSROOT/tmp

Defined at installation. Can be reset in the administration console under Robot Crawling.

robot-refresh=30000

Number of milliseconds between refreshes of the Robot Control page of the administration console.

admin-category_editor_node s_per_page=25,50,100,250 ,500,-1

List of available choices, defining the maximum number of categories displayed per page.

-1 = display all tree.

admin-category_editor_max_ combo_element=10

Maximum number of elements in the category editor drop down select list of target categories.

The following parameters are not used:

filters-check-virtual

Filters Check Virtual.

multiple-classifications

Multiple Classifications.

reports-exclude-gv-queries

Reports exclude gv queries.

reports-exclude-browse

reports exclude browse.

rdmgr-pidfile

rdmgr pidfile.

rlog-max-logs

rlog max logs.

Chapter 14 XML and Schema Files

The Sun Java System Portal Server registers its services into the Sun Java System Access Manager Service Management Services (SMS) framework. This occurs during the pre-installation of the Portal Server and post-installation for Sun Java System Access Manager software.

Service Management Services

---

Note –

In general, any service-related data that is not server-specific is stored in the Sun Java System Access Manager directory. Server-specific data can be stored in properties files that are local to the specific server.

---

SMS provides a mechanism for services to define and manage their configuration data by using an Extensible Markup Language (XML) file that adheres to the SMS Document Type Definition (DTD). The definition of the configuration parameters through the XML file is called the schema for the service. Each Portal Server service (Desktop, Rewriter, and Search) has its own XML and properties files for presenting and modifying service specific data.

Within the Sun Java System Access Manager framework, Portal Server defines services related to the following functional areas:

Desktop

The SunPortalDesktopService includes data associated with the Desktop component, including the display profile and other configuration parameters associated with the Desktop.

Search Engine

The SunPortalSearchService defines the data associated with the Search component, such as the search person and search instances. One or more instances of Search service instances can be defined.

Rewriter

The SunPortalRewriterService includes data associated with the Rewriter component, including the named rule sets that control the rewriting operation. The Rewriter API makes reference to the named rule sets that are stored in the directory.

In addition, the Portal Server also uses other DTDs to define LDAP attribute values for the display profile and the Rewriter ruleset.

The Display Profile Document Type Definition (DTD) defines how the Display Profile is structured. The underlying data format for a display profile document is XML. It is intended to define the display configuration for the Desktop. It does that by defining provider, portlet, and channel objects, and their properties. The Rewriter ruleset DTD defines the structure of the ruleset. The Rewriter includes a default ruleset.

The file paths for the various XML, DTD, and schema files used to define the services of the Portal Server (in the first column) and the service which uses the corresponding file (in the second column) are:

/opt/SUNWam/dtd/sms.dtd

Service Management Services Document Type Definition (DTD)

/opt/SUNWportal/export/service/psDesktop.xml

Portal Server Desktop service definition

/opt/SUNWportal/export/service/psRewriter.xml

Portal Server Rewriter service definition

/opt/SUNWportal/export/service/psSearch.xml

Portal Server Search service definition

/var/opt/SUNWportal/dtd/psdp.dtd

Display Profile document type definition (DTD)

/opt/SUNWportal/web-src/WEB-INF/lib/rewriter.jar

Rewriter Ruleset document type definition (DTD) under resources/RuleSet.dtd

/opt/SUNWportal/web-src/WEB-INF/lib/rewriter.jar

Default ruleset under resources/DefaultRuleSet.xml

/opt/SUNWportal/export/ldif

ldif file available in desktop directory.

/opt/SUNWportal/export/ldif/psDesktop.ldif

Portal Server Desktop Schema

/opt/SUNWportal/export/ldif/psSearch.ldif

Portal Server Search Schema

Chapter 15 Community Properties Files

This chapter contains the following:

• communitymc.properties File

• communitymgmnt.properties File

communitymc.properties File

This file configures the community membership and configuration component of the Portal Server software. For the most part, this file contains low level configuration that need not be modified. For performance reasons, if the community feature is not used, this file must be changed to avoid calls to Java DB on each portal request.

To modify the file, log into any system that has portal server installed as superuser and access the file in the PortalServer-DataDir/portals/portal-ID/config/ directory.

The file contains the following variables:

manager.contributors

Specifies the active membership and configuration contributor types in the system. By default, this list includes:

am-global

Access Manager service schema

am-org

Access Manager organizations

am-role

Access Manager roles

am-frole

Access Manager filtered roles

jdo

Java DB, through Java Data Objects (JDO) layer

Each of these contributor types provides membership and configuration data from a different source.

communitymgmnt.properties File

This file contains configuration for the community management SDK component. The configuration variables defined in the communitymc.properties file, in most cases, need not be modified. To modify the file, log into any system that has portal server installed as superuser and access the file in the PortalServer-DataDir/portals/portal-ID/config/ directory.

The file contains the following (modifiable) variables:

ps-search-url

Specifies the URL of the search server to use when creating communities.

ps-dp-priority-base

Specifies the base value used to set display profile priorities for created communities.

ps-community-notification-notifier-classes

Specifies the implementation classes to use to send notification. The following implementation is available: com.sun.portal.community.notification.impl.JavaMailNotifierImpl.

ps-community-notification-types

Specifies types of events for which notification is to be triggered. The following event is available: user_invited. Leave the value empty if you do not wish to use the notification feature.

mail.transport.protocol

Specifies the mail protocol (smtp) to use. See JavaMail^TM specification for more information.

mail.imap.host

Specifies the hostname of the mail server. See JavaMail specification for more information.

mail.debug

Specifies the debug mode for JavaMail. See JavaMail specification for more information.

ps-community-notification-javamail-default-sender-addr

Specifies the default sender address if there is none available for the user sending the notification.

ps-community-notification-javamail-authenticator-class

Provides simple authentication implementation to be used with JavaMail. The following implementation is available: com.sun.portal.community.notification.impl.SimpleAuthenticator. See JavaMail specification for more information.

ps-community-notification-javamail-simpleauthenticator-user

Specifies the user name to be used with the SimpleAuthenticator implementation.

ps-community-notification-javamail-simpleauthenticator-password

Specifies the password to be used with the SimpleAuthenticator implementation.