Administration guide

OpenKM provides easy access to the application configuration by means of the "Administration Tab" located on the administration system area. Relevant and useful information can be accessed to assist the administrator in controlling and configuring the OpenKM repository.

Only users with ROLE_ADMIN can access the administration area. A new tab Administration will appear to these users at the right top corner of the system toolbar.

Administration layout:


Featured horizontal menu



Featured area




OpenKM administration provides access to:



Administration landing page. Here is shown:

  • Application version.
  • Installation UUID.

Configuration parameters

Almost all configuration parameters are set here.

With the multi-tenant module enabled it is possible to set different properties depending on the tenant.

Changes done here affect the entire application.

Mime types

All registered document MIME types which OpenKM understands. You can modify, remove or add new ones.


Shows information about the repository size. You can also check the evolution of the Pending task queue and Pending extraction queue.


Creates, modifies or removes metadata definitions.


Creates, modifies or removes users and roles.

When the application is configured to connect to LDAP, these values can only be changed on the LDAP server because OpenKM connect to LDAP in read only mode.


A profile is a specific set of configurations for the user interface.


Creates, modifies or removes node relation type.

User interface styles definition

Modifies the CSS used by the user interface.


Adds, removes or executes application reports.

Activity log

User actions are registered in the OpenKM activity log.

All activity log data is stored in the OKM_ACTIVITY table.

Wofkflow Add, remove or view status of registered workflows.
Automation Sets automatic tasks based on application events such as DOCUMENT_CREATION, among others.

Set text or image stamp definitions.

This option is hidden when the extension is not enabled. Read about it at Enable extensions.

Document expiration

Set users and roles involved with the document expiration process.

This option is hidden when extension is not enabled. Read about it at Enable extensions.


Add or remove scheduled crontab tasks. The application uses these tasks to perform actions like indexing documents and antivirus analysis, among others.

OMR (Object Mark Recognition)

Sets Object Mark Recognition parameters.

OCR templates

Sets OCR template definitions to automate document data capture.

Folder styles definion

Add, modify or remove folder styles definitions.


Add, modifie or remove languages and manage translations.


A collection of advanced utilities:

  • Admin permissions.
  • Cache Stats.
  • Check e-mail.
  • Check text extraction.
  • Clean conversion cache.
  • Database query.
  • Execute JAR.
  • Download tokens.
  • Hibernate stats.
  • LDAP search.
  • List indexes.
  • LogCat
  • Plugins
  • Profile stats.
  • Purge permissions.
  • Purge trash.
  • Rebuild indexes.
  • Repository checker.
  • Repository export.
  • Repository import.
  • Repository view.
  • Scripting.
  • System properties.
  • Terminal.
  • Thesaurus.