User interface configuration parameters
Except in the favicon, the uploaded images are automatically resized to match the correct size. Most image formats, like jpg, png, etc., are allowed.
| Field / Property | Type | Description |
|---|---|---|
|
default.ui.context |
String |
The context of the application. By default, OpenKM comes with two user interfaces, the classic UI and KCenter. Values are: * For Classic UI use "/frontend/index" * For KCenter UI use "/kcenter/" /kcenter/ |
|
default.lang
|
String
|
Forces user interface language to a specific language. By default, this parameter is empty. The value is based on the international language code. en-GB |
|
security.mode.multiple
|
Boolean
|
Enables alternative security mode that allows the application to apply several changes simultaneously, and only one change is used each time. By default, the value is "false". After the parameter is changed, refresh the browser to take effect. false |
|
logo.favicon |
String |
Website icon. |
|
logo. login
|
String
|
Login page logo. Automatically it tries to resize the image to 316px × 74px ( suggested background #F1F3F5 ). |
|
logo. mobile |
String
|
Mobile logo. Automatically it tries to resize the image to 161px × 38px ( suggested background #F1F3F5 ). |
|
logo. report
|
String
|
Reports logo. Automatically it tries to resize the image to 150px × 35px ( suggested background #FFF000 ). |
|
logo.tiny |
String |
A small logo is used at the top right of the OpenKM user interface. |
|
text.banner
|
String
|
Text is shown at the top of the logo on the landing page. Automatically it tries to resize the image to 51px x 13px ( suggested background #E5E5E1 ). |
|
text.title
|
String
|
Browser title. This text is set between ${text.title} html tags. |
|
text.welcome
|
String
|
Text is shown in the login table on the landing page. Welcome to OpenKM! Use a valid username and password to access OpenKM user Desktop. |
|
thumbnail.size.lightbox
|
String
|
Maximum size - width * height - of the lightbox thumbnail. 640x640> |
|
thumbnail.size.properties
|
String
|
Maximum size - width x height - of the thumbnail in the properties view. 280x280> |
|
thumbnail.size.search
|
String
|
Maximum size - width x height - of the thumbnail in search view. 180x180 |
|
keep.session.alive.interval
|
Integer
|
Some administration tasks take a long time, like the repository checker and rebuilding Lucene indexes; these can cause the user session to be lost. For this reason, these type of operations is forced to maintain the session alive. By default is set to 5 minutes. 5 |
|
schedule.session.keepalive
|
Integer
|
The user interface uses it to maintain the browser connected to OpenKM even when a user stays without performing any operation. For this reason, it should never be lower than the server session timeout ( by default, set to 15 minutes ). By default is set to 5 minutes. 5 |
|
schedule. dashboard.refresh
|
Integer
|
The application periodically does some operations like refreshing the dashboard panel to get newly imported emails, getting repository news, or showing the latest documents created by other users. The time set for the period between the dashboard panel will be refreshed. 15 |
|
schedule.ui.notification
|
Integer
|
The user receives a notification with a popup. The time - in minutes - indicate the period used by the application looking for new messages in the server. 1 |
|
system.previewer
|
Select
|
The application can preview documents by using the "flexpaper" or "zviewer" tool. By default, flexpaper previewer is enabled. flexpaper |
|
download.zip.live.max.files
|
Integer
|
Sets the maximum number of files allowed to download in live mode. Once this number is exceeded, the application will notify the user that the ZIP creation will be executed in background mode. And after it is finished, it will notify the user - by mail - with a download URL. Value 0 indicates an unlimited number of files. Downloading a couple of selected files and folders can take time. The application on the server side creates a temp folder where all data is packed as a ZIP file and then forwarded to the end user interface. 100 |
|
download.zip.live.max.file.size
|
String
|
Sets the maximum size of all files allowed to download in live mode. Exceeded this size, the application will notify the user that the ZIP creation will be executed in background mode. After it is finished, it will notify the user via mail with a download URL. Value 0 indicates unlimited size. Indicates size units with KB, MB, GB, or TB; otherwise, the value will be considered bytes. Downloading a couple of selected files and folders can take time. The application on the server side creates a temp folder where all data is packed as a ZIP file and then forwarded to the end user interface. 100MB |
|
min.search.characters |
Integer |
Sets the minimum characters required to execute a search. With fewer characters, the search button will not be enabled. 3 |
|
custom.header.height |
Integer |
Sets the height reserved at the top of the user interface for a customized horizontal banner. 0 |
|
custom.header.source |
String |
Sets the relative path of the custom header. When this parameter is not empty, and the parameter "custom.header.height" value is greater than 0, will be shown a horizontal section at the top of the user interface with the content set in this url. /OpenKM/custom/header.jsp |
|
custom.login |
String |
Changes the default login screen with your own. /custom/login.jsp |
|
force.reset.chat.when.login |
Boolean |
When enabled, force to log out of the chat when loading. This parameter is useful for users who are not logging out correctly of the application and leaving the chat session alive or when users are working with the application in several browser tabs simultaneously. true |
|
ask.drag.and.drop.updates |
Boolean |
Deprecated parameter. OpenKM version 7.1.21 is replaced by a configuration parameter in the Profiles. Ask the user in a drag-and-drop operation if existing files should be updated. false |
|
drag.and.drop.enabled |
Boolean |
This parameter can enable or disable drag and drop in the file browser. true |
