User interface configuration parameters

The uploaded images - except in case of the favicon - are automatically resized to match the right size. Most image formats like jpg, png, etc  are allowed .

Field / PropertyTypeDescription

default.lang

 

String

 

Forces user interface language to a specific language. By default this parameter is empty. The value is based on international language code.

en-GB

security.mode.multiple

 

Boolean

 

Enabled alternative security mode that allows to apply several changes at same time. Only one change is applied 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 image to 316px × 74px ( suggested background #F1F3F5 ).

logo.mobile

String

 

Mobile logo.

Automatically it tries to resize image to 161px × 38px ( suggested background #F1F3F5 ).

logo.report

 

String

 

Reports logo.

Automatically it tries to resize image to 150px × 35px ( suggested background #FFF000 ).

logo.tiny

String

A small logo is used at the top right in OpenKM user interface.

text.banner

 

String

 

Text shown at top of the logo in the landing page.

Automatically it tries to resize 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 shown in the login table at the landing page.

Welcome to OpenKM !

Use a valid username and password to access to 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 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 repository checker and rebuild Lucene indexes, these can cause the user session to be lost. For this reason these type of operations are forced to maintain the session alive. By default is set to 5 minutes.

5

schedule.session.keepalive

 

Integer

 

It is used by the user interface to maintain the browser connected to OpenKM even when a user stays for some time without performing any operation. For this reason, it should never be lower than 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 new imported mails, getting repository news or showing latest documents created by other users among others. The time set the period between dashboard panel will be refresh.

15

schedule.ui.notification

 

Integer

 

 User receives notification with a popup. The time - in minutes - indicate the period used by application looking for new messages in server.

1

system.previewer

 

Select

 

The application can use "flexpaper" or "zviewer" tool to preview documents. 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 on background mode. And after finished will notify the user - by mail - with a download URL. Value 0 indicate unlimited number of files.

Downloading a couple of selected files and folders can take a lot of time. The application on the server side creates a temp folder where all data is packed as a ZIP file and then is 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 the ZIP creation will be executed on background mode. After it is finished, it will notice the user - by mail - with a download URL. Value 0 indicate unlimited size. Indicates size units with KB, MB, GB or TB, otherwise value will be considered as bytes.

Downloading a couple of selected files and folders can take a lot of time. The application on the server side creates a temp folder where all data is packed as a ZIP file and then is forwarded to the end user interface.

100MB

min.search.characters

Integer

Sets the minimum characters required to execute a search. With less 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 parameter "custom.header.height" value is greater than 0, will be shown an horizontal section at top of the user interface with the content set in this url.

/OpenKM/custom/header.jsp

custom.login

String

Changes default login screen with your own.

/custom/login.jsp

force.reset.chat.when.login

Boolean

When enabled force to logout the chat when loading. This parameter it's useful for users who are not logout correctly the application and leaving chat session alive or when users are working with the application in several browser tabs at the same time.

true