Other configuration parameters

PropertyTypeDescription

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.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

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 .

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.

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.

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.maintenance

Boolean

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

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 .

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.results

Integer

Set the limit of the results returned by a search to the repository.

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/>

registered.text.extractors

List

List of enabled text extractor

org.apache.jackrabbit.extractor.PlainTextExtractor
org.apache.jackrabbit.extractor.MsWordTextExtractor
org.apache.jackrabbit.extractor.MsExcelTextExtractor
org.apache.jackrabbit.extractor.MsPowerPointTextExtractor
org.apache.jackrabbit.extractor.OpenOfficeTextExtractor
org.apache.jackrabbit.extractor.RTFTextExtractor
org.apache.jackrabbit.extractor.HTMLTextExtractor
org.apache.jackrabbit.extractor.XMLTextExtractor
org.apache.jackrabbit.extractor.MsOutlookTextExtractor
com.openkm.extractor.PdfTextExtractor
com.openkm.extractor.AudioTextExtractor
com.openkm.extractor.ExifTextExtractor
com.openkm.extractor.Tesseract3TextExtractor
com.openkm.extractor.SourceCodeTextExtractor
com.openkm.extractor.MsOffice2007TextExtractor

version.append.download

Boolean

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

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

webservices.visible.properties

List

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