Home
Files configuration properties
Configuration properties control how and when various Files operations take place, and also help in the optimization of server performance. They require a Files server restart to take effect. The following table lists the configuration properties in files-config.xml that you can modify. Note the following restrictions on the values allowed in the file:
- All configuration properties (except those with multiple values) are required.
- .enabled properties must have boolean values true or false.
- Number values must be integers.
Files configuration properties
Property Description activeContentFilter.enabled
Specifies the mime.types that are scanned and scripts removed when files are downloaded. By default this is enabled on text/html and application/xhtml+xml mime.types.
You can disable this filter by changing the value to
false, but that might leave your environment open to cross-site scripting attacks unless you have taken other security precautions. For more information on securing against cross-site scripting attacks, see the topic Securing features from malicious attack.
If you configure an IBM HTTP Server to download files following the steps in Configuring Files and Wikis downloading for production deployments, this property is ignored and scripts are not removed. To protect against cross-site scripting attacks you should consider creating a sub-domain. See the topic Specifying a separate file download domain for information.
api.indent.enabled
Specifies whether the Files service API output is indented. This is false by default. To enable indentation, specify true.
Enable this property to help with development and debugging. It is disabled by default because it does affect performance.
cache.http.publicContentMaxAgeInSecs
Maximum age of the public content cache before it is refreshed, in seconds. The public content cache stores static Web resources, such as JavaScript™ and images. Lower this value to show resource changes more quickly.
The value must be greater than or equal to 0.
You can force a resource update by opening the LotusConnections-config.xml common configuration properties file and setting the versionStamp property to any token. The token is included in most urls, and urls cache by path and cache header, so the new url overrides the old version and refreshes the resources. For information, see the topic Common configuration properties.
Some resources, such as some images, do not use version stamps. If you edit those frequently, you can lower the cache.http.publicContentMaxAgeInSecs value to show changes more quickly. If not, you can leave the value high and update the version stamp when you make changes.
cache.http.publicFeedMaxAgeInSecs
Maximum age of the public feed cache before it is refreshed, in seconds. Public feeds pass information to the Public Files view. You may want to raise this value in very large deployments (for example, over a million files) to avoid performance issues. It could also be lowered to have very up-to-date information in the public view. A value of 0 means no feeds are cached.
The value must be greater than or equal to 0.
cache.user.timeout
Number of milliseconds user objects stay in the user information cache. The user information cache stores metadata about users, such as names and e-mail addresses. Use this property to control the frequency of requests to the Files database for user information.
The value must be greater than or equal to 1.
If the value of a user's data changes in the background (when the update user task or commands for MemberSynch are executed) the cache is invalidated.
db.dialect
Reflects the current database type, typically specified during installation. Accepts the values
DB2,
Oracle, or
SQL Server
directory.community.membershipCache.maximumAgeOnLoginInSeconds
Number of seconds after a user logs in that community membership cache is refreshed. Only applicable if Community Files and Community Integration are enabled.
The value must be greater than or equal to 0.
Refreshing the cache is required for a user to have the same access as the community, but it affects performance. A short time before refresh means Files is more up-to-date, but performance may be slower. A long time before refresh may affect performance less, but users do not have immediate access to what the community can access.
You can lower the value here and then tell users that logging out and then in again is the best way to refresh the cache. This would allow you to increase the number of seconds incommunity.membershipCache.maximumAgeOnRequestInSeconds so that frequent requests would not affect performance.
directory.community.membershipCache.maximumAgeOnRequestInSeconds
Number of seconds after an application request that the community membership cache is refreshed. Only applicable if Community Files and Community Integration are enabled.
The value must be greater than or equal to 0.
Refreshing the cache is required for a user to have the same access as the community, but it affects performance. A short time before refresh means Files is more up-to-date, but performance may be slower. A long time before refresh may affect performance less, but users do not have immediate access to what the community can access.
If you lower the value ofcommunity.membershipCache.maximumAgeOnLoginInSeconds and then tell users that logging out and then in again is the best way to refresh the cache, you can increase this value to 10 or even 20 minutes, so that frequent requests will not affect performance.
directory.group.membershipCache.maximumAgeOnLoginInSeconds
Number of seconds after a user logs in that the group membership cache is refreshed. Only applicable if groups are enabled.
The value must be greater than or equal to 0.
Refreshing the cache is required for a user to have the same access as the group, but it affects performance. A short time before refresh means Files is more up-to-date, but performance may be slower. A long time before refresh may affect performance less, but users do not have immediate access to what the group can access.
You can lower the value here and then tell users that logging out and then in again is the best way to refresh the cache. This would allow you to increase the number of seconds ingroup.membershipCache.maximumAgeOnRequestInSeconds so that frequent requests would not affect performance.
directory.group.membershipCache.maximumAgeOnRequestInSeconds
Number of seconds after an application request that the group membership cache is refreshed. Only applicable if groups are enabled.
The value must be greater than or equal to 0.
Refreshing the cache is required for a user to have the same access as the group, but it affects performance. A short time before refresh means Files is more up-to-date, but performance may be slower. A long time before refresh may affect performance less, but users do not have immediate access to what the group can access.
If you lower the value ofgroup.membershipCache.maximumAgeOnLoginInSeconds and then tell users that logging out and then in again is the best way to refresh the cache, you can increase this value to 10 or even 20 minutes, so that frequent requests will not affect performance.
directory.group.synchTask.enabled
Enables or disables the synchronization task for groups. The default is true
The synchronization task runs automatically in the background, synchronizing group names in the Files database with the Lotus Connections user It queries the user with the ID and when it finds a match it synchronizes the group name. If the group name is not found in the user directory, it is removed from the database.
directory.group.synchTask.frequencyInMins
Specifies the frequency in minutes that the synchronization task runs. Does not run if groups are disabled.
The value must be greater than or equal to 1.
The synchronization task runs automatically in the background, synchronizing group names in the Files database with the Lotus Connections user It queries the user with the ID and when it finds a match it synchronizes the group name.
The task runs on any group information older than the value specified in thegroup.synchTask.maximumDataAgeInHours property. It runs at a frequency specified in thegroup.synchTask.frequencyInMins property. It pauses between groups for the amount of time specified in thegroup.synchTask.pauseInMillis property.
Adjust this property to speed up or slow down the process of synchronizing group information.
directory.group.synchTask.maximumDataAgeInHours
Number of hours that group information can remain in the Files database before the synchronization task can run on it. Does not run if groups are disabled.
The value must be greater than or equal to 0.
The synchronization task runs automatically in the background, synchronizing group names in the Files database with the Lotus Connections user It queries the user with the directory ID and when it finds a match it synchronizes the group name.
The task runs on any group information older than the value specified in thegroup.synchTask.maximumDataAgeInHours property. It runs at a frequency specified in thegroup.synchTask.frequencyInMins property. It pauses between groups for the amount of time specified in thegroup.synchTask.pauseInMillis property.
directory.group.synchTask.pauseInMillis
Number of milliseconds that the synchronization task should wait before updating the next group's information. Use this to add a small amount of time between synchronizing items in the queue to avoid overloading your user as the task runs. Does not run if groups are disabled.
The value must be greater than or equal to 0.
The synchronization task runs automatically in the background, synchronizing group names in the Files database with the Lotus Connections user It queries the user with the directory ID and when it finds a match it synchronizes the group name.
The task runs on any information older than the value specified in thegroup.synchTask.maximumDataAgeInHours property. It runs at a frequency specified in thegroup.synchTask.frequencyInMins property. It pauses between groups for the amount of time specified in thegroup.synchTask.pauseInMillis property.
Zero is an acceptable value if the remote user can handle many simultaneous queries.
directory.typeaheadSearch.maximumResults
Maximum number of names to display when a user searches for user or group names in a search field. Sets a maximum for both typeahead results and search results (when they click the search icon).
The value must be greater than or equal to 1.
If the value is very large, such as 1,000, and there are 1,000 or more matches, all names are returned and performance is greatly reduced. If the value is low, such as 10, users typing a generic name might not see all matches.
directory.user.synchTask.enabled
Enables or disables the synchronization task for users. The default is true
The synchronization task runs automatically in the background, synchronizing user information in the Files database with the Lotus Connections user It queries the user with the ID and when it finds a match it synchronizes information such as login ID, display name, and e-mail address.
directory.user.synchTask.frequencyInMins
Frequency that the synchronization task runs, in minutes.
The value must be greater than or equal to 1.
The synchronization task runs automatically in the background, synchronizing user information in the Files database with the Lotus Connections user It queries the user with the ID and when it finds a match it synchronizes information such as login ID, display name, and e-mail address.
The task runs on any user information older than the value specified in theuser.synchTask.maximumDataAgeInHours property. It runs at a frequency specified in theuser.synchTask.frequencyInMins property. It pauses between users for the amount of time specified in theuser.synchTask.pauseInMillis property.
Adjust this property to speed up or slow down the process of synchronizing user information.
directory.user.synchTask.maximumDataAgeInHours
Number of hours that user information can remain in the Files database before the synchronization task can run on it.
The value must be greater than or equal to 0.
The synchronization task runs automatically in the background, synchronizing user information in the Files database with the Lotus Connections user It queries the user with the ID and when it finds a match it synchronizes information such as login ID, display name, and e-mail address.
The task runs on any user information older than the value specified in theuser.synchTask.maximumDataAgeInHours property. It runs at a frequency specified in theuser.synchTask.frequencyInMins property. It pauses between users for the amount of time specified in theuser.synchTask.pauseInMillis property.
directory.user.synchTask.pauseInMillis
Number of milliseconds that the synchronization task should wait before updating the next user's information. Use this to set small time between synchronizing items in the queue to avoid overloading your user as the task runs.
The value must be greater than or equal to 0.
The synchronization task runs automatically in the background, synchronizing user information in the Files database with the Lotus Connections user It queries the user with the directory ID and when it finds a match it synchronizes information such as login ID, display name, and e-mail address.
The task runs on any user information older than the value specified in the directory.user.synchTask.maximumDataAgeInHours property. It runs at a frequency specified in theuser.synchTask.frequencyInMins property. It pauses between users for the amount of time specified in theuser.synchTask.pauseInMillis property.
Zero is an acceptable value if the remote user can handle many simultaneous queries.
download.modIBMLocalRedirect.enabled
Specifies whether the IBM HTTP Server serves downloaded files instead of the WebSphere Application Server redirect servlet.
You can configure Lotus Connections to have the IBM HTTP Server download files. This is strongly recommended in production environments.
If this property is set to true
, also specify a URL in the download.modIBMLocalRedirect.hrefPathPrefix property. If the property is set to
false, the WebSphere Application Server redirect servlet downloads files.
To see information and steps for configuring the IBM HTTP Server to download files, see the topic Configuring Files and Wikis downloading for production deployments.
download.modIBMLocalRedirect.hrefPathPrefix
Path to the file system where Files data is stored. The file path should not include a trailing slash.
This is only relevant if the download.modIBMLocalRedirect.enabled property is true
To see more information and steps for configuring the IBM HTTP Server to download files, see the topic Configuring Files and Wikis downloading for production deployments.
download.stats.logging.enabled
Level of detail to log about file downloads. If true
, the Files feature logs detailed download statistics, including the names of authenticated users who download files, and the version they most recently downloaded. If
false, the features only log the number of times a file is downloaded.
Specify true
for a better user experience and auditing.
emailNotification.addOnMediaDownload.enabled
Specifies whether to send e-mail notification to users who download a file when the file is edited.
The download.stats.logging.enabled property must be true
for this to work.
file.attachment.maximumSizeInKb
Does not apply to Files. Files does not have attachments, the value in this property will not affect the feature.
file.media.maximumSizeInKb
Maximum size allowed for media, in kilobytes. In Files, media are files.
The value must be greater than or equal to 1.
This property is useful if you want a relatively large quota size for libraries, but you do not want users upload very large files, such as .iso files.
file.page.maximumSizeInKb
Does not apply to Files. Files does not have pages, the value in this property will not affect the feature.
file.softDelete.actuallyDeleteTask.enabled
Enables or disables the delete files task. The default is true
The task deletes files if they are marked as pending deletion, and they are older than the value specified in the file.softDelete.minimumPendingTimeInMins property.
file.softDelete.actuallyDeleteTask.frequencyInMins
Frequency that the delete files task runs, in minutes.
Files are deleted if they are marked as pending deletion, and they are older than the value specified in the file.softDelete.minimumPendingTimeInMins property.
file.softDelete.minimumPendingTimeInMins
Number of minutes that files must be in the pending deletion queue before the delete files task will delete them. For example, the default value of 720 means they will be deleted if they have been in the pending deletion queue 720 or more minutes.
The value must be greater than or equal to 0.
More pending time allows users to finish downloads of files added to the pending deletion queue. It also allows looser online back up policies. For example, for online backups that take less than this number of minutes you do not need to pause the file deletion task. To see more information about pausing the file deletion task during backups, see the topic Backing up data.
file.storage.rootDirectory
Path to the file system where Files data is stored. This can be set during installation and be different for each node in a cluster. If a is specified in during installation this value (a variable by default) is populated by the WebSphere Application Server. However, you can specify any
Lotus Connections looks for a /files and a /temp below this If they are not there they are created. The /temp stores data while the data is uploaded or virus scanned (if enabled). The /files contains the binary data that must be backed up.
For more information on backing up data, see the topic Backing up data.
file.versioning.enabled
Specifies whether file versioning is allowed. Specify true
or
false
If
false, the versioning interface does not display and the first version is always current. If you disable this after multiple versions of a file are created the latest version becomes the current and only version.
Note that new versions are created only when content changes, not title or tags or other metadata.
Specify
falseto simplify and reduce data storage.
See the topic Disabling file versioning.
metrics.collectionTask.enabled
Specifies whether to collect metrics. Specify true
or
false
See the topic Files administrative commands for MetricService commands you can use to access metrics.
The collection task runs near midnight in the server timezone, so all of the date-based metrics include data from most of a given day. Metrics entries only require a few kilobytes per day, so there is little performance impact to enabling them.
publicMedia.maximumResults
Maximum number of files displayed in public views. For example, the default setting of 1000 means public views can only have 1000 files. Adjust this property to improve performance.
The value must be greater than or equal to 100.
search.seedlist.clearDeletionHistoryTask.enabled
Specifies whether to run the clear deletion history task. This task removes delete records older than the number of days specified in the search.seedlist.maximumIncrementalQuerySpanInDays property.
search.seedlist.clearDeletionHistoryTask.frequencyInMins
Number of minutes between executions of the clear deletion history task. The task removes delete records older than the number of days specified in the search.seedlist.maximumIncrementalQuerySpanInDays property.
The value must be greater than or equal to 1.
search.seedlist.maximumIncrementalQuerySpanInDays
Number of days that deletion records are saved before they are eligible to be deleted by the clear deletion history task.
The value must be greater than or equal to 1.
Files keeps records of deleted files. These records are eligible to be deleted by the clear deletion history task after the number of days specified in this property. The incremental search crawler needs these deletion records to update the search index. If the records are deleted before the incremental crawler reads them, updates will be incomplete. This is not allowed, so Files performs a full crawl instead of an incremental crawl. Full crawls delete the existing search index and create a new one, which is more time consuming than incremental crawls.
To avoid frequent full crawls, make sure that this value is higher than the span of days between incremental crawls. For example, if incremental crawls happen every four days, make sure this value is higher than 4. This ensures that incremental crawls capture all deletion records.
search.seedlist.maximumPageSize
Maximum number of items on search return page. The value must be greater than or equal to 100.
security.logout.href
Logout URL for single-sign on solutions that require their own logout page.
If you are configuring Lotus Connections to work with Tivoli Access Manager, specify the following value:/files/ibm_security_logout?logoutExitPage=<url>, where <url> is the Tivoli Access Manager junction URL (this is usually the host name of the server).
For more information, see the topic Enabling single sign-on for Tivoli Access Manager.
tagging.updateFrequencyTask.enabled
Specifies whether to run the tag frequency update task. This task finds the most frequently used tags in public files updates the public files tag cloud.
tagging.updateFrequencyTask.frequencyInMins
Number of minutes between tag frequency data updates. This task finds the most frequently used tags in public files and updates public tag clouds and the autocomplete lists that display when users type a tag name in the tag filter field. For example, it measures how often the tag
human-resourcesis used in public files and updates the cloud and lists accordingly.
The value must be greater than or equal to 1.
Updating tag frequency data is resource-intensive, so you may want to adjust this value as your deployment grows. In very small deployments 60 minutes is appropriate. In very large deployments, once per day is recommended. Only updating once per day in large deployments should not cause problems, since the 100 to 500 most-used tags do not change very often.
This property only affects public tags. Tag clouds for one person's set of files are updated in real time and are not affected.
The default value is 120 minutes.
Change configuration property values
Securing features from malicious attack
Related tasks
Configure Files and Wikis downloading for production deployments
Specify a separate file download domain
Enable single sign-on for Tivoli Access Manager
Lotus Connections configuration property values
Enable single sign-on for Tivoli Access Manager
Configure Files and Wikis downloading for production deployments
Related reference
Common configuration properties