Administration guide

OpenKM provides easy access to the application configuration using the "Administration Tab" located in 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 top right corner of the system toolbar.

Administration layout:

Toolbar

Featured horizontal menu

 

 

Featured area

 

 

 

OpenKM administration provides access to:

IconNameDescription

Home

Administration landing page. The following are shown:

  • Application version.
  • Installation UUID.

Configuration parameters

Almost all configuration parameters are set here.

Changes made here affect the entire application.

Mime types

All registered document MIME types that OpenKM understands are listed here. You can modify, remove, or add a new one.

Statistics

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

Metadata

Creates, modifies, or removes metadata definitions.

Authentication

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 connects to LDAP only in read-only mode.

Profile

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

Relations

Creates, modifies, or removes node relation types.

User interface styles definition

Modifies the CSS used by the user interface.

Reports

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.

Automation Sets automatic tasks based on application events, such as DOCUMENT_CREATION.
Crontab

Adds or removes scheduled crontab tasks. The application uses these tasks to perform actions such as indexing documents and antivirus analysis.

Languages

Add, modify, or remove languages and manage translations.

Utilities

A collection of advanced utilities:

  • Admin permissions.
  • Cache Stats.
  • Check email.
  • Check text extraction.
  • Clean conversion cache.
  • Create a support zip.
  • Database import.
  • Database query.
  • Hibernate stats.
  • LDAP search.
  • List indexes.
  • LogCat.
  • Plugins
  • Profile stats.
  • Purge data.
  • Purge trash.
  • Rebuild indexes.
  • Repository checker.
  • Repository export.
  • Repository import.
  • Scripting.
  • System properties.

 

Table of contents [ Hide Show ]