Wikis configuration properties

Wikis configuration properties
Configuration properties control how and when various Wikis operations take place, and also help in the optimization of server performance. They require a Wikis server restart to take effect.
The following are configuration properties in the wikis-config.xml file 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.

activeContentFilter.enabled
Specifies the mime types that are scanned and scripts removed from wiki pages when they are viewed.
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 applications from malicious attack.

api.indent.enabled
Specifies whether the Wikis 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.
Note:
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 Wikis view. You may want to raise this value in very large deployments (for example, over 200,000 wikis) to avoid performance issues. It could also be lowered to have very up-to-date information in the public view.
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 email addresses. Use this property to control the frequency of requests to the Wikis 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 after user login. Only applicable if Community Wikis 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 Wikis 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 in directory.community.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 Wikis 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 Wikis 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 of directory.community.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 group membership cache is refreshed after user login. 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 Wikis 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 in directory.group.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 Wikis 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 of directory.group.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.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 1000, and there are 1000 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.

download.modIBMLocalRedirect.enabled
Specifies whether the IBM HTTP Server serves downloaded files instead of the WAS redirect servlet.
You can configure IBM 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 WAS redirect servlet downloads files.
To see information and steps for configuring the IBM HTTP Server to download files, see the topic Configure Files and Wikis downloading for production deployments.

download.modIBMLocalRedirect.hrefPathPrefix
Path to the file system directory where Wikis 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 information and steps for configuring the IBM HTTP Server to download files, see the topic Configure Files and Wikis downloading for production deployments.

download.stats.logging.enabled
Level of detail to log about page views. If false (the default), Wikis only logs the number of times a page is viewed. If true, Wikis logs the names of authenticated users who view pages.
Specify true for a better user experience and auditing.

file.attachment.maximumSizeInKb
Maximum size allowed for file attachments, in kilobytes.
The value must be greater than or equal to 1.
Attachments larger than this setting will fail to upload and return an error to users. Use this to restrict users from uploading files that will negatively affect your system environment.
After changing this value, the maximum size limit will not change for users until their browser cache is refreshed. You can force a refresh by running a command to update the product version stamp. See the topic Required post-customization step for more information on forcing a browser cache refresh.

file.media.maximumSizeInKb
Maximum size allowed for media, in kilobytes. In Wikis, media are wiki pages.
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 attach very large files, such as .iso files.
After changing this value, the maximum size limit will not change for users until their browser cache is refreshed. You can force a refresh by running a command to update the product version stamp. See the topic Required post-customization step for more information on forcing a browser cache refresh.

file.page.maximumSizeInKb
Maximum size allowed for wiki pages, in kilobytes. Since pages are a type of media, this value must be less than or equal to the maximum size set in the file.media.maximumSizeInKb property.
The value must be greater than or equal to 1.
Pages larger than this setting will fail to upload and return an error to users. Use this to restrict users from uploading files that will negatively affect your system environment.
After changing this value, the maximum size limit will not change for users until their browser cache is refreshed. You can force a refresh by running a command to update the product version stamp. See the topic Required post-customization step for more information on forcing a browser cache refresh.

file.restrictions.enabled
Enables or disables the ability to restrict the types of files that users can upload as attachments in Wikis. Accepts the values true or false.
To see information and steps for restricting file types, see the topic Restricting attachment file types in Wikis.

file.restrictions.mode
Sets the mode for file extension restrictions. Accepts the values allow or deny. If the value is allow, then the list of file extensions are the only ones allowed to be uploaded as attachments. If the value is deny, then the list of extensions are not allowed, and all extensions not on the list are allowed.
For example:
<file>
 ....
 <restrictions enabled="true" mode="allow">
  <extensions>
   <extension>odt</extension>
   <extension>odp</extension>
   <extension>ods</extension>
  </extensions>
 </restrictions>
</file>
To see information and steps for restricting file types, see the topic Restricting attachment file types in Wikis.
file.storage.rootDirectory
Path to the file system directory where Wikis data is stored. This can be set during installation and be different for each node in a cluster. If a directory is specified in during installation this value (a variable by default) is populated by the WAS. However, you can specify any directory.
IBM Connections looks for a /files and a /temp directory below this directory. If they are not there they are created. The /temp directory stores data while the data is uploaded or virus scanned (if enabled). The /files directory 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 wiki page 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 page 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 false to simplify and reduce data storage.
See the topic Disable wiki page versioning.

scheduledTasks.DirectoryGroupSynch.args.maximumDataAgeInHours
Number of hours that group information can remain in the Wikis 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 Wikis database with the IBM Connections user directory. It queries the user directory 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 the scheduledTasks.DirectoryGroupSynch.args.maximumDataAgeInHours property. It runs at a frequency specified in the scheduledTasks.DirectoryGroupSynch.interval property. It pauses between groups for the amount of time specified in the scheduledTasks.DirectoryGroupSynch.args.pauseInMillis property.

scheduledTasks.DirectoryGroupSynch.args.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 directory 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 Wikis database with the IBM Connections user directory. It queries the user directory 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 the scheduledTasks.DirectoryGroupSynch.args.maximumDataAgeInHours property. It runs at a frequency specified in the scheduledTasks.DirectoryGroupSynch.interval property. It pauses between groups for the amount of time specified in the scheduledTasks.DirectoryGroupSynch.args.pauseInMillis property.
Zero is an acceptable value if the remote user directory can handle many simultaneous queries.

scheduledTasks.DirectoryGroupSynch.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 Wikis database with the IBM Connections user directory. It queries the user directory with the directory 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.

scheduledTasks.DirectoryGroupSynch.interval
Frequency with which the synchronization task runs.
This property accepts a chronological expression.*
The synchronization task runs automatically in the background, synchronizing group names in the Wikis database with the IBM Connections user directory. It queries the user directory 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 the scheduledTasks.DirectoryGroupSynch.args.maximumDataAgeInHours property. It runs at a frequency specified in the scheduledTasks.DirectoryGroupSynch.interval property. It pauses between groups for the amount of time specified in the scheduledTasks.DirectoryGroupSynch.args.pauseInMillis property.
Adjust this property to speed up or slow down the process of synchronizing group information.

scheduledTasks.FileActuallyDelete.args.softDeleteMinimumPendingTimeInMins
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.

scheduledTasks.FileActuallyDelete.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 scheduledTasks.FileActuallyDelete.args.softDeleteMinimumPendingTimeInMins property.

scheduledTasks.FileActuallyDelete.interval
Frequency with which the delete files task runs.
This property accepts a chronological expression.*
Wikis are deleted if they are marked as pending deletion, and they are older than the value specified in the scheduledTasks.FileActuallyDelete.args.softDeleteMinimumPendingTimeInMins property.

scheduledTasks.MetricsDailyCollection.enabled
Specifies whether to collect metrics. Specify true or false.
See the topic Wikis 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.

scheduledTasks.MetricsDailyCollection.interval
Frequency with which daily metrics collection task runs. Only the default is supported: the task can only run at midnight in the server timezone. Do not edit this property.

scheduledTasks.SearchClearDeletionHistory.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.

scheduledTasks.SearchClearDeletionHistory.interval
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.
This property accepts a chronological expression.*

scheduledTasks.TagUpdateFrequency.enabled
Specifies whether to run the tag frequency update task. This task finds the most frequently used tags in public wikis and updates the public wikis tag cloud.

scheduledTasks.TagUpdateFrequency.interval
Frequency with which the tag frequency update task runs. This task finds the most frequently used tags in public wikis and updates the public wikis tag cloud 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-resources is used on pages in public wikis and updates the cloud and lists accordingly.
This property accepts a chronological expression.*
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 individual wikis are updated in real time and are not affected.

search.seedlist.maximumIncrementalQuerySpanInDays
Number of days that deletion records are saved before they are eligible to be deleted by the SearchClearDeletionHistory task.
The value must be greater than or equal to 1.
Wikis keeps records of deleted files. These records are eligible to be deleted by the SearchClearDeletionHistory 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 Wikis 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 incremental crawls occur sooner than the time it takes for a deletion record to be created and deleted. For example, if deletion records are eligible for deletion after five days, specify that incremental crawls occur every four days.

search.seedlist.maximumPageSize
Maximum number of items on search return page. The value must be greater than or equal to 100.

security.inlineDownload.enabled
Enables inline display of file attachments. This is useful when you use the Wikis API to download and display active content, such as Adobe™ Flash (.swf) files, in your own HTML pages.
By default, the IBM Connections server passes Wikis application file attachments to browsers with the header "Content-Disposition: attachment." This means files display as attachments; when users click the attachment they are prompted to open or download the file. It also prevents embedding files. If you want to embed files in your own HTML page using an <embed> tag, the content disposition must be inline. This affects active content, such as Adobe Flash (.swf), and HTML pages referenced with <iframe>.
Configure a property in wikis-config.xml to change the content disposition from attachment to inline. Then set the inline parameter to true in your Wikis API download requests. See Displaying file attachments inline.
Important: Wikis uses the attachment disposition for security reasons. Specifically, uploaded files could potentially contain malicious code that can exploit the cross-site scripting vulnerabilities of some browsers. If you switch to inline disposition, you should configure an alternate domain download for greater security. See Mitigating a cross site scripting attack.
Accepted values are true and false.

security.logout.href
Logout URL for single-sign on solutions that require their own logout page.
If you are configuring IBM 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 Enable single sign-on for Tivoli Access Manager.
Note: You must use fully-qualified domain names in this configuration file. If you use an abbreviated name, secure communications between servers will fail.
For information on how to format the value of an interval attribute, see Scheduling tasks.

Parent topic
Change Wikis configuration property values
Related concepts
Securing applications from malicious attack

Related tasks

Specify a separate file download domain
Disable wiki page versioning
Enable single sign-on for Tivoli Access Manager
Configure Files and Wikis downloading for production deployments
IBM Connections configuration property values
Backing up Wikis data
Disable trash bin in Wikis
Required post-customization step
Restricting attachment file types in Wikis
Related reference
Common configuration properties
Wikis administrative commands

});

+
Search Tips | Advanced Search