Skip to content
›
OpenKM 6.3 CE
Search
Ctrl
K
Cancel
Other versions
Loading…
Select theme
Dark
Light
Auto
Select language
English
Español
Hardware and software requirements
Hardware and software requirements
Thirdparty software requirements
Installation
Installation
Installing on Ubuntu and Debian (Manual)
Installing on RedHat and CentOS (Manual)
Installing on Windows
Using the installer
Installing on a pristine Tomcat
Using Docker
Database
Database
Configuring MySQL and MariaDB
Configuring MySQL and MariaDB
MySQL tuning
Change MySQL data directory
MySQL 8 throubleshooting
Configuring Oracle
Configuring PostgreSQL
Configuring SQL Server
Configuring other databases
Backup and restore
Backup and restore
Linux backup and restore with BorgBackup
Linux backup and restore with rdiff-backup tool
Linux backup and restore with Duplicity
Linux backup and restore with rsync
Linux backup with LFTP
Instance replication
Setup
Setup
Antivirus configuration
Cleaning older activity log data
Configuring Apache HTTP Reverse-Proxy
Configuring Apache HTTP for changing context URL
Configuring Apache HTTPS Reverse-Proxy
Configuring Nginx HTTP Reverse-Proxy
Configuring Lucene Analyzer
Configuring OCR engine
Configuring OpenSSL
Configuring SWFTools
Configuring mail
Configuring Tomcat memory utilization
Configuring Tomcat port
Configuring Tomcat session timeout
Configuring Tomcat timezone
Configuring Tomcat to work behind an Internet proxy
Change repository home
Change default role names
Enable extensions
Enable WebDAV
LDAP configuration
LDAP configuration
OpenLDAP example with URL base at login
OpenLDAP example retrieving attributes by name
Active Directory example with referral enabled
Active Directory example with login based on filtering users by roles
Active Directory basic configuration
Active Directory advanced configuration
LDAP best practices for filtering users and roles
ClearOS LDAP configuration
LDAP troubleshooting
Log configuration
LibreOffice configuration
Security configuration
Cache configuration
Troubleshooting
Troubleshooting
Server configuration
Client configuration
Browser configuration
Best practices reporting issues
Administration guide
Administration guide
Configuration parameters
Configuration parameters
Recommended configuration parameters
Preview parameters
LDAP configuration parameters
User interface configuration parameters
Workflow configuration parameters
Notification configuration parameters
Document version numeration configuration
Password validation configuration
Switch application to read-only mode
Security configuration parameters
Extensions configuration parameters
Performance configuration parameters
OpenOffice LibreOffice configuration parameters
WebDAV configuration parameters
CSV configuration parameters
Other configuration parameters
Experimental configuration parameters
AutoCAD configuration parameters
Thesaurus configuration
Datastore
MIME types
Statistics
Scripting
Metadata
Metadata
Metadata XML definition
Metadata XML definition
Metadata fields
Metadata fields
Metadata Checkbox field
Metadata Select field
Metadata Separator field
Metadata Suggestbox field
Metadata Text field
Metadata TextArea field
Metadata Validator element
Metadata Option element
Metadata Input field
Manage users and roles
Manage users and roles
Manage users
Manage users
Manage user mail accounts
Manage roles
Logged users
Message queue
Profiles
Profiles
Profile General tab
Profile Components tab
Profile Menu tab
Profile Other tab
Database query
Reports
Reports
Reports pack
Activity log
Workflow
Workflow
Workflow forms definition
Workflow forms definition
Workflow fields
Workflow fields
Workflow Button field
Workflow Download field
Workflow Validator element
Workflow Node element
Workflow Upload field
Workflow Print field
Workflow Checkbox field
Workflow Input field
Workflow Select field
Workflow Separator field
Workflow Suggestbox field
Workflow Text field
Workflow TextArea field
Workflow Option element
Automation
Automation
Built-in Automation Validator plugins
Built-in Automation Action plugins
Enable Automation validations
Enable Automation actions
Crontab
Crontab
Built-in crontab tasks
OMR templates
Thesaurus
Languages
Languages
Language translations
How to create a new translation
Repository import
Repository export
Utilities
Utilities
Cache stats
Check email
Check text extraction
CSS
Hibernate stats
List indexes
LogCat
Plugins
Profiling stats
Purge data
Rebuild indexes
Repository checker
Repository view
System properties
User guide
User guide
Quick start
Essential fundamentals
Plan your data organization
Working with the menu bar
Working with the toolbar
Working with desktop
Working with search
Working with the dashboard
Working in status bar
Bulk Uploader
HTML editor extension
Extra tab workspace extension
External tab document extension
External tab folder extension
External tab mail extension
Forum extension
Wiki extension
Stapling extension
Using OpenKM from external applications
Using OpenKM from external applications
Microsoft Office Add-in
Digital signature client
Scanner client
Desktop importer tool
Update guide
Update guide
Changelog
Tomcat update
How to switch between databases
Migrating from 6.3.12 to 6.3.13
Migrating from 6.3.11 to 6.3.12
Migrating from 6.3.10 to 6.3.11
Migrating from 6.3.9 to 6.3.10
Migrating from 6.3.8 to 6.3.9
Migrating from 6.3.7 to 6.3.8
Migrating from 6.3.6 to 6.3.7
Migrating from 6.3.5 to 6.3.6
Migrating from 6.3.4 to 6.3.5
Migrating from 6.3.3 to 6.3.4
Migrating from 6.3.2 to 6.3.3
Migrating from 6.3.1 to 6.3.2
Migrating from 6.3.0 to 6.3.1
Migrating from 6.2.6 to 6.3.0
Development
Development
Personal development environment
Configuring IDE from a clean Eclipse
Configuring Maven in your OS
Checkout source code from Git
Checkout source code from Subversion
Eclipse tips
Eclipse known troubleshooting
Development tips
Profiling application
Application version compatibility table
Creating a JAR file with Eclipse
Creating plugins
Creating plugins
Register a new plugin
Creating your own Automation Action
Creating your own Automation Validation
Creating your own Text extractor
Creating templates
Creating templates
Creating LibreOffice templates
Creating PDF template
Creating Text templates
Creating your own Automation Action ( deprecated )
Creating your own Automation Validation ( deprecated )
Creating your own database tables
Creating your own database tables
Use your own database table from Java
Use your own database table from frontend ( GWT )
Creating your own Crontab job
Creating your own login module
Creating your own parameters
Creating your own password validator
Creating your own Principal Adapter
Creating your own thesaurus
Creating your own Suggestion Analyzer
Creating your own Text extractor ( deprecated )
Creating your own reports
Creating your own reports
Introducing to reports based on SQL
Introducing to reports based on Java
Reports with parameters
Reports with parameters
Params form fields
Params form fields
Params fields
Params fields
Params Validator element
Params Input field
Params Suggestbox field
Params Checkbox field
Params TextArea field
Params Select field
Params Separator field
Params Text field
Creating your own Version Number Adapter
Database stuff
Webservices
Webservices
CMIS
RESTful
RESTful
Swagger
SOAP
Extending frontend UI
Extending frontend UI
Frontend UI hello world sample
Frontend UI extensions
Frontend UI extensions
Widget library
TabWorkspaceExtension
TabWorkspaceExtension
WorkspaceHandlerExtension
WorkspaceComunicator
TabDocumentExtension
TabDocumentExtension
DocumentHandlerExtension
TabDocumentComunicator
TabFolderExtension
TabFolderExtension
FolderHandlerExtension
TabFolderComunicator
TabMailExtension
TabMailExtension
MailHandlerExtension
TabMailComunicator
ToolBarBoxExtension
ToolBarBoxExtension
DashboardHandlerExtension
ToolBarComunicator
ToolBarButtonExtension
ToolBarButtonExtension
ToolBarHandlerExtension
MenuBarExtension
MenuItemExtension
General HandlerExtension stuff
General Comunicator stuff
UI constants
Frontend UI extensions stuff
Complete frontend extension sample
Using iframe for extending frontend UI
Exposed frontend JavaScript API
Samples
Samples
Scripting samples
Scripting samples
Script - Basic samples
Script - Cognitive PDF/A
Script - Compact documents with size equals to 0
Script - Count all children subfolder
Script - Exporter
Script - Export repository folder to server as a ZIP file
Script - Folders deep
Script - Generate database script
Script - Import data from CSV file
Script - Import reports from a folder
Script - Purge all folders into some parent
Script - Purge all users trashes
Script - Put documents from folder and descendants into pending text extraction queue
Script - Recursive character renaming
Script - Recursive repository traversal
Script - Recursive change security
Script - Security change at low level
Script samples for automation
Script samples for automation
Script for automation - Autonumeric
Script for automation - Execute OMR
Script for automation - Set unique document name based on metadata
Script for automation - Simple auto tagging
Crontab samples
Crontab samples
Crontab sample - Basic file system document importer
Crontab sample - Document importer with metadata values
Script - Correct security in personal nodes
PHP SOAP Webservices samples
PHP SOAP Webservices samples
PHP SOAP Webservices samples - Automatic import
PHP SOAP Webservices samples - Download a file
PHP SOAP Webservices samples - File upload
Crontab task - XML importer
Vault of stuff
Vault of stuff
Convert Exchange Legacy DN
Download document with direct link
Import document with bash script using REST
Import document with bash script using SOAP
Creating users from scripts
API description
API description
OKMAuth
OKMBookmark
OKMDashboard
OKMDocument
OKMFolder
OKMMail
OKMNote
OKMNotification
OKMProperty
OKMPropertyGroup
OKMRepository
OKMSearch
OKMStats
OKMUserConfig
OKMWorkflow
Common classes
Common classes
ArchiveUtils
DbSessionManager
ExecutionUtils
FileLogger
FileUtils
FormatUtil
ISO8601
LegacyDAO
MailUtils
PathUtils
PDFUtils
PrincipalUtils
StackTraceUtils
TemplateUtils
WorkflowUtils
Database description
Select theme
Dark
Light
Auto
Select language
English
Español
Migrating from 6.3.1 to 6.3.2
Preliminars
Section titled “Preliminars”
Make a backup!!!
Migration
Section titled “Migration”
Stop Tomcat
Edit OpenKM.cfg and set
hibernate.hbm2ddl
to
update
Replace the OpenKM.war
And start Tomcat again.