Sun ONE Portal Server 6.0 Administrator's Guide: Appendix A Configuration Files

Sun ONE Portal Server 6.0 Administrator's Guide

Appendix A      Configuration Files

This appendix describes the desktopconfig.properties and search.conf configuration files.

This appendix contains these sections:

Overview of Sun™ ONE Portal Server Configuration Files

Desktop Configuration Properties

Search Configuration Properties

Overview of Sun™ ONE Portal Server Configuration Files

The majority of the configuration data for Sun ONE Portal Server is defined in Extensible Markup Language (XML) service definition files stored in the iPlanet™ Directory Server Access Management Edition directory and managed using the iPlanet Directory Server Access Management Edition admin console. For more information on the XML service definition files, refer to Appendix B "XML Reference. Generally, any service-related data that is not server-specific is stored in the iPlanet Directory Server Access Management Edition directory. Only server-specific data can be stored in properties files that are local to the specific server. Sun ONE Portal Server uses several properties or configuration files to manage the configuration of the Desktop and Search services.

For the Desktop service, the desktopconfig.properties configuration file, defines server-specific parameters.

For the Search service, the Sun ONE Portal Server uses seven configuration files.

This appendix only covers configuration data contained in the search.conf file. Additional Search service configuration files, such as those for configuring the robot (classification.conf, filter.conf, filterrules.conf, and robot.conf), are discussed in Chapter 9 "Administering the Search Engine Robot". In addition, the Search service uses two other configuration files: convert.conf and import.conf. These files are generated by the Search server and in general should not be manually edited.

At installation time, you are given the option of defining values or using the default values for the base directory (/opt), the deployment URI (/portal) and the deploy instance (myserver.sesta.com).

Desktop Configuration Properties

The desktopconfig.properties file defines server-specific parameters that the Desktop reads during initialization. Any changes to this file require a server restart in order to go into effect. By default, this file is in the /etc/opt/SUNWps/desktop directory.

Parameters marked as Internal are not customizable. So you can only configure the debug level and the base directory for additional classes. Table A-1 is a two column table; the first column lists the parameter with its default value and the second column gives a description of its function and possible values.

Table A-1    desktopconfig.properties Parameters

Parameter

Description

debugLevel=error

Level of debugging messages to be produced by Desktop. Debug output is stored in the /var/opt/SUNWam/debug/desktop.debug file. Use caution when increasing the value of debugLevel for excessive logging causes intensive IO operations leading to performance degradation.

Values: (in the ascending order of less to more logging)

off: No logging

error: Log errors only

warning: Log errors and warning

message: Log everything

Default value: error

perfLevel=off

[Internal]

Level of performance metrics to be logged by Desktop. Output is stored in the /var/opt/SUNWam/debug/desktop.perf file.Under production environment, this parameter should always be off.

Values:

off: No performance metrics logged

message: Log all performance metrics

Default value: off

serviceAppContextClass
Name=com.sun.portal.
desktop.context.
DSAMEServiceAppContext

[Internal]

Default value: com.sun.portal.desktop.context.DSAMEServiceAppContext

templateBaseDir=
/etc/opt/SUNWps/desktop/

[Internal]

Root directory under which all template files are located.

Default value: /etc/opt/SUNWps/desktop/

providerClassBaseDir=
/etc/opt/SUNWps
/desktop/classes

Root directory under which the customer is allowed to place provider classes, whether those are overriding the out-of-the-box 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 package directory such as com.

Default value: /etc/opt/SUNWps/desktop/classes

jjspCompilerWARClassPath=<Used only on
application server>
jjspCompilerWARClassPath=
/export/home/ias60sp3/ias/APPS/modules
/ps/WEB-INF/lib

[Internal]

Used only on application server.

Default value:

defaultDesktopType=default

[Internal]

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

Default value: default

getterPoolMinSize=0

[Internal]

Default value: 0

getterPoolMaxSize=0

[Internal]

Default value: 0

getterPoolPartitionSize=0

[Internal]

Default value: 0

callerPoolMinSize=0

[Internal]

Default value: 0

callerPoolMaxSize=0

[Internal]

Default value: 0

callerPoolPartitionSize=0

[Internal]

Default value: 0

cookiePrefix=desktop.

[Internal]

Prefix used for all desktop cookies.

Default value: desktop.

templateScanInterval

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

Search Configuration Properties

In the default installation, the search.conf file is in the /var/opt/SUNWps/https-instancename/portal/config directory. The search.conf file lists all the specific search values you have set. The /opt/SUNWps/samples/config directory contains a sample search.conf file.

The default install assign the $CSROOT variable to /var/opt/SUNWps/http-instancename/portal, the $CSBIN variable to /opt/SUNWps/bin, and the $CSLIB variable to /opt/SUNWps/lib. Most of these parameters can be changed in the iPlanet Application Server Enterprise Edition admin console under Search Server Settings or Search Server Advanced Settings.

Table A-2 is a three column table. Column one gives the possible parameters you can change, column two lists the default value of the parameter, and column three provides a brief description.

Table A-2    search.conf Parameters

Parameter

Default

Description

csid
x-catalog:/ /$HOST:$POR T/$NICK

Specifies the server identifier string, mainly for backward compatibility with Compass Server. Defined at installation.

bindir
$CSBIN

Specifies the location of binaries. Defined at installation.

database-directory
$CSROOT/db

Specifies the location of database (used by server). Defined at installation.

database-root
$CSROOT/db

Specifies the location of database (used by indexer). Defined at installation.

database-max-concurren t
8

Limits the number of server threads that can access the database at any one 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

Specifies the logical database name. You can change this value to another database, including an external one.

database-logdir
db

Specifies the directory where database transaction logs are stored.

security-mode
OFF

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

security-manager
com.sun.por tal.search. rdmserver.D SameSecurit yManager

Specifies the security manager class name. Do not edit.

security-dsame-group
OFF

Specifies 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 admin console under Server Advanced Settings.

debug-loglevel
1

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

filters-check-dns
on

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

filters-check-redirect
on

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

import-config

$CSROOT/config/import.conf

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

libdir
$CSLIB

Defined at installation.

logfile

$CSROOT/logs/rdm.log

Specifies the log for RDM server requests. Defined at installation. Can be reset in the admin console under Server Advanced Settings.

disable-rdm-log
false

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

classification-stats-d uring-browse
true

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

browse-root-classifica tion
false

Specifies whether to browse for documents at the root of the category tree.

search-logfile
$CSROOT/log s/searcheng ine.log

Specifies the search engine log file. Defined at installation. Can be reset in the admin console under Server Advanced Settings.

search-max-index-batch
2000

Specifies the maximum number of documents in each index batch.

search-query-threads
6

Specifies the number of search query threads. Should be set to 3-6 threads per cpu that you wish to utilize.

search-index-threads
1

Specifies the number of search index threads. Usually left at 1.

search-index-type
AWord

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

search-index-partition -size
32

Specifies the blocking factor used during index merges. Do not edit.

search-dictionary-type
partial

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

Enables search result highlighting.

search-max-passages
3

Specifies the maximum number of dynamic summary passages to generate.

search-passage-context
6

Specifies the size of context (in words) around each highlight passage.

#search-field-multipli ers
"title 1.0"

Specifies the search weights assigned to different document fields. Can be a comma separated list.

rdmgr-logfile
$CSROOT/log s/rdmgr.log

Specifies the log file for the indexer process. Defined at installation. Can be reset in the admin console under Server Advanced Settings.

schema-description

$CSROOT/config/schema.rdm

Specifies the default Search Engine Schema. Defined at installation.

server-description

$CSROOT/config/server.rdm

Specifies the RDM server description returned by server description requests. Defined at installation.

server-root
$CSROOT

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

taxonomy-database-name
taxonomy

Specifies the logical name of the taxonomy index database.

taxonomy-description-r efresh-rate
3600 -> 60

Specifies the polling interval for automatic taxonomy reloads.

taxonomy-description

$CSROOT/config/taxonomy.rdm

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

tmpdir
$CSROOT/tmp

Specifies the temporary directory. Defined at installation. Can be reset in the admin console under Robot Crawling.

robot-refresh
30000

Specifies the number of milliseconds between refreshes of the Robot Control page of the admin console.

admin-category_editor_ nodes_per_page
25,50,100,2 50,500,-1

Specifies the list of available choices for defining the maximum number of categories displayed per page. -1 = display all tree.

admin-category_editor_ max_combo_element
10

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

Note Because the following parameters are not used, they are not included in Table A-2: filters-check-virtual, multiple-classifications, reports-exclude-gv-queries, reports-exclude-browse, rdmgr-pidfile, and rlog-max-logs.

Parameter	Description
debugLevel=error	Level of debugging messages to be produced by Desktop. Debug output is stored in the /var/opt/SUNWam/debug/desktop.debug file. Use caution when increasing the value of debugLevel for excessive logging causes intensive IO operations leading to performance degradation. Values: (in the ascending order of less to more logging) off: No logging error: Log errors only warning: Log errors and warning message: Log everything Default value: error
perfLevel=off	[Internal] Level of performance metrics to be logged by Desktop. Output is stored in the /var/opt/SUNWam/debug/desktop.perf file.Under production environment, this parameter should always be off. Values: off: No performance metrics logged message: Log all performance metrics Default value: off
serviceAppContextClass Name=com.sun.portal. desktop.context. DSAMEServiceAppContext	[Internal] Default value: com.sun.portal.desktop.context.DSAMEServiceAppContext
templateBaseDir= /etc/opt/SUNWps/desktop/	[Internal] Root directory under which all template files are located. Default value: /etc/opt/SUNWps/desktop/
providerClassBaseDir= /etc/opt/SUNWps /desktop/classes	Root directory under which the customer is allowed to place provider classes, whether those are overriding the out-of-the-box 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 package directory such as com. Default value: /etc/opt/SUNWps/desktop/classes
jjspCompilerWARClassPath=<Used only on application server> jjspCompilerWARClassPath= /export/home/ias60sp3/ias/APPS/modules /ps/WEB-INF/lib	[Internal] Used only on application server. Default value:
defaultDesktopType=default	[Internal] Default desktop type used by the ErrorProvider when DesktopAppContext is available but DesktopContext is not available. Default value: default
getterPoolMinSize=0	[Internal] Default value: 0
getterPoolMaxSize=0	[Internal] Default value: 0
getterPoolPartitionSize=0	[Internal] Default value: 0
callerPoolMinSize=0	[Internal] Default value: 0
callerPoolMaxSize=0	[Internal] Default value: 0
callerPoolPartitionSize=0	[Internal] Default value: 0
cookiePrefix=desktop.	[Internal] Prefix used for all desktop cookies. Default value: desktop.
templateScanInterval	Defines number of seconds between scans (checking for changes) of the template files in the /etc/opt/SUNWps directory. This interval can improve the performance and scalability because the server uses the cached information between scans. The default value is 30 seconds

Parameter	Default	Description
csid	x-catalog:/ /$HOST:$POR T/$NICK	Specifies the server identifier string, mainly for backward compatibility with Compass Server. Defined at installation.
bindir	$CSBIN	Specifies the location of binaries. Defined at installation.
database-directory	$CSROOT/db	Specifies the location of database (used by server). Defined at installation.
database-root	$CSROOT/db	Specifies the location of database (used by indexer). Defined at installation.
database-max-concurren t	8	Limits the number of server threads that can access the database at any one 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	Specifies the logical database name. You can change this value to another database, including an external one.
database-logdir	db	Specifies the directory where database transaction logs are stored.
security-mode	OFF	Enables or disables document level security. Can be reset in the admin console under Server Settings.
security-manager	com.sun.por tal.search. rdmserver.D SameSecurit yManager	Specifies the security manager class name. Do not edit.
security-dsame-group	OFF	Specifies 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 admin console under Server Advanced Settings.
debug-loglevel	1	Sets the default log level. Can be reset in the admin console under Server Advanced Settings.
filters-check-dns	on	Checks for number of servers aliased to the same address. Can be reset in the admin console under Robot Simulator.
filters-check-redirect	on	Checks for any server redirects. Can be reset in the admin console under Robot Simulator.
import-config	$CSROOT/config/import.conf	Specifies the contents generated by the Search server when you define an import agent in the admin console under Database Import. Defined at installation.
libdir	$CSLIB	Defined at installation.
logfile	$CSROOT/logs/rdm.log	Specifies the log for RDM server requests. Defined at installation. Can be reset in the admin console under Server Advanced Settings.
disable-rdm-log	false	Disables RDM request logging. Can be reset in the admin console under Server Advanced Settings.
classification-stats-d uring-browse	true	If true, server records how many documents are found in each browse category.
browse-root-classifica tion	false	Specifies whether to browse for documents at the root of the category tree.
search-logfile	$CSROOT/log s/searcheng ine.log	Specifies the search engine log file. Defined at installation. Can be reset in the admin console under Server Advanced Settings.
search-max-index-batch	2000	Specifies the maximum number of documents in each index batch.
search-query-threads	6	Specifies the number of search query threads. Should be set to 3-6 threads per cpu that you wish to utilize.
search-index-threads	1	Specifies the number of search index threads. Usually left at 1.
search-index-type	AWord	Specifies the format of the search engine index. Do not edit.
search-index-partition -size	32	Specifies the blocking factor used during index merges. Do not edit.
search-dictionary-type	partial	Specifies the 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	Enables search result highlighting.
search-max-passages	3	Specifies the maximum number of dynamic summary passages to generate.
search-passage-context	6	Specifies the size of context (in words) around each highlight passage.
#search-field-multipli ers	"title 1.0"	Specifies the search weights assigned to different document fields. Can be a comma separated list.
rdmgr-logfile	$CSROOT/log s/rdmgr.log	Specifies the log file for the indexer process. Defined at installation. Can be reset in the admin console under Server Advanced Settings.
schema-description	$CSROOT/config/schema.rdm	Specifies the default Search Engine Schema. Defined at installation.
server-description	$CSROOT/config/server.rdm	Specifies the RDM server description returned by server description requests. Defined at installation.
server-root	$CSROOT	Specifies the server instance root directory. Defined at installation. Can be reset in the admin console under Server Settings.
taxonomy-database-name	taxonomy	Specifies the logical name of the taxonomy index database.
taxonomy-description-r efresh-rate	3600 -> 60	Specifies the polling interval for automatic taxonomy reloads.
taxonomy-description	$CSROOT/config/taxonomy.rdm	Specifies the RDM Taxonomy definition. Edit using the Category Editor under Categories. Defined at installation.
tmpdir	$CSROOT/tmp	Specifies the temporary directory. Defined at installation. Can be reset in the admin console under Robot Crawling.
robot-refresh	30000	Specifies the number of milliseconds between refreshes of the Robot Control page of the admin console.
admin-category_editor_ nodes_per_page	25,50,100,2 50,500,-1	Specifies the list of available choices for defining the maximum number of categories displayed per page. -1 = display all tree.
admin-category_editor_ max_combo_element	10	Specifies the maximum number of elements in the category editor drop down select list of target categories.

Previous Contents Index Next
Copyright 2002-2003 Sun Microsystems, Inc. All rights reserved.