Wikis configuration properties

Overview

Set Wiki properties in wikis-config.xml.

Configuration values, except for properties with multiple values, are always required. Enabled properties must have a Boolean value of either true or false. Number values must be integers.

After editing wikis-config.xml, apply the changes by restarting the application server hosting the Wikis application.

Properties

activeContentFilter.enabled

Mime types scanned, and scripts removed, from wiki pages when they are viewed.

Disabling this filter may leave the environment open to cross-site scripting attacks.

api.indent.enabled

Whether API output is indented. Indentation helps with development and debugging.

False by default because indentation affects performance.

api.tagFilter

Maximum number of tags allowed for filtering Wikis by tags. Default is 3. For performance reasons, a value greater than 10 is not recommended. Format:

<tagFilter maximumTags="n"/>

where n is the maximum number of tags.

cache.http.publicContentMaxAgeInSecs

Maximum age, in seconds, of the public content cache before it is refreshed. The cache stores static web resources, such as JavaScript and images. To show resource changes more quickly, reduce the value of this property. Must be greater than or equal to 0.

We can force a resource update by opening LotusConnections-config.xml, and setting the versionStamp property to any value. For example:

<versionStamp value="20130929.013427">

The token is included in most URLs and in URL caches. The new URL overrides the old version and refreshes the resources.

Some resources, including some images, do not use version stamps. If we edit these resources frequently, we can reduce the value to show changes more quickly. Otherwise, update the version stamp when wikis-config.xml is modified.

cache.http.publicFeedMaxAgeInSecs

Maximum age, in seconds, of the public feed cache before it is refreshed. Public feeds pass information to the Public Wikis view. To avoid performance issues in deployments with more than 200,000 wikis, increase this value. To maintain the latest information in the public view, decrease the value.

Must be greater than or equal to 0.

cache.user.timeout

Number of milliseconds that user objects stay in the user information cache, which stores metadata about users such as names and email addresses. Controls the frequency of requests to the Wikis database for user information.

Must be greater than or equal to 1.

If the value of user data changes while the update user task or commands for MemberSynch are running, the cache is invalidated.

db.dialect

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 the community membership cache is refreshed. Only applicable if Communities wikis and Communities integration are enabled.

Must be greater than or equal to 0.

Refreshing the cache is required so that a user has the same access to content as the community, but refreshing the cache affects performance. A short time interval between refreshes means the Wikis application is more up-to-date, but performance might be slower. A long interval between refreshes has less effect on performance, but users might not have immediate access to updated content.

If we reduce the value of this property, inform users that logging out and back in is the best way to refresh the cache. We can also increase the value of the property...

directory.community.membershipCache.maximumAgeOnRequestInSeconds

...so that frequent requests do not affect performance.

directory.community.membershipCache.maximumAgeOnRequestInSeconds

Number of seconds after an application request that the community membership cache is refreshed. Only applicable if Communities wikis and Communities integration are enabled.

Must be greater than or equal to 0.

Refreshing the cache is required so that a user has the same access to content as the community, but refreshing the cache affects performance. A short time interval between refreshes means the Wikis application is more up-to-date, but performance might be slower. A long interval between refreshes has less effect on performance, but users might not have immediate access to updated content.

If we reduce the value of this property, inform users that logging out and back in is the best way to refresh the cache. We can also increase the value of the property...

directory.community.membershipCache.maximumAgeOnRequestInSeconds

...so that frequent requests do not affect performance.

To improve performance, increase this value to 10 minutes or more.

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.

Must be greater than or equal to 0.

Refreshing the cache is required so that a user has the same access to content as the community, but refreshing the cache affects performance. A short time interval between refreshes means the Wikis application is more up-to-date, but performance might be slower. A long interval between refreshes has less effect on performance, but users might not have immediate access to updated content.

If we reduce the value of this property, inform users that logging out and back in is the best way to refresh the cache. We can also increase the value of...

directory.community.membershipCache.maximumAgeOnRequestInSeconds

...so that frequent requests do not affect performance.

Use this property to increase the number of seconds in directory.group.membershipCache.maximumAgeOnRequestInSeconds so that frequent requests do 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.

Must be greater than or equal to 0.

Refreshing the cache is required so that a user has the same access to content as the community, but refreshing the cache affects performance. A short time interval between refreshes means the Wikis application is more up-to-date, but performance might be slower. A long interval between refreshes has less effect on performance, but users might not have immediate access to updated content.

If we reduce the value of this property, inform users that logging out and back in is the best way to refresh the cache. We can also increase the value of...

directory.community.membershipCache.maximumAgeOnRequestInSeconds

...so that frequent requests do not affect performance.

To improve performance, increase this value to 10 minutes or more.

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 type-ahead results and search results when a user clicks Search.

Must be greater than or equal to 1.

If the value is 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, a user who enters a generic name might not see all matches.

Type-ahead is available for public pages but not for filtered pages that might appear in Owner, Editor, or Reader views.

download.modIBMLocalRedirect.enabled

Whether IBM HTTP Server, and not WebSphere Application Server, serves downloaded files. In a production environment, use IBM HTTP Server to serve downloaded files. If true, also specify a file path in the propety...

download.modIBMLocalRedirect.hrefPathPrefix

If false, the WAS redirect servlet downloads files.

download.modIBMLocalRedirect.hrefPathPrefix

Full path to the file system directory where Wikis data is stored. The file path must not include a trailing slash. This property is relevant only if...

download.modIBMLocalRedirect.enabled = true

If the property is set to false, the WAS redirect servlet downloads files.

download.stats.logging.enabled

Level of detail to log about page views. If the value is set to false, Wikis logs the number of times a page is viewed. If true, Wikis logs the names of authenticated users who view pages.

Specify true for auditing.

editor.wikitexttab.enabled

Whether the Wiki Text tab is enabled. Default is false. We can enable the Wiki Text tab by changing the value to true.

file.attachment.maximumSizeInKb

Maximum size, in KB, allowed for file attachments. Must be greater than or equal to 1.

Attachments that are larger than this setting fail to upload and return an error to users. To improve performance, use this property to restrict users from uploading large files. After changing this value, the maximum size limit does not change for users until their browser cache is refreshed. We can force a refresh by running a command to update the product version stamp.

file.media.maximumSizeInKb

Maximum size, in KB, allowed for media. In Wikis, media are wiki pages. 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 to attach large files. After changing this value, the maximum size limit does not change for users until their browser cache is refreshed. We can force a refresh by running a command to update the product version stamp.

file.page.maximumSizeInKb

Maximum size, in KB, allowed for wiki pages. Since wiki 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. Use this property to restrict users from uploading files whose size might affect performance. Must be greater than or equal to 1.

Pages that are larger than the value of this property return an error.

After changing this value, the maximum size limit does not change for users until their browser cache is refreshed. We can force a refresh by running a command to update the product version stamp.

file.restrictions.enabled

Enable or disable ability to restrict the types of files that users can upload as attachments in Wikis. Accepts the values true or false.

file.restrictions.mode

Mode for file extension restrictions. Accepts the values allow or deny. If the value is allow, the file extensions in the list are the only ones that users can upload as attachments. If the value is deny, the extensions are not allowed.

For example:

<file>
 ....
 <restrictions enabled="true" mode="allow">
  <extensions>
   <extension>odt</extension>
   <extension>odp</extension>
   <extension>ods</extension>
  </extensions>
 </restrictions>
</file>

file.storage.rootDirectory

Path to the file system directory where Wikis data is stored. This value can be set during installation and can differ for each node in a cluster. If the directory is specified during installation, this value is populated by WebSphere Application Server. However, we can specify a different directory.

IBM Connections looks for a files and a temp directory in the directory specified by this property. If the directories are not present, they are created. The temp directory stores data while the data is being uploaded or scanned for viruses. The files directory contains binary data files.

file.versioning.enabled

Whether wiki page versioning is allowed. Specify true or false. Default is true.

When this value is set to false, the versioning interface is not displayed and the first version is always current. If we disable this property after multiple versions of a page are created, the latest version becomes the current and only version.

New versions are created only when content changes, not when title or tags or other metadata changes.

To reduce data storage, specify false.

wikimacros.enabled

Whether macros are enabled in Wikis. We can use macros to automate common tasks, such as generating a table of contents in a wiki page.

The default value of this parameter is false. To enable macros, set the value to true. When enabled, macros are available from the Macros menu in the editor toolbar.

scheduledTasks.DirectoryGroupSynch.args.maximumDataAgeInHours

Number of hours that group information can remain in the Wikis database before the synchronization task runs. If groups are disabled, the synchronization task does not run.

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 user directory. The task 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 that is 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 the synchronization task must wait before it updates information for the next group. Use this property to add an interval between synchronizing items in the queue. This interval avoids overloading the user directory when the task runs. Does not run if groups are disabled.

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 user directory. The task 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 that is 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.

If the remote user directory can handle many simultaneous queries, we can enter 0 as the value.

scheduledTasks.DirectoryGroupSynch.enabled

Enable or disable 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 user directory. The task queries the user directory with the directory ID and when it finds a match it synchronizes the group name.

scheduledTasks.DirectoryGroupSynch.interval

Frequency of the synchronization task.

This property accepts a chronological expression.

The synchronization task runs automatically in the background, synchronizing group names in the Wikis database with the user directory. The task 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 that is 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 deletes them.

For example, the default value of 720 means that queued files are deleted when they are in the queue for 720 minutes or longer. Must be greater than or equal to 0.

A high value allows users to finish downloading large files. It also allows more lenient online backup policies. For example, for online backups that take fewer than this number of minutes, you do not have to pause the file deletion task.

scheduledTasks.FileActuallyDelete.enabled

Enable or disable delete files task. The default is true.

This task deletes files if they are marked as pending deletion, and they are older than the value specified in the property...

scheduledTasks.FileActuallyDelete.args.softDeleteMinimumPendingTimeInMins

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 property...

scheduledTasks.FileActuallyDelete.args.softDeleteMinimumPendingTimeInMins

scheduledTasks.MetricsDailyCollection.enabled

Whether to collect metrics. The values are true and false. Default is true.

The collection task runs near midnight in the server time zone so that all of the date-based metrics include data from that day. Metrics entries require only a few KB per day, therefore the performance impact is low.

scheduledTasks.MetricsDailyCollection.interval

Frequency with which the daily metrics collection task runs. Only the default value is supported: the task can run only at midnight in the server time zone. Do not edit this property.

scheduledTasks.TagUpdateFrequency.enabled

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.

This property accepts a chronological expression.

Updating tag frequency data is resource-intensive, so you might want to adjust this value as the deployment grows. In small deployments, 60 minutes is appropriate. In large deployments, once per day is sufficient.

This property affects public tags only. 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.

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, the updates are incomplete. For this reason, Wikis runs a full crawl instead of an incremental crawl. Full crawls delete the existing search index and add a new one. This process takes more time 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 the seedlist return page. Must be greater than or equal to 100.

security.inlineDownload.enabled

Enable the inline display of file attachments. Setting this property is useful when we use the Wikis API to download and display active content, such as Adobe Flash (.swf) files, in our own HTML pages.

By default, IBM Connections passes file attachments to browsers with the Content-Disposition: attachment header. This specification means that files are displayed as attachments. When users click the attachment, they are prompted to open or download the file. Enable this property also prevents the embedding of files. To embed files in our own HTML page by using an embed tag, the content disposition must be inline. This property affects active content such as Adobe Flash (.swf), and HTML pages referenced within an 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 the Wikis API download requests.

Wikis uses the attachment disposition for security reasons. Specifically, uploaded files can potentially contain malicious code that can exploit the cross-site scripting vulnerabilities of some browsers. If we switch to inline disposition, configure an alternative download domain for greater security.

The allowed values are true and false.

security.logout.href

Logout URL for single-sign on solutions that require their own logout page. If we are configuring IBM Connections to work with Tivoli Access Manager, specify the following value:

/wikis/ibm_security_logout?logoutExitPage=<url>

where <url> is the Tivoli Access Manager junction URL. This URL is usually the host name of the server.

We must use fully qualified domain names in the configuration file. If short names are used, secure communication between the servers fails.


Parent topic:
Change Wikis configuration property values


Related:
Secure applications from malicious attack
Specify a separate file download domain
Disable wiki page versioning
Enable single sign-on for Tivoli Access Manager
Configure file downloads through IBM HTTP Server
Back up Wikis data
Required post-customization step
Restricting attachment file types in Wikis
Common configuration properties
Wikis administrative commands