|
| |
| Sun Java System Portal Server 6 2004Q2 Administration Guide | |
Appendix A
Configuration FilesThis appendix describes the desktopconfig.properties and search.conf configuration files.
This appendix contains these sections:
Overview of Sun Java System Portal Server Configuration Files
Sun Java™ System Portal Server uses certain files to manage the configuration of the Desktop and Search services. The Desktop configuration file, desktopconfig.properties, defines server-specific parameters, and is discussed in this appendix.
There is the Portal Server as a service of Sun Java™ System Identity Server (see Appendix B).
The Search service uses specific configuration files. This appendix covers configuration considerations for the search.conf file.
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 (cate.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/ Default Value
Description
debugLevel=error
Level of debugging messages to be produced by Desktop. Debug output is stored in /var/opt/SUNWam/debug/desktop.debug. Use caution when increasing the value of logLevel for excessive logging causes intensive IO operations leading to performance degradation.
Possible values are: (in the ascending order of less to more logging) off, error, warning, message, or on
Default value: error
perfLevel=off
[Internal]
Level of performance metrics to be logged by Desktop. Output is stored in /var/opt/SUNWam/debug/desktop.perf. Under production environment, this parameter should always be off.
Possible values are: off or message
Default value: off
serviceAppContextClassName=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 com (or whatever) package directory.
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.
Code Example A-2 search.conf File
#
# search.conf - Search configuration
#
csid=x-catalog://cate.sesta.com:80/cate.sesta.com
bindir=/opt/SUNWps/bin
database-directory=/var/opt/SUNWps/https-cate.sesta.com/portal/db
database-root=/var/opt/SUNWps/https-cate.sesta.com/portal/db
database-max-concurrent=8
database-name=default
database-logdir=db
security-mode=OFF
security-manager=com.sun.portal.search.rdmserver.DSameSecurityManager
debug-logfile=/var/opt/SUNWps/https-cate.sesta.com/portal/logs/rdmserver.log
debug-loglevel=1
filters-check-dns=on
filters-check-redirect=on
filters-check-virtual=on
import-config=/var/opt/SUNWps/https-cate.sesta.com/portal/config/import.conf
libdir=/opt/SUNWps/lib
logfile=/var/opt/SUNWps/https-cate.sesta.com/portal/logs/rdm.log
disable-rdm-log=false
multiple-classifications=3
classification-stats-during-browse=true
browse-root-classification=false
search-logfile=/var/opt/SUNWps/https-cate.sesta.com/portal/logs/searchengine.log
search-max-index-batch=2000
search-query-threads=6
search-index-threads=1
search-index-type=AWord
search-index-partition-size=32
search-dictionary-type=partial
search-lookup-limit=-1
search-highlights=true
search-max-passages=3
search-passage-context=6
#search-field-multipliers=”title 1.0”
reports-exclude-gv-queries=false
reports-exclude-browse=false
rdmgr-logfile=/var/opt/SUNWps/https-cate.sesta.com/portal/logs/rdmgr.log
# comment rdmgr-pidfile to prevent rdmgr daemonization
# rdmgr-pidfile=/var/opt/SUNWps/https-cate.sesta.com/portal/logs/rdmgr.pid
schema-description=/var/opt/SUNWps/https-cate.sesta.com/portal/config/schema.rdm
server-description=/var/opt/SUNWps/https-cate.sesta.com/portal/config/server.rdm
server-root=/var/opt/SUNWps/https-cate.sesta.com/portal
taxonomy-database-name=taxonomy
taxonomy-description-refresh-rate=60
taxonomy-description=/var/opt/SUNWps/https-cate.sesta.com/portal/config/taxonomy.rdm
tmpdir=/var/opt/SUNWps/https-cate.sesta.com/portal/tmp
rlog-max-logs=10
robot-refresh=30000
admin-category_editor_nodes_per_page=25,50,100,250,500,-1
admin-category_editor_max_combo_element=10
The default install assigns $CSROOT to /var/opt/SUNWps/http-instancename/portal, $CSBIN to /opt/SUNWps/bin, and $CSLIB to /opt/SUNWps/lib. Most of these parameters can be changed in the Sun Java System Application Server Enterprise Edition administration 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:$PORT/$N ICK
Defined at installation. Server identifier string, mainly for backward compatibility with Compass 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 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
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.rdms erver.DSameSe curityManager
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 logfile. 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-siz e
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.
Note
The following parameters are not used, so 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.