| Oracle® Fusion Middleware Administrator's Guide for Oracle WebCenter Interaction 10g Release 4 (10.3.3.0.0) Part Number E14107-04 |
|
|
View PDF |
| Oracle® Fusion Middleware Administrator's Guide for Oracle WebCenter Interaction 10g Release 4 (10.3.3.0.0) Part Number E14107-04 |
|
|
View PDF |
This appendix contains a detailed description of the Oracle WebCenter Configuration Manager and for Oracle WebCenter Interaction configuration files that you can edit to customize your installation.
It includes the following sections:
Oracle WebCenter Configuration Manager enables you to manage the configuration settings of Oracle WebCenter products through a user interface rather than having to edit .xml files.
This section includes the following sections:
This section describes the settings in the Activity Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Activity Service Database |
Vendor |
Database vendor |
|
Host |
Name of the computer that hosts the database |
|
|
User name |
Name of the database user |
|
|
Password |
Password for the database user; this value is not displayed |
|
|
Port |
Port number on which the database services requests |
|
|
Minimum pooled database connections |
Minimum number of pooled connections for the database |
|
|
Maximum pooled database connections |
Maximum number of pooled connections for the database |
|
|
SID (Oracle Only) |
SID for the database (applies only to Oracle databases) |
|
|
Database Name (MSSQL Only) |
Name of the database (applies only to Microsoft SQL Server databases) |
|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application listens for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application listens for HTTPS requests |
|
|
General |
Apply Tag Filtering |
Enables/disables tag filtering |
|
Email Template Location |
File location for the email notification template |
|
|
Portal URL |
Location of the Portal Server; this setting enables the portal to generate links |
|
|
Logging |
Server |
Application name that will uniquely identify log messages sent from this application Logging Utilities will use this string to determine the location from which log messages originate. The application name can be any string that meets the following restrictions: it must not be empty, it must not exceed 128 in length, and it may only contain non-white-space visible ASCII characters and the space character. Most Oracle WebCenter Interaction products follow the naming convention product_name.machine_name.user_name. |
|
Local only |
Limits broadcast of this application's logging messages to only the computer on which this application is installed |
|
|
WCI Directory |
Authentication provider |
Provider type (ALI Directory, generic LDAP, or Active Directory) |
|
Host |
Name of the computer that hosts the Directory Service |
|
|
Port |
Port number on which the Directory services requests |
|
|
Principal |
Distinguished name of the Directory administrator, for example |
|
|
Credential |
Password for the principal |
|
|
SSL enabled |
Enables/disables SSL |
|
|
WCI Notification Service |
URL |
Fully-qualified URL (protocol, domain name, and port) used to connect to the Notification Service |
|
Timeout (milliseconds) |
Number of milliseconds that clients wait before the notification request is terminated |
|
|
Host |
Name of the computer that hosts the Notification Service |
|
|
WCI Security Database |
Vendor |
Database vendor |
|
Host |
Name of the computer that hosts the database |
|
|
User name |
Name of the database user |
|
|
Password |
Password for the database user; this value is not displayed |
|
|
Port |
Port number on which the database services requests |
|
|
Minimum pooled database connections |
Minimum number of pooled connections for the database |
|
|
Maximum pooled database connections |
Maximum number of pooled connections for the database |
|
|
SID (Oracle Only) |
SID for the database (applies only to Oracle databases) |
|
|
Database Name (MSSQL Only) |
Name of the database (applies only to Microsoft SQL Server databases) |
|
|
WCI Security Identity Services |
Key service file path |
File path to the keystore file on the server |
|
Key service default alias |
Keystore alias |
|
|
Key service passphrase |
Keystore passphrase; this value is not displayed |
|
|
WCI Security Login Tokens |
Default token type |
Type of Login Token used by default by ALUI Security Only use ALUI if your Directory is pointed at ALI Directory. |
|
Token expiration time in minutes |
Token expiration time, in minutes |
|
|
Message authentication code seed value |
Seed value used to create MAC signatures used to authenticate Login Tokens This should match the MAC seed for any external systems expected to consume the tokens created by ALUI Security, or to create tokens to be consumed by ALUI Security. For portal tokens, this value should match the "login token root key" in the PTSERVERCONFIG table in the portal database. |
This section describes the settings in the Automation Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Crawler Settings |
Web Crawler file timeout (seconds) |
Web file crawler timeout |
|
SOAP file timeout (seconds) |
SOAP timeout for crawlers |
|
|
General |
Server name |
Name that should be used to identify this Automation Service; this is typically the name of the host computer |
|
Port |
Port number used by the Automation Service |
|
|
Logging |
Server |
Application name that will uniquely identify log messages sent from this application Logging Utilities will use this string to determine the location from which log messages originate. The application name can be any string that meets the following restrictions: it must not be empty, it must not exceed 128 in length, and it may only contain non-white-space visible ASCII characters and the space character. Most ALI products follow the naming convention product_name.machine_name.user_name. |
|
Local only |
Limits broadcast of this application's logging messages to only the computer on which this application is installed |
|
|
Portal Database |
Vendor |
Database vendor |
|
Host |
Name of the computer that hosts the database |
|
|
User name |
Name of the database user |
|
|
Password |
Password for the database user; this value is not displayed |
|
|
Port |
Port number on which the database services requests |
|
|
Minimum pooled database connections |
Minimum number of pooled connections for the database |
|
|
Maximum pooled database connections |
Maximum number of pooled connections for the database |
|
|
SID (Oracle Only) |
SID for the database (applies only to Oracle databases) |
|
|
Database Name (MSSQL Only) |
Name of the database (applies only to Microsoft SQL Server databases) |
This section describes the settings in the Content Upload Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application should listen for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application should listen for HTTPS requests |
|
|
Document Repository Service |
Host |
Name of the computer that hosts the Document Repository Service |
|
Port |
Port number on which the Document Repository services requests |
|
|
Override host name and port with this URL |
Overrides the above settings Ignored if blank. An example value is: |
This section describes the settings in the Document Repository section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application should listen for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application should listen for HTTPS requests |
This section describes the settings in the LDAP IDS Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application should listen for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application should listen for HTTPS requests |
This section describes the settings in the Portal Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Analytics Communication |
Enabled |
Select this option if you want the portal to pass information to Oracle WebCenter Analytics. |
|
Crawler Settings |
Web Crawler file timeout (seconds) |
Enter the number of seconds you want a Web crawler to try to get to a Web page before it times out. |
|
SOAP file timeout (seconds) |
Enter the number of seconds you want a remote crawler to try to get to a document before it times out. |
|
|
Gateway |
Gateway Enabled |
Select this option if you want to allow portal content to be gatewayed. |
|
Gateway temporary directory |
Enter the full path to the directory where temporary files will be stored. |
|
|
Gateway max upload (in bytes) |
Enter the maximum file size allowed for uploads. |
|
|
Gateway min upload (in bytes) |
Enter the minimum file size allowed for uploads. |
|
|
Gateway min streamable (in bytes) |
Enter the minimum size of streamable content. |
|
|
Gateway temporary file pool size |
Enter a value that is greater than the number of ASP/JAVA worker threads for the portal. |
|
|
Logging |
Server |
Application name that will uniquely identify log messages sent from this application Logging Utilities will use this string to determine the location from which log messages originate. The application name can be any string that meets the following restrictions: it must not be empty, it must not exceed 128 in length, and it may only contain non-white-space visible ASCII characters and the space character. Most ALI products follow the naming convention product_name.machine_name.user_name. |
|
Local only |
Limits broadcast of this application's logging messages to only the computer on which this application is installed |
|
|
Main Portal Settings |
Web home directory |
Enter the directory for the Portal's JAR files. |
|
Image Server base URL |
Enter the base URL for the Portal's Image Server. |
|
|
Image Server secure base URL |
Enter the base URL for the Portal Image Server running HTTPS. |
|
|
Image Server connection URL |
Enter the base URL that is used when the Portal Server connects to the Image Server to retrieve JSRegistry information. In many configurations this URL is the same as the Image Server Base URL. |
|
|
Image Server connection URL timeout (seconds) |
Enter the timeout for the Image Server Connection URL, in seconds. -1 means do not check during startup. Note that if this is invalid, your portal will not work. |
|
|
Administrative Portal base URL |
Enter the base URL to the Administrative Portal. It is required that absolute URL be used in Security Mode 3. |
|
|
Temporary file home directory |
Enter the temporary files directory to be used by the portal. This should not be Web accessible. |
|
|
Internal SSO LoginToken timeout (minutes) |
||
|
Portal Database |
Vendor |
Database vendor |
|
Host |
Name of the computer that hosts the database |
|
|
User name |
Name of the database user |
|
|
Password |
Password for the database user; this value is not displayed |
|
|
Port |
Port number on which the database services requests |
|
|
Minimum pooled database connections |
Minimum number of pooled connections for the database |
|
|
Maximum pooled database connections |
Maximum number of pooled connections for the database |
|
|
SID (Oracle Only) |
SID for the database (applies only to Oracle databases) |
|
|
Database Name (MSSQL Only) |
Name of the database (applies only to Microsoft SQL Server databases) |
|
|
Portal International Settings |
Locale |
Enter the default locale for users. Setting it to the string “UseBrowser” causes the portal to derive the locale from the browser's language settings and store it as the user's locale. |
|
Time Zone (numeric value) |
Enter the default time zone for the user. If it is -1 then the time zone of the computer on which Portal is deployed is used. |
|
|
Mandatory Object Language |
This setting allows the administrator to set the language for all new objects. If it is blank, the user creating the object can choose the language for the object. If it is not blank, the value will be used as the language for all new and edited objects. The value should be a locale string (for example, it should match the name of a folder under the msgs directory.) |
|
|
Portal System Properties |
Server name |
Enter the name of the portal server or virtual load-balanced server (for example, the main load balanced server name: portal.mycompany.com). |
|
Machine name |
Enter the computer name (for example, the physical name of the individual portal server computer behind the load-balancer: portalserver1243). |
|
|
Performance comments |
This setting specifies whether the performance comments in the HTML source are enabled. 0 means the comments and stacktraces are disabled. 1 means the comments and stacktraces are enabled. 2 means the comments are enabled but stacktraces are disabled. 3 means the comments are disabled but stacktraces are enabled. |
|
|
Debugging mode |
This setting specifies whether debugging features are enabled. This is disabled by default. You can enable this to debug portal startup issues, especially if you have made customizations to XML files. Make sure to set to disable debugging when you are done troubleshooting. 1 means debugging is enabled. 0 means debugging is disabled. |
|
|
Doctype specification |
1: none, 2: HTML 3.2, 3: HTML 4.0 Transitional, 4: HTML 4.0 Frameset, 5: HTML 4.0 Strict. Note that neither the portal nor any other Oracle WebCenter Interaction product has been verified to support either the transitional or strict document type specification. By default the portal does not include a specific doctype declaration in its HTML because doing so would limit the display of portlets in which the doctypes were invalid or inconsistent with the portals declared doctype. If you are confident that all your portlets adhere to a particular doctype you should set that document type here. |
|
|
Adaptive layout mode |
Enter a numeric value indicating whether page and/or portlet layout modes are enabled. Both are enabled by default. 0 means layout mode is disabled. 1 means page and portlet layout modes are enabled. 2 means page layout mode is only enabled. 3 means portlet layout mode is only enabled. |
|
|
Virtual directory path |
Enter the virtual directory path. It is typically /portal/. |
|
|
HTTP entry point |
Enter the portal main Servlet mapping name. This has to be the same has the mapping name for HTTPInterpreter in web.xml. It is typically server.pt. |
|
|
HTTP Port |
Enter the port number for the Portal running HTTP. |
|
|
HTTP Secure Port |
Enter the port number for the Portal running HTTPS. |
|
|
SSO virtual directory path |
Enter the SSO Virtual directory path. It is typically /portal/. |
|
|
SSO servlet name |
Enter the SSO Servlet mapping name. This has to be the same has the mapping name for SSOLoginPage in web.xml. It is typically SSOServlet. |
|
|
Database connection timeout |
Enter the amount of time in seconds before a database connection times out. The value has to be between 0 and 1500 (15 minutes). Default is 30 seconds. |
|
|
Read Access To Editors |
Enable this to allow users read access to object editors they have READ/SELECT access to. Otherwise, no user is allowed to view the object's editor without EDIT permissions on that object. |
|
|
Service Settings |
Enabled |
If enabled, searches are performed via the Tagging Engine; if disabled, searches are performed via the Search Service. |
|
Pathways Server Cache Timeout |
This setting controls how often Portal checks to see if the Tagging Engine has been migrated into Portal. This controls whether or not Tagging Engine integration is enabled. |
|
|
Ensemble Server Cache Timeout |
This setting controls how often Portal checks to see if the Pagelet Producer has been migrated into Portal. This controls whether or not Pagelet Producer integration is enabled. |
This section describes the settings in the RSS Reader section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application should listen for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application should listen for HTTPS requests |
|
|
Logging |
Server |
Application name that will uniquely identify log messages sent from this application Logging Utilities will use this string to determine the location from which log messages originate. The application name can be any string that meets the following restrictions: it must not be empty, it must not exceed 128 in length, and it may only contain non-white-space visible ASCII characters and the space character. Most ALI products follow the naming convention product_name.machine_name.user_name. |
|
Local only |
Limits broadcast of this application's logging messages to only the computer on which this application is installed |
|
|
Portlet Configuration |
Domain List for Login Tokens |
Comma separated list of domain/computer names used to determine which RSS feeds need the portal login token. Domain names need to be prefaced with a * (for example |
This section describes the settings in the Search Admin UI Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application should listen for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application should listen for HTTPS requests |
This section describes the settings in the Search Server section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Search Node |
Search Server Port |
TCP port which Search Server listens for incoming requests |
|
Cluster Home Directory |
Fully-qualified path to the shared cluster directory |
|
|
Document Token Cache Size (in tokens) |
Number of tokens in the document token cache |
|
|
Spell Token Cache Size (in tokens) |
Number of tokens in the spell token cache |
|
|
Mapping Token Cache Size (in tokens) |
Number of tokens in the mapping token cache |
|
|
Index Cache Size (in bytes) |
Size (in bytes) of the index cache |
|
|
Docset Cache Size (in bytes) |
Size (in bytes) of the docset cache |
This section describes the settings in the Search Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Application Settings |
Port |
Port number on which the Search Service listens for requests |
|
Thread Pool Size |
Number of threads to use for the communication and processing of requests between the Search Service and client applications |
|
|
Memory Report Interval (seconds) |
Reporting time interval for reports of JVM memory usage (seconds) If the interval is 0 or less, no memory reporting is reported. |
|
|
Logging |
Server |
Application name that will uniquely identify log messages sent from this application Logging Utilities will use this string to determine the location from which log messages originate. The application name can be any string that meets the following restrictions: it must not be empty, it must not exceed 128 in length, and it may only contain non-white-space visible ASCII characters and the space character. Most ALI products follow the naming convention product_name.machine_name.user_name. |
|
Local only |
Limits broadcast of this application's logging messages to only the computer on which this application is installed |
|
|
Search Server |
Search Host |
Name of the computer that hosts the Search Server |
|
Search Port |
Port number on which the Search Server services requests |
This section describes the settings in the Tagging Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Activity Service |
Host |
Name of the computer that hosts the Activity Service |
|
Port |
Port number on which the Activity Server services requests |
|
|
Timeout (milliseconds) |
Number of milliseconds that clients wait before the Activity Service request is terminated |
|
|
Administrative Credentials |
User name |
User name of an administrative user for Oracle WebCenter Interaction |
|
Password |
Password for the administrative user |
|
|
Analytics |
Enabled |
Enable Oracle WebCenter Analytics communication |
|
Enabled |
Enable clustering |
|
|
Collector hostname |
Name of the computer that hosts the Analytics collector |
|
|
Collector port |
Port number on which the Analytics collector services requests |
|
|
Logging level |
The level of detail for logged information |
|
|
Enable console logging |
Enable/disable console logging |
|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application should listen for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application should listen for HTTPS requests |
|
|
Content Sources |
Web Content Source ID |
Object ID of the Portal Web Content Source |
|
Enable Portal Upload |
Enable/disable uploading documents to the portal |
|
|
Portal Upload Content Source ID |
Object ID of the Portal Upload Content Source |
|
|
Portal Upload Service URL |
Server URL for the Portal Upload Service |
|
|
Logging |
Server |
Application name that will uniquely identify log messages sent from this application Logging Utilities will use this string to determine the location from which log messages originate. The application name can be any string that meets the following restrictions: it must not be empty, it must not exceed 128 in length, and it may only contain non-white-space visible ASCII characters and the space character. Most ALI products follow the naming convention product_name.machine_name.user_name. |
|
Local only |
Limits broadcast of this application's logging messages to only the computer on which this application is installed |
|
|
Portal Database |
Vendor |
Database vendor |
|
Host |
Name of the computer that hosts the database |
|
|
User name |
Name of the database user |
|
|
Password |
Password for the database user; this value is not displayed |
|
|
Port |
Port number on which the database services requests |
|
|
SID (Oracle Only) |
SID for the database (applies only to Oracle databases) |
|
|
Database Name (MSSQL Only) |
Name of the database (applies only to Microsoft SQL Server databases) |
|
|
Search Service |
URL |
Name of the computer that hosts the Search Service |
|
Timeout (milliseconds) |
number of milliseconds that the Rank Engine waits before the search request is terminated |
|
|
Tagging Service Database |
Vendor |
Database vendor |
|
Host |
Name of the computer that hosts the database |
|
|
User name |
Name of the database user |
|
|
Password |
Password for the database user; this value is not displayed |
|
|
Port |
Port number on which the database services requests |
|
|
Minimum pooled database connections |
Minimum number of pooled connections for the database |
|
|
Maximum pooled database connections |
Maximum number of pooled connections for the database |
|
|
SID (Oracle Only) |
SID for the database (applies only to Oracle databases) |
|
|
Database Name (MSSQL Only) |
Name of the database (applies only to Microsoft SQL Server databases) |
|
|
WCI Directory |
Authentication provider |
Provider type (ALI Directory, generic LDAP, or Active Directory) |
|
Host |
Name of the computer that hosts the Directory |
|
|
Port |
Port number on which the Directory services requests |
|
|
Principal |
Distinguished name of the directory administrator, for example |
|
|
Credential |
Password for the principal; the value is not displayed |
|
|
SSL enabled |
Enable/disable SSL |
|
|
WCI Notification Service |
URL |
Fully-qualified URL (protocol, domain name, and port) used to connect to the Notification Service |
|
Timeout (milliseconds) |
Number of milliseconds that clients wait before the notification request is terminated |
|
|
WCI Security Database |
Vendor |
Database vendor |
|
Host |
Name of the computer that hosts the database |
|
|
User name |
Name of the database user |
|
|
Password |
Password for the database user; this value is not displayed |
|
|
Port |
Port number on which the database services requests |
|
|
Minimum pooled database connections |
Minimum number of pooled connections for the database |
|
|
Maximum pooled database connections |
Maximum number of pooled connections for the database |
|
|
SID (Oracle Only) |
SID for the database (applies only to Oracle databases) |
|
|
Database Name (MSSQL Only) |
Name of the database (applies only to Microsoft SQL Server databases) |
|
|
WCI Security Identity Services |
Key service file path |
File path to the keystore file on the server |
|
Key service default alias |
Keystore alias |
|
|
Key service passphrase |
Keystore passphrase; this value is not displayed |
|
|
WCI Security Login Tokens |
Default token type |
Type of Login Token used by default by ALUI Security Only use ALUI if your Directory is pointed at ALI Directory. |
|
Token expiration time in minutes |
Token expiration time, in minutes |
|
|
Message authentication code seed value |
Seed value used to create MAC signatures used to authenticate Login Tokens This should match the MAC seed for any external systems expected to consume the tokens created by ALUI Security, or to create tokens to be consumed by ALUI Security. For portal tokens, this value should match the "login token root key" in the PTSERVERCONFIG table in the portal database. |
|
|
Web Authentication |
User name |
HTTP Basic Authentication user name Along with the password, this is used by the Tagging Engine to securely identify requests as originating from the portal. This does not need to be the user name of a portal user. These credentials must match the credentials defined in the Administrator's Basic Authentication Information section of the Tagging Engine Remote Server object's properties in the portal. |
|
Password |
Password for the HTTP Basic Authentication user |
This section describes the settings in the UCM Content Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application should listen for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application should listen for HTTPS requests |
This section describes the settings in the WCI API Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application should listen for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application should listen for HTTPS requests |
|
|
Crawler Settings |
Web Crawler file timeout (seconds) |
Web file crawler timeout |
|
SOAP file timeout (seconds) |
SOAP timeout for crawlers |
|
|
Logging |
Server |
Application name that will uniquely identify log messages sent from this application Logging Utilities will use this string to determine the location from which log messages originate. The application name can be any string that meets the following restrictions: it must not be empty, it must not exceed 128 in length, and it may only contain non-white-space visible ASCII characters and the space character. Most ALI products follow the naming convention product_name.machine_name.user_name. |
|
Local only |
Limits broadcast of this application's logging messages to only the computer on which this application is installed |
|
|
Portal Database |
Vendor |
Database vendor |
|
Host |
Name of the computer that hosts the database |
|
|
User name |
Name of the database user |
|
|
Password |
Password for the database user; this value is not displayed |
|
|
Port |
Port number on which the database services requests |
|
|
Minimum pooled database connections |
Minimum number of pooled connections for the database |
|
|
Maximum pooled database connections |
Maximum number of pooled connections for the database |
|
|
SID (Oracle Only) |
SID for the database (applies only to Oracle databases) |
|
|
Database Name (MSSQL Only) |
Name of the database (applies only to Microsoft SQL Server databases) |
|
|
WCI Service General |
Image Service Connection URL |
URL that the SOAP API Service uses to contact the Image Service |
|
Session Duration |
Length of time sessions are valid for (in minutes) when calling RemoteSessionFactory.getExplicitLoginContext(user,password) |
This section describes the settings in the WCI Directory section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
LDAP Listener Settings |
Host name |
Name of the computer that hosts the LDAP listener |
|
Port number |
Port number on which the LDAP listener services requests |
|
|
WCI Directory Database |
Vendor |
Database vendor |
|
Host |
Name of the computer that hosts the database |
|
|
User name |
Name of the database user |
|
|
Password |
Password for the database user; this value is not displayed |
|
|
Port |
Port number on which the database services requests |
|
|
Minimum pooled database connections |
Minimum number of pooled connections for the database |
|
|
Maximum pooled database connections |
Maximum number of pooled connections for the database |
|
|
SID (Oracle Only) |
SID for the database (applies only to Oracle databases) |
|
|
Database Name (MSSQL Only) |
Name of the database (applies only to Microsoft SQL Server databases) |
This section describes the settings in the WCI Notification Service section of the Configuration Manager.
| Page | Setting | Description |
|---|---|---|
|
Administrative Credentials |
User name |
Name of an administrative user for Oracle WebCenter Interaction |
|
Password |
Password for the administrative user (optional) |
|
|
Application Settings |
HTTP enabled |
Enables/disables HTTP as the application's web protocol |
|
HTTP port |
Port on which the application should listen for HTTP requests |
|
|
HTTPS enabled |
Enables/disables HTTPS as the application's web protocol |
|
|
HTTPS port |
Port on which the application should listen for HTTPS requests |
|
|
Email Notifications |
Character Encoding |
Scheme to use when encoding text in notifications |
|
SMTP Relay Host(s) |
Comma separated list of SMTP mail servers used to send email notifications (for example |
|
|
SMTP Port |
Port that will be used when connecting to the specified mail servers |
|
|
From Display Name |
Name that notifications will appear to be from |
|
|
From Email Address |
Email address that will be used to send email addresses as specified in the FROM field (for example |
|
|
Mail Server Connection Timeout (ms) |
Number of milliseconds, that the Notification Service will keep an inactive connection to the mail server before timing out |
|
|
SMTP Server Requires Authentication |
Specifies whether the SMTP relay server requires a valid user name and password in order to send email |
|
|
User Name |
User name to use when authenticating with the SMTP server |
|
|
Password |
Password to use when authenticating with the SMTP server; the value is not displayed |
|
|
External Database |
Should connect |
Specifies whether this optional database connection is enabled |
|
General Settings |
Host Name |
Fully-qualified name of the host of the Notification Service This value is used to construct URLs that are used when the service is not using the WCI binary gateway (for example: |
|
Host Port |
Port that the Notification Service web application is running on This value is used to construct URLs that are used when the service is not using the WCI binary gateway |
|
|
Data Location |
Location on the Notification Service server where all persisted data will be stored This value is used for the embedded database and the JMS message queue (for example |
|
|
WebCenter Interaction URL |
Base URL of Oracle WebCenter Interaction This URL used as the basis for constructing gateway links (for example |
|
|
Oracle WCI API Service URL |
URL of the SOAP API Service This URL is available on the Portal URL Manager page of the Portal Settings Utility in portal administration (for example |
|
|
Port |
Port that client applications use to bind to interfaces exposed by the Notification Service |
|
|
Enable Debug Logging to Console |
Forces the Notification Service to log all events, regardless of log level, directly to the console |
|
|
Identity Services |
Key service file path |
File path to the keystore file on the server |
|
Key service default alias |
Keystore alias |
|
|
Key service passphrase |
Keystore passphrase; this value is not displayed |
|
|
Internal Database |
Embedded Database Name |
Name of the embedded database Spaces are not allowed. |
|
Logging |
Server |
Application name that will uniquely identify log messages sent from this application Logging Utilities will use this string to determine the location from which log messages originate. The application name can be any string that meets the following restrictions: it must not be empty, it must not exceed 128 in length, and it may only contain non-white-space visible ASCII characters and the space character. Most ALI products follow the naming convention product_name.machine_name.user_name. |
|
Local only |
Limits broadcast of this application's logging messages to only the computer on which this application is installed |
|
|
Login Tokens |
Default token type |
Type of Login Token used by default by ALUI Security Only use ALUI if your Directory is pointed at ALI Directory. |
|
Token expiration time in minutes |
Token expiration time, in minutes |
|
|
Message authentication code seed value |
Seed value used to create MAC signatures used to authenticate Login Tokens This should match the MAC seed for any external systems expected to consume the tokens created by ALUI Security, or to create tokens to be consumed by ALUI Security. For portal tokens, this value should match the "login token root key" in the PTSERVERCONFIG table in the portal database. |
|
|
Message Processing Thread Pool |
Maximum Pool Size |
Specifies the most threads that will be used to handle processing inbound JMS messages that have been successfully received |
|
Maximum Pool Size |
Specifies the most threads that will be used to handle processing outbound notifications |
|
|
INotificationSession Queue Size |
Specifies the size of the JMS queue that handles remote method calls for INotificationSession |
|
|
INotificationManager Queue Size |
Specifies the size of the JMS queue that handles remote method calls for INotificationManager |
|
|
Notification Templates |
Base URL |
Base URL of the Image Service (for example |
|
Cache Templates |
Determines whether remote templates should be cached or retrieved with every request This option should always be checked unless running in a development environment. |
|
|
Cache Interval (seconds) |
Determines how often the file modification time is checked (in seconds) A value of 0 disables checking. |
|
|
RSS Feeds |
Enable Basic Authentication |
Require aggregators to send basic authentication encoded user credentials in order to access feeds |
|
Gateway RSS Feed URLs |
Encode the RSS Feed URLs to go through the portal gateway |
|
|
Feed Removal Age |
Age (in days) when old feed items are automatically removed |
|
|
Security Database |
Datastore enabled |
Indicates whether the StoredService is enabled |
|
Database Name |
Name of the database |
|
|
User and Group Directory |
Authentication provider |
Provider type (ALI Directory, generic LDAP, or Active Directory) |
|
Host |
Name of the computer that hosts the Directory |
|
|
Port |
Port number on which the Directory services requests |
|
|
Principal |
Distinguished name of the directory administrator, for example |
|
|
Credential |
Password for the principal; the value is not displayed |
|
|
SSL enabled |
Enable/disable SSL |
The Portal Settings Utility enables you to manage portal settings for user creation, login, portal URLs, and debug settings.
Note:
The Image Service location is not managed through the Portal Settings Utility. For information on managing the Image Service location, see Updating the Image Service Location.
To access the Portal Setting Utility you must be a member of the Administrators Group.
Click Administration.
From the Select Utility list, choose Portal Settings.
On the User Settings Manager page, perform tasks as necessary:
If you want to enable any user to create a new account for your portal, select Allow creation of Self Registered Users.
New users are given the Default Profile settings.
If you have users who access the portal through mobile devices, you might want to enable numeric login to make logging in easier. To enable numeric login, select Allow numeric Login for mobile devices.
If you want to automatically assign a numeric user name when a new user is created (through importation, manual creation, or self-registration), select Auto-assign numeric Login IDs for new Users.
Note:
When you are manually creating a user, the Mobile Device Authentication page does not display a numeric ID; the numeric ID is not assigned until you save the user. To view the automatically generated numeric ID, click the new user's name to open the User Editor and click the Mobile Device Authentication page.
Automatically lock user accounts after failed login attempts, as described in Automatically Locking User Accounts.
Manage password rules, as described in Configuring Password Management.
To update the login token key, click Update.
Login tokens are used by many internal processes for authentication. For security purposes, you should occasionally update the key used to generate login tokens.
The frequency at which you need to do this depends on portal usage and your company's required level of security. For a portal that gets moderate usage, you should only need to update the key twice a year.
Note:
When you update the key, outstanding tokens become invalid, but the portal issues new keys when the process is refreshed. For this reason, you should try to update the token during low-usage times.
In general, users should not notice when you update the key. However, users that have the portal remember their password need to reset this option the next time they login to the portal.
On the Portal URL Manager page, perform tasks as necessary:
Caution:
You should not change these URLs unless you move the associated portal server.
If the base URL of your portal changed, edit the value in the Primary Web Server URL box.
If the base URL to your gateway changed, edit the value in the Display Files URL box.This URL is used to construct document links. The links go through the gateway.
Note:
The portal Web server uses a URL that is generated from the settings in your portal configuration file.
If the URL to your SOAP listener changed, edit the value in the Soap Server URL box. This URL is passed to portlets that communicate through SOAP, so the portlets know where to post information.
If the file path to store the stored content portlet changed, edit the value in the Shared Files Path box.The htm files generated by the job that runs the portlet are deposited in this folder.
On the General Settings page, perform tasks as necessary:
To troubleshoot any conflicts arising from experience rules affecting the user, select Enable Experience Rules Debug Mode. It enables users to display experience rules debug messages on their My Pages. When you enable this mode, the debug option is available when the user clicks My Account, then Display Options, then Advanced Settings. This debug page is only visible if you enable experience rules debug mode.
To troubleshoot portlet errors, select Enable Portlet Errors Debug Mode. When you enable this debug mode, end users see additional error information if there is a problem with a portlet.
Click Finish.
You can configure rules for passwords. The create/manage password user interface displays the applicable password rules. Next to each rule is an icon showing whether the password has met the rule requirement. Password hints appear to the right of the password field to assist the user in typing in a valid password.
Note:
Password management applies only to user accounts created through the portal (not those managed through an authentication source).
Password strength checking is done only when users create or change their passwords. If a rule is changed, the rule will not affect existing passwords.
If the Portal Settings Utility is not already open, open it now.
In the Minimum Password Length box, type the minimum number of characters required for passwords. The default is 7.
If you want passwords to require at least one number, select Passwords Require a Number. This option is disabled by default.
If you want passwords to require at least one upper case letter and one lower case letter, select Passwords Require Upper and Lower Case. This option is disabled by default.
If you want passwords to require at least one punctuation character, select Passwords Require Punctuation. This option is disabled by default.
If you want to make sure that passwords do not include the user ID, select Passwords Cannot Include the User ID. This option is enabled by default.
In the Password Reuse History box, type the number of times a user must change passwords before an old password can be reused. If this option is set to 0 (the default setting) passwords can always be reused.
Note:
This value must be set to a number between 0 and 12.
In the Password Expiration box, type the number of days before a password expires. If this option is set to 0 (the default setting) passwords never expire.
If a user's password expires, the user is redirected to the Change Password page until the user changes the password (the user is locked out of the rest of the portal).
Note:
The passwords for intrinsic Administrator user, guest users, and default profile users do not expire.
In the Password Expiration Warning box, type the number of days before a password expires that you want to warn a user to change the password. If this option is set to 0 (the default setting) users receive no warning.
At the specified number of days before expiration, the user is redirected to the Change Password page.
If you change the location of your Image Service, you must update the location in the Imageserver Server remote server object:
Log in to the portal as an administrator.
Click Administration.
Open the Portal Resources folder.
Expand the Remote Server section.
Click Imageserver Server to open the object.
Update the Base URL location.
If your configuration requirements change after initial deployment, you can modify the portalconfig.xml configuration file located in the install_dir/settings/portal directory. Replace install_dir the Oracle WebCenter installation directory, for example, C:\Oracle\Middleware\wci or /oracle/middleware/wci for Windows or /oracle/middleware/wci for UNIX or Linux.
The URL mapping determines the portal base URL according to the requested URL from the request object. The portal base URL is the base URL for every single link and redirection. For example, if your portal base URL is: http://portal.company.com/portal/server.pt, then the link to the default My Page would be: http://portal.company.com/portal/server.pt?space=MyPage.
You can add as many entries as you want to the mapping. Mapping URLs should start with http:// or https:// and end with the HTTP entry point name (unless it's the default value, “*”).
Note:
If requests will come from both an http URL and an https URL you must create a separate mapping for each one. Then map each of these request URLs to an application URL and a secure application URL.
ApplicationURL0: In SecurityModes 2 and 3, ApplicationURL should be set to the same value as SecureApplicationURL. In mode 0, ApplicationURL0 might be equal to “*”. In this case, the Application Base URL will be the URL from the Request object.
SecureApplicationURL0: In SecurityMode 0, SecureApplicationURL is not used. In modes 2 and 3, SecureApplicationURL0 might be equal to “*”. In this case, the Application Base URL will be the URL from the request object.
The following configuration parameters apply to personal settings.
| Parameter | Description |
|---|---|
|
Greeting |
The default greeting for the user. If a user wishes to override this greeting, then they can do so by changing their personal settings. |
|
Accessibility |
The default portal interface type.
|
|
OverrideGuestAccessStyle |
Override the guest user access style (from the DB) with the Accessibility value above.
|
The following configuration parameters apply to cached settings.
Add entries for personal settings that should be cached on the http session of each user. Personal settings that are not included in this list will be retrieved from the portal every time they are requested. Settings that are on this list are obtained from the portal on login and are cached for the duration of the user's http session.
Note:
AccessStyle, Locale, and TimeZone should always be cached by the server.
Users can customize these settings by clicking My Account in the portal interface.
The following settings are cached by default:
| Parameter | Description |
|---|---|
|
Greeting |
Stores the personalized greeting that displays on the portal banner when the user logs into the portal. |
|
AccessStyle |
Stores the user display option. |
|
Locale |
Stores the preferred language of the portal interface. Portlet names and content display in the selected language only if the language is supported by the portlets. It also stores the format for portal entries (including search requests). For example, if the user chose British English, the portal displays and expects dates in the DD/MM/YYYY format (whereas in American English, the portal displays and expects dates in the MM/DD/YYYY format). |
|
TimeZone |
Stores the time zone of the user. |
|
PortletTimeout |
Stores the maximum time to wait for a portlet to load. |
|
CollapsedGadgets |
Stores which portlets were minimized by the user. |
|
COMCollapsedGadgets |
Stores which portlets in the community page were minimized by the user. |
|
MyPageRefreshRate |
Stores the refresh rate of user My Pages. |
The following configuration parameters apply to authentication.
| Parameter | Description |
|---|---|
|
AllowGuestAccess |
Allow the guest user to access the portal. If guest access is not allowed, the portal will always prompt for login information. |
|
GuestRedirectToLogin |
If the guest user does not specify a space in the URL query string, this setting determines the initial page the user sees. Users can navigate to different portal pages by including However, if the user did not include a
|
|
RedirectOnLogout |
After logging out the user is redirected to a default page as follows:
|
|
AuthTokenExpiration |
This setting enables you to set how long the portal remembers your login password after doing an HTTP Basic Authentication for WebDav. The value should be formatted in minutes and is defaulted to 30 minutes. Entering 0 will disable the cookie from being set. |
|
AllowDefaultLoginPageAuthSource |
Controls the use of the default authentication source for portals (that do not use single sign-on) on the login page and Login Portlet. It also lets you configure the authentication source list. |
|
DefaultAuthSourcePrefix |
Sets the default authentication source prefix that will be prepended to the login name when users log in to your system, unless they select another authentication source from the list on the login page. In the case of SSO, this is the authentication source category for all of your SSO users. You can use AuthSourcePrefix tags to order the items in the authentication source list. Entries in the list should look like the following: <AuthSourcePrefix[i] value="Auth Source Prefix"> </AuthSourcePrefix[i]> Where [i] is replaced with the items' order in the list (starting with 1). To include the WCI Authentication Source in the list, simply make an entry with “WCI Authentication Source” as the value. The WCI Authentication Source is for users who are created in the portal, manually, through invitations, or through the Create an Account page. For example, to include the WCI Authentication Source as the third item in the list, use the following tag: <AuthSourcePrefix3 value="WCI Authentication Source"> </AuthSourcePrefix3> Authentication source prefixes in the ordered list are displayed first in the list and are followed by any authentication sources not included in the ordered list. Authentication Source Modes:
|
|
AllowAutoConnect |
Setting for saving passwords in cookies.
|
|
SSOVendor |
Sets the single sign-on configuration. For information on SSO, see Deploying Single Sign-On. |
|
CaptureBasicAuthenticationForPortlets |
Determines whether to capture basic authentication information (login and password) and store it in the session (to send to portlets). The basic authentication information cannot be captured when users select “Remember my password” to login through a cookie.
|
|
RememberPassword |
This setting enables you to set how long the portal remembers your login password. The value should be formatted in minutes. The default is one week. |
|
BrowserLoginTokenExpiration |
This setting enables you to set whether the portal caches a login token in a browser session cookie that will expire when the browser is closed. Entering 0 will disable the cookie from being set, and is the default value. Entering a positive number controls how long the login token will remain valid. Note that the cookie is only valid as long as the browser is open, so if the user closes their browser, the login token will be removed. The login token expiration is an upper limit if they don't close their browser. A reasonable value for this would be 600 minutes (one workday). The value should be formatted in minutes. Note: The BrowserLoginTokenExpiration setting is only active when AllowAutoConnect is set to 1. |
The following configuration parameter applies to security.
| Parameter | Description |
|---|---|
|
SecurityMode |
This setting determines which pages will use SSL encryption. You must install a digital certificate and enable SSL on your Web server before changing the default value of 0. Note: Changing the security mode affects the URL Mapping. For more information, see Chapter A, "Configuring Portal Settings."
|
The following configuration parameters apply to documents.
| Parameter | Description |
|---|---|
|
NewDocumentTime |
The number of days that a document or folder displays “new” after its name. |
|
DocumentLastUpdated |
The number of days that a document displays “updated” after its name. |
|
OpenNewWindow |
The default setting for the open in new window preference.
Users can override this setting by changing their personal preferences. |
|
SubFolderBrowseThroughSearch |
This parameter sets the Subfolder Browsing source.
Note: Database driving browsing may often be faster for subfolders, while search may be faster for documents. |
The following configuration parameter applies to content crawlers.
| Parameter | Description |
|---|---|
|
MaxWebCrawlRadius |
The setting for the maximum number of links away from the target page to crawl. For example, if you select 1, the content crawler attempts to import every page directly linked to the target page; if you select 2, the content crawler attempts to import every page directly linked to the target page, and every page directly linked to those linked pages. This setting corresponds to the Crawl Radius list in the Web Content Crawler Editor. The default maximum is 4, which means the list allows a crawl radius of 1 to 4. |
The following configuration parameter applies to search.
| Parameter | Description |
|---|---|
|
NumSearchResultsPerPage |
The default number of search results to show per search results page. |
The following configuration parameter applies to style.
| Parameter | Description |
|---|---|
|
StyleSheetName |
The name for the portal's default stylesheet. |
The following configuration parameters apply to communities.
| Parameter | Description |
|---|---|
|
DefaultCommunityID |
Configure this setting only if your navigation scheme is Tabbed Section Left Vertical Navigation or if you use a custom navigation scheme that uses the IPluggableNavModelRO.GetDefaultCommunity() method. In these cases, the setting specifies the ID of the default community to display when a user clicks the Community tab. |
|
CommKnowledgeDirLinksPerPage |
The number of links to display on one screen in the community Knowledge Directory. |
The following configuration parameters apply to administration.
| Parameter | Description |
|---|---|
|
IsAdminSite |
Determines whether the computer is an administrative portal or a browsing-only portal.
|
|
AdminObjectsPerPage |
Determines the number of administrative objects of a single type (for example, content crawlers or content sources) allowed to display on one screen. This controls the number of items displayed on the administrative interface. The default is 10. |
|
MaxResultsToDisplay |
This setting is currently used only by Group editor, to set the maximum number of users to display. |
The following configuration parameter applies to invitations.
| Parameter | Description |
|---|---|
|
IsInvitationURLSecure |
Sets the security of the invitation URL. Note: Use a secure URL only if you disable http.
|
The following configuration parameter applies to gatewayed URLs.
| Parameter | Description |
|---|---|
|
PutUserIDInURL |
This setting controls if the user ID should be part of the gateway URLs or not.
Note: HTTP caching proxies will work better if userid is not part of the URL. |
The following configuration parameter applies to navigation.
| Parameter | Description |
|---|---|
|
intMyPortletPrefButtonInPortletHeader |
This setting controls if the My Portlet Preference button on is displayed in portlet headers.
|
By default, the portal areas are represented by the following tokens in friendly URLs: mypage, community, user, directory, document, and gw. However, the system administrator can change these tokens to fit the needs of the company.
Open the following file in a text editor: install_dir\settings\portal\FriendlyURLs.xml.
For example: C:\Oracle\Middleware\wci\settings\portal\FriendlyURLs.xml for Windows or /oracle/middleware/wci/settings/portal/FriendlyURLs.xml for UNIX or Linux
Edit the <key> values as desired.
You can change the following tokens:
mypage — represents a My Page object
community — represents a community object
user — represents a user
directory — represents a Knowledge Directory folder
document — represents a document
gw — represents gatewayed object
For example, you might change the token for directory to “folder” as in the following code:
<FriendlyURLMapping> <key>folder</key> <classId>17</classId> </FriendlyURLMapping>
This would mean that users could access Knowledge Directory folders through a friendly URL in the format: http://portal.company.com/portal/server.pt/folder/object_name/object_id
By default, you can direct users to portal areas with simple URLs, referred to as friendly URLs. However, you can disable friendly URLs for your deployment if you want to.
Open the following file in a text editor: install_dir\settings\portal\FriendlyURLs.xml.
For example: C:\Oracle\Middleware\wci\settings\portal\FriendlyURLs.xml for Windows or /oracle/middleware/wci/settings/portal/FriendlyURLs.xml for UNIX or Linux.
Comment out any FriendlyURLMapping you want to disable.
For example, you can disable friendly URLs for Knowledge Directory folders by commenting out the following code:
<!--
<FriendlyURLMapping>
<key>directory</key>
<classId>17</classId>
</FriendlyURLMapping>
-->
Gatewayed content is displayed with an URL that makes it easy to read and extract information from.
Gatewayed URLs include several tokens to help to determine where the gatewayed content came from.
Here is an example of a part of a gatewayed URL: ../gw/ws2000_c230_u1/..
The first part of the gateway URL is the gateway token — gw
Note:
The system administrator can customize this token in the FriendlyURLs.xml file. For information on customizing friendly URL tokens, see Customizing the Tokens in Friendly URLs.
The second part of the URL specifies where the content came from:
If the content came from a Web service, like in our example, you see ws followed by the Web service ID.
If the content came from a portlet, you see pt followed by the portlet ID.
The remaining parts of the URL specify any additional parameters, separated with underscores (_):
If there is a community parameter, you see c followed by the community ID.
If there is a page parameter, you see p followed by the page ID.
If there is a preference parameter, you see r followed by the preference ID.
If there is a user parameter, you see u followed by the user ID.
The installer sets most Search Service configuration parameters to useful defaults. In addition to the default configuration file, the install_dir/ptsearchserver/10.3.3/config directory includes template configuration files for Search Service deployments.
The templates include settings appropriate for a number of operating systems and RAM configurations. RAM determines the recommended maximum number of documents in the search collection, and this collection size determines many of the settings in the template configuration files. Examine the contents of these files, choose the one appropriate for your deployment, and rename the template node.ini (the active configuration file).
Note:
If the Search Service component resides on the same host computer as other portal components, consider using a template tuned for a smaller amount of memory to prevent system paging that adversely affects Search Service performance.
In some cases you might be able to further improve performance by modifying some values in the node.ini file. This section includes the following sections that describe the parameters in node.ini:
The following parameters appear in node.ini by default.
| Parameter | Description |
|---|---|
|
RFINDEX |
Directory used to store Search Service index files. By default, the installer puts these files in the install_dir/ptsearchserver/10.3.3/index subdirectory. The directory should have sufficient space for the collection you are indexing. You should not change this parameter unless you move your index files or are instructed to do so by customer support. |
|
RFPORT |
Port that the Search Service uses for communication with other processes (mainly the portal). The installer prompts for this port number during installation. This value displays in the Search Service Manager, on the Host Settings page. If you change this value in node.ini, you must also change the value in the Search Service Manager or the portal will malfunction. |
|
RF_MAPPING_TOKEN_CACHE_SIZE |
Specifies the size of the cache of mapping tokens. These tokens represent thesaurus and Best Bets entries read from the mappings collection. The default value is 5000. This parameter is chosen in the configuration file templates to reflect the expected number of tokens associates with the maximum supported collection size. The value of this parameter does not have a large effect on Search Service performance. Each cache element is 120 bytes, so the default mapping cache will occupy 600 kilobytes of memory. |
|
RF_LOG_VERBOSITY |
Numeric parameter that determines how much information is logged in the Search Service logs. Values range from 0 to 5. The default is 3 (high verbosity). You generally do not must change this parameter. We recommend you not set this below 3. If RF_LOG_VERBOSITY is set below 3, the reports generated by the Search Log Analysis external operation (and viewable on the Search Results Manager) will not contain all of the information needed to support log analysis. |
|
RF_DOCUMENT_TOKEN_CACHE_SIZE |
Numeric parameter that specifies the size of the cache of document tokens. These tokens are words from the actual indexed content in the Search Service. The default value is 250000. This parameter has a significant effect on Search Service indexing and query performance, with larger values providing better performance. This parameter is chosen in the configuration file templates to reflect the expected number of tokens associates with the maximum supported collection size. Each cache element is 120 bytes, so the default document token cache occupies 29 megabytes of memory. |
|
RF_SPELL_TOKEN_CACHE_SIZE |
Numeric parameter that specifies the size of the cache of spelling tokens. These tokens are word fragments from the spelling data derived from the indexed content. The default value is 250000. This value does not must be larger than the number of tokens in the spell collection, and it does not must exceed the value in the configuration file templates provided in the config directory. This parameter has a significant effect on indexing performance, spell checking, and wild card queries. If these operations seem particularly slow, you can increase the value specified by this parameter. In practice, values larger than 1000000 provide diminishing return while consuming significant amounts of memory. Each cache element is 120 bytes, so the default spell cache occupies 29 megabytes of memory. |
|
RF_INDEX_CACHE_BYTES |
Numeric parameter specifying the size of the index cache in bytes. The default value is 78643200 (75 megabytes). The value of this parameter has a significant effect on Search Service query performance. The index and docset (see RF_DOCSET_CACHE_BYTES) caches should be made as large as possible while leaving sufficient memory available for the Search Service's other needs. |
|
RF_DOCSET_CACHE_BYTES |
Numeric parameter specifying the size of the document cache in bytes. The default value is 2614400 (25 megabytes). The value of this parameter has a significant effect on Search Service query performance. The index and docset (see RF_INDEX_CACHE_BYTES) caches should be made as large as possible while leaving sufficient memory available for the Search Service's other needs. |
Optionally, if advised by customer support, you can add the following values to the node.ini file.
| Parameter | Description |
|---|---|
|
RFLOG |
Directory where the Search Service writes its logs. The default is the SearchServerInstall/logs subdirectory. Edit this value only if you change this directory; the new directory must exist and must be writable by the Search Service. |
|
RF_HIGH_PRIORITY |
If this parameter is set to any value, Search Service attempts to increase its process priority over that of other processes. This is not normally necessary, but might be useful on a computer where other processes compete for resources with the Search Service. |
|
RF_MAX_WILDCARD_EXPANSIONS |
When a user enters a query that uses a wildcard (for example, “plum*”), this parameter determines the maximum number of terms into which the wildcard is expanded (for example, plum, plums, plumber). The default is 100 terms. This limit keeps overly general queries (“*ing”) from expanding into a huge number of terms and consuming too much time and memory. In large installations, you might must increase this value. |
|
RF_MAX_QUERY_MSECS |
Maximum time, in milliseconds, for user queries. The default is 10000 (ten seconds). After processing the query for this much time, the Search Service returns results it has found so far. You might want to lower the value of this parameter if end users complain that ten seconds is too long to wait for query results. |
|
RF_MAX_TOTAL_RESULTS |
Maximum number of results returned by a query. The default is 10000. You do not generally must change this parameter because the portal displays fewer results than the Search Service maximum. |
|
RF_MAX_NUM_STATIC_ARCHIVES |
Maximum number of static archives per collection created in the index directory. The default is 50; meaning that there will be up to 50 archive.NNN.docset files (where NNN is a number), archive.NNN.index files, and so on. There can also be up to 50 spell.NNN.docset files, spell.NNN.index files, and so forth. You do not generally must change this parameter; the only reason might be an operating system (such as Solaris 2.6) that does not allow the Search Service to use enough file descriptors to open all the files at once. Lowering this number causes archive merges to use more memory and disk space. |
|
RF_QUERY_THREADS |
Number of threads to dedicate to query processing. The default is 8. You might must increase this parameter if your Search Service is under heavy load. The value should represent the expected number of simultaneous queries. If this value is too low, incoming queries will wait on a queue for the next free query thread and users will experience longer query times (possibly several seconds). |
|
RF_QUERY_QUEUE_SIZE |
When all Search Service query threads (see RF_QUERY_THREADS) are busy, incoming query requests are placed on a queue to wait for the next available query thread. This parameter determines the length of that queue. The default value is 20 and usually does not must be changed. Should the query queue ever become full, additional query requests are rejected and a message is written to the Search Service logs. If this happens, you can increase RF_QUERY_QUEUE_SIZE. |
|
RF_INDEX_THREADS |
Number of threads to dedicate to indexing requests. The default is 2. You might must increase this parameter if the indexing performance of your Search Service is too low. However, devoting additional system resources to indexing will reduce query performance. Ideally, the value of RF_INDEX_THREADS should not exceed the number of CPUs on the system. |
|
RF_INDEX_QUEUE_SIZE |
When all Search Service index threads (see RF_INDEX_THREADS) are busy, incoming index requests are placed on a queue to wait for the next available index thread. This parameter determines the length of that queue. The default value is 20. To estimate a good value, add the number of threads in all content crawlers that might be running simultaneously (you can request up to four threads when setting up a content crawler). To be conservative, make your estimates high. If this parameter is too low, content crawlers can fill the index queue and the Search Service rejects additional index requests until the queue has room for more requests. Note: It is better to schedule nonoverlapping crawls than to set a high value for RF_INDEX_QUEUE_SIZE; consider changing the crawl schedule before modifying this parameter. |
|
RF_HANDSHAKE_THREADS |
Number of threads to dedicate to servicing incoming socket connections. The default is 5. This value should never must be changed. |
|
RF_HANDSHAKE_QUEUE_SIZE |
Socket connections from Search Service clients are placed on this queue to await acknowledgment by one of the handshake threads (see RF_HANDSHAKE_THREADS). This parameter determines the length of that queue. The default value is 20. Once successfully acknowledged, the connections are assigned to either the query or index queue. Under exceptionally high loads, this queue might fill up and the Search Service will reject new connections until the queue has room for more requests. Should this happen, you can increase the value of this parameter. |
|
RF_TOKEN_LEXICON_REBUILD_LIMIT |
Maximum lexicon size, measured in number of tokens, to rebuild automatically. If the Search Service detects that the lexicon was closed improperly, the lexicon is rebuilt as part of the startup process. This can be time consuming. The default value is 400000, ensuring that the rebuild requires no more than a few minutes. Larger lexicons needing repair must be rebuilt with the standalone examinearchive utility. You might change the value or set it to zero to allow automatic rebuild of arbitrarily large lexicons. In Windows Systems: Setting this value too large can result in error dialogs being posted by the Windows Service Control Manager when the Search Service is run as a Windows service and a lexicon rebuild is performed. These error dialogs indicate that the service is failing to start in a timely manner. They can be disregarded. |
|
RF_USE_DATA_FILE_CACHE |
Numeric parameter indicating whether the Search Service should use caches when accessing index and document data. A value of zero disables the caches and causes the Search Service to use memory-mapping. A nonzero value activates the caches. The default value is 1. We strongly recommend you do not change this value. This parameter serves as the master on/off switch for RF_INDEX_CACHE_BYTES, RF_DOCSET_CACHE_BYTES, RF_INDEX_CACHE_MAX_PAGES_PER_BLOCK, and RF_DOCSET_CACHE_MAX_PAGES_PER_BLOCK. When RF_USE_DATA_FILE_CACHE is zero, these other parameters have no effect. Disabling the caches for small search collections (less than 1 gigabyte of data) might provide a slight improvement in performance depending upon the amount of available physical memory on the Search Service host. In memory-mapped mode, the Search Service fails if the index and document data, plus the Search Service's internal data structures should exceed 2 or 3 gigabytes (depending upon the operating system configuration). |
|
RF_REQUIRED_DISK_SPACE |
Amount of disk space (in KB) required to start a dynamic index merge. When merging dynamically indexed data into the search collection, the Search Service verifies that this amount of free space is available on the volume containing the search collection. If the space is not available, the merge process aborts, the Search Service enters read-only mode, and further dynamic indexing requests are rejected. The default value for this parameter is 40000 and should not must be changed. |
When you modify cache settings, keep the following important values and relationships in mind:
An RF_DOCSET_CACHE_BYTES:RF_INDEX_CACHE_BYTES ratio of 1:3 has been empirically determined to provide near-optimal cache performance for typical search collections.
Token cache entries occupy 108 (32-bit platforms) or 120 (64-bit platforms) bytes.
Reasonable values for RF_MAPPING_TOKEN_CACHE_SIZE are 500 to 10000.
For performance reasons, document offsets and index offsets data is accessed through memory-mapping, regardless of the setting of RF_USE_DATA_FILE_CACHE in the node.ini file meaning that the memory footprint of a running Search Service depends on the size of the search collection, and this consideration has been calculated in the settings for the configuration file templates in the config directory. The amount of memory needed for these mappings can be calculated approximately as (Size of *.docsetOffsets files in bytes) + 0.006 * (Size of *.index and *.key.index files in bytes).
Leave sufficient address space (and, ideally, physical RAM) available for the number of query and index threads. Allow 10 MB per query thread (see RF_QUERY_THREADS) and 50 MB per index thread (see RF_INDEX_THREADS).
|
 Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|