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 on $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" 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 limit of the search results. For example, a value of 500 means you will never get more than 500 results for 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.demo |
Boolean |
This parameter is used to switch OpenKM to demo mode. In a production environment it should never be enabled. |
|
system.keyword.lowercase |
Boolean |
This parameter is used to force all keywords to lowercase. The application is case-sensitive, which means a user can set two keywords like "keyone" and "KeyOne" and, for 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". ISO-8859-1 |
|
mail.session.debug |
Boolean |
Enables mail session debug. It's useful to detect 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's 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 |
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's 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 require less time and resources to be calculated. |
|
repository.content.checksum |
Boolean |
When enabled, the document checksum is calculated for each uploaded document. |
|
system.pdf.force.ocr |
Boolean |
Forces processing of all PDF files with the OCR engine. |
|
database.pagination.optimization |
Boolean |
When enabled, executes pagination optimization to increase the speed of frontend UI features. |
|
store.raw.mail |
Boolean |
When enabled, it also stores the raw content of imported mails. |
|
store.node.path |
Boolean |
When enabled, the path of each node is stored in the database. For performance reasons, on move, delete, and rename operations we suggest not enabling this parameter. We only recommend enabling it on repositories with fewer than 100K nodes. |
|
stack.metadata.hidden.properties |
List |
Filter metadata fields in the metadata stack view on the frontend UI. |
|
show.records.in.tree |
Boolean |
When enabled, shows record nodes in the tree stack view on the frontend UI. |
|
shCoreEclipse.css |
String |
CSS style used by syntax highlighter. More information at http://alexgorbatchev.com/SyntaxHighlighter/ |
|
shThemeEclipse.css |
String |
CSS style used by syntax highlighter. More information at http://alexgorbatchev.com/SyntaxHighlighter/ |
|
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.embedded.preview |
Boolean |
When enabled (default), the preview uses a web PDF viewer solution. |
|
system.maintenance |
Boolean |
When enabled, the application goes into "maintenance mode", which means nobody except the okmAdmin user will be able to log in. |
|
system.strings |
String |
Configure Strings tool. /usr/bin/strings ${fileIn} |
|
system.zbar |
String |
Configure barcode extractor tool. /usr/bin/zbarimg |
|
system.profiling |
Boolean |
The profiling stats feature gives 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 is 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 the 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 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 minimum 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 |
Forces setting a comment when uploading a new document (create or update actions). |
|
html.syntaxhighlighter.core |
String |
Set the syntax highlighting CSS core. More information at SyntaxHighlighter. |
|
html.syntaxhighlighter.theme |
String |
Set the syntax highlighting CSS theme. More information at SyntaxHighlighter. |
|
kea.thesaurus.skos.file |
String |
The SKOS file. /vocabulary/ag_skos_20070219.rdf When enabled, it restricts the number of keywords available to associate with nodes. The SKOS file must be based on the ontology file (Web ontology file) set in the 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 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 |
|
version.append.download |
Boolean |
Append the document version to 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 that are granted to be viewed by users without administrator privileges via webservices. |
|
rss.news |
Boolean |
Enable or disable news on 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 the OpenKM server and refreshed once a day. That means any change to this parameter will take effect tomorrow or after restarting the OpenKM service. |
|
rss.news.visible |
Integer |
Number of visible news items at the same time. 1 |
|
trash.retention.days |
Integer |
It indicates the maximum number of days that nodes in the trash will be available until 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 |
|
update.info |
Boolean |
The application connects daily to the OpenKM server on the Internet to get news. true |
|
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 |
|
sanitize.lucene.fields |
Boolean |
When enabled, sanitize metadata fields. Because OpenKM metadata groups use characters reserved by Lucene like ":", when they are indexed by Lucene, these fields must be sanitized to be used in Working with Lucene queries. After enabling this parameter you must reindex the whole repository. Take a look at Rebuild indexes. |
|
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:
Additional information at Metadata Security element true |
