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 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 it is enabled, the text extracted by OCR is validated by the 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 you will never get more than 500 results for any query. 500 The reason why 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, 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 |
Enable mail session debug. It's useful to detect problems when the application is not sending emails. |
|
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, it shows debug information about the application plugin feature. |
|
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 checksum value. |
|
native.sql.optimizations |
Boolean |
For best performance, some database operations are done with SQL rather than HQL. |
|
repository.content.checksum |
Boolean |
When it is enabled, the document checksum is calculated for each uploaded document. |
|
system.pdf.force.ocr |
Boolean |
Forces all PDF files to be processed with the OCR engine. |
|
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.maintenance |
Boolean |
When the application is enabled, it goes into "maintenance mode", which means nobody except the okmAdmin user will be able to log in. |
|
system.strings |
String |
Configure the Strings tool. /usr/bin/strings ${fileIn} |
|
system.zbar |
String |
Configure the barcode extractor tool. /usr/bin/zbarimg |
|
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 repository search. |
|
version.append.download |
Boolean |
Append the document version to the document file name when downloading a document from OpenKM. |
|
webservices.visible.properties |
List |
List of configuration properties that can be viewed by users without administrator grants via the webservices. |
|
rss.news |
Boolean |
Enable or disable the news feature on the login page. |
|
rss.news.box.width |
Integer |
The width of the news box on the login page. 300 |
|
rss.news.max.size |
Integer |
The maximum number of news items retrieved from the news server. 10 News is cached from other OpenKM servers and refreshed once a day. That means any change to this parameter will take effect tomorrow after restarting the OpenKM service. |
|
rss.news.visible |
Integer |
Number of visible news items at the same time. 1 |
|
decimal.pattern |
String |
Set the decimal pattern. . |
|
sanitize.lucene.fields |
Boolean |
When enabled, metadata fields are sanitized. 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 the search for documents in emails (attachments). false |
|
property.group.element.default.access |
Boolean |
When set to true, all the metadata fields are shown to the users; when false, none of the metadata fields are shown. Sample scenarios:
Additional information at Metadata Security element true |
