Other configuration parameters

PropertyTypeDescription

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 on $TOMCAT_HOME/openkm.properties file.

hibernate.search

Boolean

This parameter can be used to disable Hibernate Search completely. This mean you won't be able to search document or folders.

This parameter must be set on $TOMCAT_HOME/openkm.properties file.

system.ocr.rotate

String

This parameter forces OCR to process on the document rotated.

The feature is useful for example in upside down scanned pages, where standard OCR direction will fails.

The parameter is a collection of degrees separated by character ";"

90;180;270;

More information at Configuring OCR engine.

system.ocr.spell.check

Boolean

When is enabled the text extracted by OCR is validated by spell checker.

The application must have an enabled dictionary, see the parameter "system.openoffice.dictionary" at OpenOffice 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 limits of the search results. For example a value of 500 means will never get more than 500 results of any query.

500

The reason why the number of results is limited is that some queries can retrieve a huge number of results, specially when the queries are done across api methods.

system.demo

Boolean

This parameter is used to switch openkm to demo mode.

On production environment should never be enabled.

system.keyword.lowercase

Boolean

This parameter is used to force all keyword to lowercase.

The application is case sensitive, that means a user can set two keywords like "keyone" and "KeyOne" and for the application these two keywords are distinct. To prevent this problem is always good idea force all keyword 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 parmeter to "UTF-8".

URIEncoding="UTF-8"

ISO-8859-1

mail.session.debug

Boolean

Enable mail session debug. It's useful to detect problems when application is not sending mails.

mobile.theme

String

There're five mobile themes ( "a", "b", "c", "d", "e" ).

More information about themes at jQuery mobile themes.

b

plugin.debug

Boolean

When enabled show debug information about application plugin feature.

principal.hide.connection.roles

Boolean

Hide "ROLE_USER" and "ROLE_ADMIN" roles from available roles list.

By default the hidden roles are set by "default.user.role" and "default.admin.role" parameters value. Usually "ROLE_USER" and "ROLE_ADMIN".

principal.database.filter.inactive.users

Boolean

Hide inactive users for available users list.

restrict.file.name

String

Restrict file name extension that  are not allowed.

Each file name extension is separated by character ";".

*~;*.bak

restrict.file.mime

Boolean

Restrict file name extension based on existing ones at Administration > MIME types.

restrict.duplicated.documents

Boolean

Is not allowed to upload more than one time the same document.

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 is enabled the Administration > Statistics results need less time and resources to be calculated.

repository.content.checksum

Boolean

When is enabled is calculated the document checksum for each upload document.

system.pdf.force.ocr

Boolean

Force to processing all PDF files with the OCR engine.

database.pagination.optimization

Boolean

When enabled execute pagination optimization to increase the speed on frontend UI feature.

store.raw.mail

Boolean

When is enabled also it stores a the imported mails raw.

store.node.path

Boolean

When enabled is stored in database the path of each node.

For performance reason on move, delete and rename operation we suggest to do not enable this parameter. We only recommend to enable on repositories with less 100K nodes.

stack.metadata.hidden.properties

List

Filter metadata fields at metadata stack view on frontend UI.

show.records.in.tree

Boolean

When is enabled show record nodes at tree stack view on frontend UI.

shCoreEclipse.css

String

CSS style used by syntax highlighter.

shThemeEclipse.css

String

CSS style used by syntax highlighter.

system.catdoc.xls2csv

String

XLS to CSV converter tool.

system.embedded.preview

Boolean

When is enabled - default - the pre visualization use a web PDF viewer solution.

system.maintenance

Boolean

When is enabled the application goes to "maintence mode", that mean nobody except the okmAdmin user will be able to login.

system.strings

String

Configure Strings tool.

/usr/bin/strings ${fileIn}

system.zbar

 String

Configure bar code extractor tool.

/usr/bin/zbarimg

system.profiling

Boolean

The Profiling stats feature gives low level value information to the administrator to find out application performance problems.

You also can enable profiling from Administration > Utilities > Profiling stats.

system.ftp.port

Integer

FTP port.

On linux only root user is able to binding ports like 21, that's why on this OS is good idea binding ftp at another port.

system.ftp.server

Boolean

When is enabled the application enables the FTP server feature.

user.keywords.cache

Boolean

When enabled the keyword of the nodes are cached.

The feature provide best perfomance with less database access.

user.item.cache

Boolean

When enabled the application cached the number of nodes owned by the user.

The feature provide best perfomances with less database access for 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 minimal search results to provide suggestions. By default is 5.

search.suggestion.returned.words

Integer

The number of suggested words. By default is 3.

checkin.comment.mandatory

Boolean

Force to set comment when uploading new document ( create or update actions ).

html.syntaxhighlighter.core

String

Set the syntax highlight css core.

More information at SyntaxHighlighter.

html.syntaxhighlighter.theme

String

Set the syntax highlight css theme.

More information at SyntaxHighlighter.

kea.thesaurus.skos.file

String

The SKOS file.

/vocabulary/ag_skos_20070219.rdf

When enabled restricts the number of keywords available to associate with nodes. The SKOS file must be based on the  ontology file ( Web ontology file ) set at kea.thesaurus.owl.file property ( Thesaurus configuration ).

More information about SKOS ( Simple Knowledge Organization System ).

kea.thesaurus.vocabulary.serql

 String

Query to retrieve SKOS terms.

SELECT X,UID FROM {X} skos:prefLabel {UID} WHERE lang(UID) ="en" USING NAMESPACE rdf=<http://www.w3.org/1999/02/22-rdf-syntax-ns#>, skos=<http://www.w3.org/2004/02/skos/core#>,rdfs=<http://www.w3.org/2000/01/rdf-schema#>,dc=<http://purl.org/dc/elements/1.1/>, dcterms=<http://purl.org/dc/terms/>, foaf=<http://xmlns.com/foaf/0.1/>

stack.metadata.adapter

String

Set the metadata stack implementation.

com.openkm.plugin.stack.metadata.GenericStackMetadataAdapter

system.diffpdf

String

Configure 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.24/bin/diffpdf ${fileIn1} ${fileIn2} ${fileOut}

In case of you don't have an X Server installed on Linux, you would need a fake one like Xvfb, and the poppler-qt dependency. In Debian / Ubuntu both them can be installed this way:

$ sudo apt-get install xvfb libpoppler-qt4

In Ubuntu 18.04:

$ sudo apt-get install libqtgui4

And add $TOMCAT_HOME/lib/diffpdf libraries to LD_LIBRARY_PATH.

In CentOS:

$ yum install xorg-x11-server-Xvfb poppler-qt

$ ln -s /lib64/libpoppler-qt4.so.14.4.0 /lib64/libpoppler-qt4.so.4

And uncomment the corresponding lines from the Tomcat service script at /etc/init.d/openkm:

$ECHO "Starting Xvfb"
Xvfb :1 &
export DISPLAY=:1

and

$ECHO "Stopping Xvfb"
killall Xvfb

version.append.download

Boolean

Append the document version in the document file name when downloading a document from OpenKM.

cmis.dateformat

String

Pattern to transform date and time values from CMIS format to OpenKM format.

More information at Java 8 SimpleDateFormat

By default the value is:  yyyyMMddHHmmss

webservices.visible.properties

List

List of configuration properties what are granted to view by users without administrator grants from webservices.

rss.news

Boolean

Enable or disable new in the login page.

rss.news.box.width

Integer

Width of the news box in the login page.

300

rss.news.max.size

Integer

Maximum number of news retrieved from the news server.

10

News are cached from OpenKM server and refreshed one time by day. That means any change on this parameter will take effect tomorrow or restarting OpenKM service.

rss.news.visible

Integer

Number of visible news at the same time.

1

 trash.retention.days

 Integer

It indicates the maximum number of days nodes in the trash will be available until automatic purge will be executed. Default value is 0 indicates unlimited.

There's a Crontab task named "Purge Old Trash Nodes" what does it action.

30

update.info

Boolean

Application daily connects to OpenKM server in Internet to get news.

true

file.plan

Boolean

Enable or disable the file plan feature.

false

decimal.pattern

String

Set the decimal pattern.

.