B Working with Configuration Files

This appendix contains a detailed description for each of the Oracle WebCenter Collaboration configuration files that you can edit to customize your installation. It includes the following sections:

Overview of Oracle WebCenter Collaboration Configuration Files
config.xml
documentTemplates.xml
filetypes.xml
database.xml

Overview of Oracle WebCenter Collaboration Configuration Files

This section provides overviews of Oracle WebCenter Collaboration and Notification Service configuration files. The following table provides a general overview of the Oracle WebCenter Collaboration configuration files.

Table B-1 Oracle WebCenter Collaboration Configuration Files

Oracle WebCenter Collaboration Configuration File	Description
config.xml	The main configuration file for Oracle WebCenter Collaboration. This file allows you to configure various advanced Oracle WebCenter Collaboration settings, including connection information to other components that Oracle WebCenter Collaboration uses (such as search and notification) and advanced settings for features such as bulk upload and WebDAV. By default, it is installed in install_dir\ptcollab\10.3.0\settings\config, where install_dir is, by default, C:\bea\alui. For more information, see config.xml.
documentTemplates.xml	Sets the document templates that are recognized byOracle WebCenter Collaboration. By default, it is installed in install_dir\ptcollab\10.3.0\settings\config, where install_dir is, by default, C:\bea\alui. For more information, see documentTemplates.xml.
filetypes.xml	Lists file types in Oracle WebCenter Collaboration. By default, it is installed in install_dir\ptcollab\10.3.0\settings\config, where install_dir is, by default, C:\bea\alui. For more information, see filetypes.xml.
database.xml	Configures Oracle WebCenter Collaboration database settings. The configuration file is automatically updated during the installation of Oracle WebCenter Collaboration. By default, it is installed in install_dir\ptcollab\10.3.0\settings\config, where install_dir is, by default, C:\bea\alui. For more information, see database.xml.
dr.xml	Configures the connection to the Document Repository Service. By default, it is installed in install_dir\ptcollab\10.3.0\settings\config, where install_dir is, by default, C:\bea\alui. Note: dr.xml is automatically updated during the installation of Oracle WebCenter Collaboration. Do not modify this file.
audit.xml	Controls the logging and profiling functionality of Oracle WebCenter Collaboration. By default, it is installed in install_dir\ptcollab\10.3.0\settings\config, where install_dir is, by default, C:\bea\alui. Note: The contents of this file are generated byOracle WebCenter Collaboration. They should not be modified.
cache.xml	Manages Oracle WebCenter Collaboration caches. By default, it is installed in install_dir\ptcollab\10.3.0\settings\config, where install_dir is, by default, C:\bea\alui. Note: The contents of this file are generated by Oracle WebCenter Collaboration They should not be modified.
cluster.xml	Configures settings for Oracle WebCenter Collaboration that is set up in a clustered network environment. By default, it is installed in install_dir\ptcollab\10.3.0\settings\config, where install_dir is, by default, C:\bea\alui.
object-migration.xml	Controls object migration in Oracle WebCenter Collaboration. By default, it is installed in install_dir\ptcollab\10.3.0\settings\config, where install_dir is, by default, C:\bea\alui. Note: The contents of this file are generated by Oracle WebCenter Collaboration. They should not be modified.

For information on creating, editing and deleting holidays, see Restricting the Size of Single File Uploads.

config.xml

The following table provides a detailed description of the configuration parameters in Oracle WebCenter Collaboration's config.xml file.

Note:

Do not change nodes that are not documented in this table.

Table B-2 Nodes in config.xml

Node	Description
portal version	Displays the version of the owning portal.
audit	Filename of the audit run-time configuration file.
database	Filename of the database connectivity configuration file.
cache	Filename of the managed cache configuration file.
search enabled	Enables and disables communication between Oracle WebCenter Collaboration and the Search Server. Valid values are yes and no.
servername	The host name of the Search Server. This value should be a fully-qualified domain name.
port	The port where the Search Server listens for communication.
defaultLanguage	The default language of the Search Server.
languages_dir	The path name to the location where language information is stored by the Search Server.
textExtraction	The path and filename of the application used to perform text extraction.
maxTextBytesToIndex	The maximum size for each object that is indexed by the Search Server.
temp_dir	The path name of the temporary directory used by the Search Server.
enableLogging	Enables and disables Search Server logging. Valid values are true and false.
runReconcileThread	This should be set to true on the computer on which Oracle WebCenter Collaboration is installed. In a load balancing environment, set to false on all servers except one. In a global deployment environment, set to false on all satellite nodes and set to true on exactly one server at the master node.
realTimeIndexing	If not in a global deployment, set this value to true on all computers on which Oracle WebCenter Collaboration is installed. If in a global deployment, set to false on all computers on which Oracle WebCenter Collaboration is installed, including the master node.
fileTypeRegister	Filename of the filetypes configuration file.
maxUploadMegaBytes	The maximum size for a single file upload.
temporaryZipFolder
bulkUpload	Enables and disables the Bulk Upload feature. Valid values are yes and no.
nonGatewayedUploads	Determines if uploads are gatewayed through the Portal server. Valid values are: yes: Uploads are gatewayed through the Portal server. no: Uploads are not gatewayed through the Portal server.
url	The base URL Microsoft Office uses to communicate with Oracle WebCenter Collaboration. This attribute is used if enable is set to true. This value is set by Oracle WebCenter Configuration Manager and should not be updated by editing config.xml directly.
tokenBasedAuthentication	Determines if token-based authentication is used. In a normal Oracle WebCenter Collaboration implementation, there is no need to change these values. Valid values are: true: Enables token-based authentication. This is the default. false: Disables token-based authentication. This setting can only be used when HTTP communication is gatewayed and some other authentication method is being used.
useClustering	Controls the use of message clustering (also known as load balancing) with token-based authentication. Valid values are: yes: Enables message clustering. This is the default. no: Disables message clustering. This setting should only be used when message clustering is not required and would degrade performance. This setting has no effect if general clustering functionality has been disabled for Oracle WebCenter Collaboration. Therefore we recommend that you always enable useClustering.
maxWaitSeconds	Determines how long Oracle WebCenter Collaboration waits for a response from other servers in the cluster. This setting is applicable only if token-based authentication and message clustering/load balancing are enabled. Default: 30
webEdit	Enables or disables WebEdit. Valid values are yes and no.
nonGatewayed Access	Determines if HTTP communication between Microsoft Office and Oracle WebCenter Collaboration is gatewayed through the portal. Valid values are: yes: HTTP communication is gatewayed through the portal. This is the default. no: HTTP communication is not gatewayed through the portal.
serverURL	The base URL Microsoft Word uses to communicate with Oracle WebCenter Collaboration. This attribute is used if enable is set to true. This value is set by Oracle WebCenter Configuration Manager and should not be updated by editing config.xml directly.
truncateFileNames	The number of characters that are allowed in the file name displayed in WebDAV before the characters are truncated.
clsid	Specifies the class ID of the COM object. This value should not be modified.
fileSpec	Specifies the name of the distribution file and information about the component. This value should not be modified unless a more recent version of the object needs to be deployed.
installOfficeToolsPopUp	Enables or disables the Collaboration Office Tools Add-In installer. Valid values are yes and no.
webDAV	Contains WebDAV settings.
fullWebDAVAccessToThisServer	Enables or disables the use of WebDAV. Valid values are: yes: Causes Oracle WebCenter Collaboration to accept WebDAV requests. This is the default. no: Causes Oracle WebCenter Collaboration to reject WebDAV requests.
requestsAreGatewayed	Enables or disables WebDAV communication between Windows Explorer and Oracle WebCenter Collaboration. Valid values are true and false.
uiDisplaysServerConfigInfo	Controls how Oracle WebCenter Collaboration displays the New \| Web Folder dialog in the Documents tab. Valid values are: yes: Displays the Web Folder dialog box. This is the default. no: Does not display the Web Folder dialog box.
useNonGatewayedURL	Determines whether the Web Folder dialog box displays instructions for mapping a gatewayed network drive. Valid values are: no: Causes the Web Folder dialog to display information for mapping between Windows Explorer and Oracle WebCenter Collaboration through the gateway. This is the default. yes: Causes the Web Folder dialog to display information for mapping directly between Windows Explorer and Oracle WebCenter Collaboration. If the connection between Windows Explorer and Oracle WebCenter Collaboration is gatewayed, this instance of Oracle WebCenter Collaboration continues to function as the WebDAV service. Therefore, this instance of config.xml must have fullWebDAVAccessToThisServer.enabled set to true and fullWebDAVAccessToThisServer.requestsAreGatewayed set to true.
serverURL	Provides the base URL to Oracle WebCenter Collaboration that acts as the WebDAV service if Oracle WebCenter Collaboration is configured to communicate directly with Windows Explorer. This value is set by Oracle WebCenter Configuration Manager and should not be updated by editing config.xml directly.
imageServer	Specifies the relative paths to the directories in the Image Service where the Oracle WebCenter Collaboration images, help, and javascript can be found.
baseURL	The base URL of the image service used with Oracle WebCenter Collaboration. By default, this node is empty and Image Service is used. We recommend that you leave this node empty; however, if necessary, you can use this node for debugging purposes or to point to an image service other than the Image Service.
images	The relative path where the images are stored.
javascript	The relative path where the javascript source files are stored.
misc	The relative path to where miscellaneous source files are stored.
help	The relative path where the Oracle WebCenter Collaboration online help files are stored.
help508	The relative path where online help files for 508-mode are stored.
portal_common	The location of common portal images.
applets	The relative path where java applets are stored.
messaging	Configuration section for communicating with the Notification Service.
notification	Enables or disables the Notification Service. Valid values are yes and no.
cache-subscriptions	Increases the efficiency of the Notification Service by caching subscriptions every hour. Valid values are yes and no. Default is yes. We recommend that you keep this setting enabled unless your system has a performance or memory issue.
host	The host of the Notification Service.
port	The port where the Notification Service listens for communication.
max-queue-size	Maximum number of notification events that can be queued at any one point in time. Generally this value should not be increased but can be decreased to throttle the number of notification events being sent out.
name	Configured through Oracle WebCenter Configuration Manager.
password secure	Indicates whether the owning portal password is encrypted (and secure). If you are using an encrypted password, set to yes. Valid values are: yes: Indicates that the owning portal password is encrypted and secure. no: Indicates that the owning portal password is not encrypted and not secure.
gateway-entry https:	Defines the main access point for the portal. If the portal has been configured to use https but this is not set in the portal PTSERVERCONFIG table, you can set the attribute https to yes to force https.
collaboration-remote-server-uuid	Do not modify this value.
collaboration-web-service-uuid	Do not modify this value.
collaboration-config-web-service-uuid	Do not modify this value.
collaboration-remote-datesource-uuid	Do not modify this value.
cluster	Enables and disables clustering. Valid values are yes and no.
http-caching application-view	Enables and disables caching of http requests to increase efficiency of application views. Valid values are yes and no.
portlet-enabled	Enables and disables portlet caching. Valid values are yes and no.
web-services	Enables and disables Oracle WebCenter Collaboration Web services. Valid values are yes and no.
administration	Enables and disables Collaboration Administration pages.
object-migration	Enables and disables object migration functionality. Valid values are yes and no.
jscontrols	Settings for the jscontrols components.
imageServerConnectionURL	Alternative non-SSL URL to access jscontrols if Image Service is running on SSL.
debugLevel	Internal debug level for the jscontrols component.
calendar-cache	Enables and disables calendar caching. Valid values are true and false.
calendar-trace	Enables and disables trace for debugging of calendar problems. Valid values are true and false. Do not modify this node unless instructed to do so by Oracle Technical Support.
explorer	Settings for Collaboration Explorer controls.
serverSidePagination	Enables and disables server-side pagination of Explorer controls to improve performance when there are many items. Valid values are yes and no.
upgrade	Refers to a copy of the old config.xml file after an upgrade.
browserMode	Do not modify this node. We support only Normal mode.
richTextEditor	Enables and disables the rich text editor for discussion messages and announcements. Valid values are yes and no.
activityRight	Determines whether to check community roles for managing Oracle WebCenter Collaboration projects.
checkCommunityRoles	If enabled, this node performs extra checks to verify whether a user has Project Leader access to a community project. Valid values are true and false. Enabling this node may slow down the performance of Project Explorer.
auto-create-community project	Valid values are: yes: Causes Oracle WebCenter Collaboration to automatically create community projects on Community pages. no: Disables automatic create community project functionality.
groupware	This node is used to configure groupware integration. Enabled and server settings are configured through Oracle WebCenter Configuration Manager.
timeoutInMilliSecond	Specifies the amount of time, in milliseconds, that Oracle WebCenter Collaboration waits for responses from the SOAP server. If the SOAP server does not respond in this amount of time, the current operation is aborted and an exception is returned. Due to the performance constraints and the fact that large attachments might be transferred between Oracle WebCenter Collaboration through Exchange, the attribute should be set to a value greater than 10000 (10 seconds).
calendarCachePeriod	Specifies the cache time-out period, in seconds, for groupware items on the My Calendar portlet. When the My Calendar portlet is refreshed, Oracle WebCenter Collaboration checks if the current items have timed out. If they have, Oracle WebCenter Collaboration retrieves the entries from the back-end server. Otherwise, the entries are retrieved from memory.
addressBookReturn	The maximum number of returned addresses from the address search operation.
maxAttachment SizeinKB	The maximum attachment file size, in kilobytes, that a meeting request or appointment can contain. This limit is the total file size of all attachments an item can have.
calendarAutoSynch	Enables or disables automatic synchronization between a user's project calendar and their Exchange or Notes calendar. Valid values are: yes and no.
monthRange	The range of months auto-synchronization covers, starting from the current month.
instant-messaging	Instant messaging is enabled through Oracle WebCenter Configuration Manager.
presence-url	This node returns an image to indicate whether the user is online or not.
send-url	This node includes the URL from which messages are sent. The $user variable includes the e-mail address of the individual user.
contact-url	This node should include the URL at which messages can be received. The $user variable includes the e-mail address of the individual user.
presence-poll-interval	This node includes the number of seconds between presence polls.
ALIPIntegration	Oracle BPM integration is enabled through Oracle WebCenter Configuration Manager.
processPortletUUID	The UUID for the Process - Application portlet. By default, the value is E1F1B56E-0563-4397-9544-223AD1885C16. You do not need to change this value.
requestTimeoutInMilliSecond	Specifies the amount of time, in milliseconds, that Oracle WebCenter Collaboration waits to receive the names of available processes from Oracle BPM. If Oracle WebCenter Collaboration does not receive these names in the specified amount of time, Oracle WebCenter Collaboration stops waiting for process names. By default, the value is 60000 (60 seconds).
project-import	Contains parameters that are specific to Microsoft Project import.
number-of-tasks-limit	The total number of tasks allowed in an import. The default is 1000.
expand-tasklists-by-default	Displays expanded tasklists by default. Valid values are yes and no. When disabled, only root tasks appear in tasklists by default.
email	Email a project is enabled through Oracle WebCenter Configuration Manager.
connection-pool	The number of socket handlers for incoming connections.
mail-processors	The number of threads devoted to processing incoming e-mails.
maximum-message-size	The maximum size of incoming e-mails. `-1` indicates that Oracle WebCenter Collaboration does not perform size checks. When this is the case, the Oracle WebCenter Collaboration API enforces size limits for message bodies and files.
enable-summary-list	This node is used to expose the e-mail summary list feature through the UI. This feature is not supported. Valid values are true and false.
authorized-connections	The names or IP addresses of hosts, in a comma-delimited format, that are allowed to connect to the SMTP handler. We recommend creating this list of names to enforce security. See the config.xml file for an example of this list.
idle-timeout	The time (in minutes) that an incoming connection can remain idle.
transaction-manager	This node includes database-specific settings. Only database experts should modify these settings.

documentTemplates.xml

You can define the systemwide document templates that appear in the user interface when creating a new Microsoft Office document by adding entries to documentTemplates.xml. By default, this file only includes document templates for empty Microsoft Office documents. You can add additional entries to allow custom document templates to appear in the interface.

The following table provides a detailed description of the configuration parameters in Oracle WebCenter Collaboration's documentTemplates.xml file.

Table B-3 Nodes in documentTemplates.xml

Node	Description
templateFile cache	The name of the file located in install_dir\ptcollab\version\settings\documentTemplates. Valid values are: True: Set for smaller files that should be cached in memory. False: Set for very large files that should not be cached in memory.
fileType	The name of one of the filetypes from filetypes.xml for which inPlaceEdit is enabled.
displayString	The string to appear in the drop-down list in the graphical user interface. Not used unless the next field below is empty.
displayStringIndex	Index into the Oracle WebCenter Collaboration localized string files of a string to use in the drop-down list. If this field is not empty, the previous field above is not used.
defaultDocName	Default document name for new documents created from this template. Not used unless the next field below is empty.
defaultDocNameIndex	Index into the Oracle WebCenter Collaboration localized string files of a string to use as the default document name for documents created from this template. If this field is not empty the previous field above is not used.

filetypes.xml

You can define filetypes corresponding to the types of documents that are used in your implementation. New filetypes can be added to the configuration file filetypes.xml.

Creating filetypes lets you have more control over indexing and search. It also lets you specify icons for each filetype, thereby customizing the Oracle WebCenter Collaboration user interface. The following types of documents have filetypes defined by default:

HTML
Microsoft Excel
Microsoft PowerPoint
Microsoft Project
Microsoft Word
Microsoft Visio
PDF
text
zip

To define new filetypes, you must create a new entry in filetypes.xml. Place the entries in the order in which you want them to appear in the user interface. You can define multiple content types and extensions for each filetype. You should ensure that the preferred content type and extension are defined first. Use the following guidelines when changing the contents of filetypes.xml:

Do not modify the <UNKNOWN index> node. However, you may modify the other nodes and add new entries.
Put the entries in the order in which they should appear in a drop-down list.
You may use multiple contentType and extension fields in each index.
You should place the preferred content type as first in the list for each index.
No content type or extension should appear in more than one fileType entry.

The following table provides a detailed description of the configuration parameters in Oracle WebCenter Collaboration's filetypes.xml file.

Table B-4 Nodes in filetypes.xml

Node	Description
UNKNOWN index	Note: Do not modify this node or its subnodes.
html index	Specifies whether html documents should be indexed for searching. Valid values are yes and no.
msexcel index	Specifies whether Microsoft Excel documents should be indexed for searching. Valid values are yes and no.
mspowerpoint index	Specifies whether Microsoft PowerPoint documents should be indexed for searching. Valid values are yes and no.
msproject index	Specifies whether Microsoft Project documents should be indexed for searching. Valid values are yes and no.
msword index	Specifies whether Microsoft Word documents should be indexed for searching. Valid values are yes and no.
msvisio index	Specifies whether Microsoft Visio documents should be indexed for searching. Valid values are yes and no.
pdf index	Specifies whether .pdf documents should be indexed for searching. Valid values are yes and no.
text index	Specifies whether .txt documents should be indexed for searching. Valid values are yes and no.
gzip index	Specifies whether .zip files should be indexed for searching. Valid values are yes and no.
displayString	This string is used directly in the graphical user interface to describe this type of document if no displayStringIndex occurs.
shortcutDisplayString	This string is used directly in the graphical user interface to describe this type of document shortcut if no shortcutDisplayStringIndex occurs.
displayStringIndex	If a displayStringIndex entry occurs, it is used as a key into Oracle WebCenter Collaboration's localized language files.
templateDisplayString	This string is used directly in the graphical user interface to describe this type of document template if no templateDisplayStringIndex occurs.
shortcutDisplayStringIndex	If a shortcutDisplayStringIndex entry occurs, it is used as a key into Oracle WebCenter Collaboration's localized language files.
templateDisplayStringIndex	If a templateDisplayStringIndex entry occurs, it is used as a key into Oracle WebCenter Collaboration's localized language files.
portalDisplayStringIndex	This string is used as a key into the portal's localized language files. The resulting string appears on the Search Results page.
imageFile	The name of the file icon in install_dir\ptimages\imageserver\plumtree\collab\private\img
shortcutImageFile	The name of the file shortcut icon in install_dir\ptimages\imageserver\plumtree\collab\private\img
templateImageFile	The name of the file template icon in install_dir\ptimages\imageserver\plumtree\collab\private\img.
contentType	The value of the Content-Type header sent to the browser for this type of file. More than one contentType subnode may appear for each fileType node, but the same contentType should not be used for more than one fileType.
extension	The file extension for this type of file. More than one extension subnode may appear for each fileType node, but the same extension should not be used for more than one fileType.
webEdit	Specifies whether this type of file can be WebEdited. Unless serious modifications are made to the code, only Microsoft Office applications are able to be WebEdited. Valid values are yes and no.
appCode	Represents the application that opens the document in a WebEdit session. Valid values are: 1 (for Microsoft Word) 2 (for Microsoft Excel) 3 (for Microsoft PowerPoint)

database.xml

This section provides information about the <linked-database-alias> node in database.xml.

When using a SQL Server database for Oracle WebCenter Collaboration, the <linked-database-alias> node should appear like the following:

<linked-database-alias>PORTAL_DB_NAME.PORTAL_DB_OWNER.</linked-database-alias>

Both periods ( . ) in the linked database alias are required. The PORTAL_DB_OWNER must be the owner of the database who created the portal tables; it is not adequate to have db_owner permission on the database.

To verify that you are using the correct user:

Open the portal database in SQL Server Enterprise Manager.
Click Tables.
Check the login name that appears in the Owner column of the tables. This login name is the owner that should appear in the <linked-database-alias> node.

If you used the sa login to create the portal tables, the database owner is dbo. To confirm the database owner, verify the database owner in Enterprise Manager.

Note:
If you edit database.xml, you must stop and start Oracle WebCenter Collaboration for the changes to take effect.