Skip to content

Other configuration parameters

Property Type Description
spring.jpa.properties.hibernate.search.analyzer String This parameter is used to change the default Apache Lucene Search Engine Analyzer.
org.apache.lucene.analysis.standard.StandardAnalyzer
More information at Configuring Lucene Analyzer.
This parameter must be set in the $TOMCAT_HOME/openkm.properties file.
spring.jpa.properties.hibernate.search Boolean This parameter can be used to disable Hibernate Search completely. This means you won’t be able to search documents or folders.
This parameter must be set in the $TOMCAT_HOME/openkm.properties file.
system.ocr.rotate String This parameter forces OCR to process rotated documents.
The feature is useful, for example, in upside-down scanned pages, where the standard OCR direction will fail.
The parameter is a collection of degrees separated by the character “;”.
90;180;270;
More information at Configuring OCR engine.
system.ocr.spell.check Boolean When enabled, the text extracted by OCR is validated by a spell checker.
The application must have an enabled dictionary; see the parameter “system.openoffice.dictionary” in the LibreOffice configuration parameters.
system.document.name.mismatch.check Boolean This parameter is used to enable or disable the name check when a new version of a document is uploaded.
max.search.results Integer This parameter sets the limit for search results. For example, a value of 500 means you will never get more than 500 results from any query.
500
The reason the number of results is limited is that some queries can retrieve a huge number of results, especially when the queries are done across API methods.
system.keyword.lowercase Boolean This parameter is used to force all keywords to lowercase.
The application is case sensitive; that means a user can set two keywords like “keyone” and “KeyOne”, and to the application these two keywords are distinct. To prevent this problem, it is always a good idea to force all keywords to lowercase.
tomcat.connector.uri.encoding String By default Tomcat Connector encoding is set to “ISO-8859-1” but you can change it with this parameter.
When you set the “URIEncoding” parameter in Tomcat to “UTF-8”, you also need to set this parameter to “UTF-8”.
<br>URIEncoding="UTF-8"<br>
ISO-8859-1
mail.session.debug Boolean Enable mail session debugging. It’s useful for detecting problems when the application is not sending mail.
mobile.theme String There are five mobile themes (“a”, “b”, “c”, “d”, “e”).
More information about themes at jQuery mobile themes.
b
plugin.debug Boolean When enabled, shows debug information about the application plugin feature.
principal.hide.connection.roles Boolean Hide “ROLE_USER” and “ROLE_ADMIN” roles from the available roles list.
By default the hidden roles are set by the values of the “default.user.role” and “default.admin.role” parameters. Usually “ROLE_USER” and “ROLE_ADMIN”.
principal.database.filter.inactive.users Boolean Deprecated since version 8.1.12
Hide inactive users from the available users list.
restrict.file.name String Restrict file name extensions that are not allowed.
Each file name extension is separated by the character “;”.
*~;*.bak
restrict.file.mime Boolean Restrict file name extensions based on existing ones at Administration > MIME types.
restrict.duplicated.documents Boolean It is not allowed to upload the same document more than once.
Internally the verification is based on the document checksum value.
native.sql.optimizations Boolean For best performance, some database operations are done with SQL rather than HQL.
repository.stats.optimization Boolean When enabled, the Administration > Statistics results take less time and resources to calculate.
repository.content.checksum Boolean When enabled, the document checksum is calculated for each uploaded document.
system.pdf.force.ocr Boolean Force processing of all PDF files with the OCR engine.
stack.metadata.hidden.properties List Filter metadata fields in the metadata stack view on the frontend UI.
show.records.in.tree Boolean When enabled, show record nodes in the tree stack view on the frontend UI.
system.catdoc.xls2csv String Native XLS to CSV converter tool. Used in NativeMsExcelTextExtractor. In Debian and other Ubuntu-based distros it is included in the catdoc package.
/usr/bin/xls2csv ${fileIn}
system.strings String Configure the Strings tool.
/usr/bin/strings ${fileIn}
system.zbar String Configure the barcode extractor tool.
/usr/bin/zbarimg
system.profiling Boolean The Profiling stats feature provides low-level information to the administrator to help find application performance problems.
You can also enable profiling from Administration > Utilities > Profiling stats.
system.ftp.port Integer FTP port.
On Linux, only the root user can bind to ports like 21; that’s why on this OS it’s a good idea to bind FTP to another port.
system.ftp.server Boolean When enabled, the application enables the FTP server feature.
user.keywords.cache Boolean When enabled, the keywords of nodes are cached.
The feature provides better performance with less database access.
user.item.cache Boolean When enabled, the application caches the number of nodes owned by the user.
The feature provides better performance with less database access when calculating the nodes owned by each user.
max.search.clauses Integer Set the maximum number of allowed clauses in a search.
max.search.results Integer Set the limit of the results returned by a search to the repository.
search.suggestion.minimal.results Integer The minimum number of search results required to provide suggestions. By default it is 5.
search.suggestion.returned.words Integer The number of suggested words. By default it is 3.
checkin.comment.mandatory Boolean Force users to set a comment when uploading a new document (create or update actions).
stack.metadata.adapter String Set the metadata stack implementation.
com.openkm.plugin.stack.metadata.GenericStackMetadataAdapter
More information at Creating your own Stack Metadata Adapter ( deprecated ).
system.diffpdf String Configure the DiffPDF tool.
Windows
You need the command line version from https://www.qtrac.eu/diffpdfc.html
C:\openkm\extra\diffpdf\diffpdf.exe -qr ${fileOut} ${fileIn1} ${fileIn2}
Linux
/home/openkm/tomcat-8.5.63/bin/diffpdf ${fileIn1} ${fileIn2} ${fileOut}
More info at Diffpdf raises ConversionException error while loading shared libraries: libpoppler-qt4.so.4
Bash script sample
<br>#!/bin/bash<br>#echo "p1: $1";<br>#echo "p2: $3";<br>#echo "p2: $3";<br>#echo "library path: $LD_LIBRARY_PATH";<br>export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/openkm/tomcat/lib/diffpdf<br>/opt/openkm/tomcat/bin/diffpdf $1 $2 $3<br>#unset LD_LIBRARY_PATH<br>
version.append.download Boolean Append the document version in the document file name when downloading a document from OpenKM.
webservices.visible.properties List List of configuration properties that are granted to users without administrator privileges via webservices.
rss.news.max.size Integer Maximum number of news retrieved from the news server.
10
News are cached by the OpenKM server and refreshed once per day. That means any change to this parameter will take effect tomorrow or after restarting the OpenKM service.
trash.retention.days Integer It indicates the maximum number of days nodes in the trash will be available before an automatic purge is executed. Default value is 0, which indicates unlimited.
There’s a Crontab task named “Purge Old Trash Nodes” that performs this action.
30
file.plan Boolean Enable or disable the file plan feature.
false
decimal.pattern String Set the decimal pattern.
.
browser.natural.sort Boolean Enable or disable natural sort.
Natural sort is done at the database engine level.
For MySQL and MariaDB download and install natural_sort.sql in your database.
For another database engine, you need to create your own function named “okmNaturalSort(String, Integer, String)”.
min.free.disk.percent Integer This is the minimum percentage used to alert about low free disk space.
20
search.by.attachment.parent Boolean Enable or disable searching for documents in email attachments.
false
property.group.element.default.access Boolean When set to true, all the metadata fields are shown to users; when false, none of the metadata fields are shown.
Sample scenarios:
- When the value is set to true, all the metadata fields are shown by default. In this scenario it makes sense to use revokeUser and revokeRole.
- When the value is set to false, all the metadata fields are not shown by default. In this scenario it makes sense to use grantUser and grantRole.
Additional information is available at Metadata Security element
true
system.license.mac String Pin the MAC address used for license validation. When empty (default), OpenKM auto-detects it by taking the first suitable network interface in JVM enumeration order. On hosts with several NICs (Bluetooth PAN, VPN or virtualization adapters) that order is not stable across reboots or when an adapter is enabled/disabled, which can break the license with a “License info mismatch” error. Set this to the MAC of a NIC that is always present (for example 84:BA:59:E0:D6:0C); accepted with : or - separators or none. The configured MAC must belong to a local network interface; otherwise OpenKM logs a warning and falls back to auto-detection.
This parameter must be set in the $TOMCAT_HOME/openkm.properties file.