Param name | Default value | Description | Use case |
---|---|---|---|
save.outbound.email | FALSE | If set to TRUE the email will be saved to the DMS directly, independently of auto-save. If FALSE the casebrowser relies on the standard auto-save function for the outgoing email to be saved to a case. If auto-save is enabled and this setting is set to TRUE, emails may be duplicated in cases; such situation should be avoided. This setting is meant to be used in environments that are not making use of the auto-save function of the DMS. | |
sso.static | <empty> | When LDAP-Authentication is active (sso.mode.enabled = TRUE and sso.static.pass = <passwordValue> set in pi-nuxeo.xml) this value will be used to replace password returned by Patricia in GET authentication method for CaseBrowser. This value must match <passwordValue> set in sso.static.pass in pi-nuxeo.xml. | |
nuxeo.firm.root | /default-domain/workspaces/Patricia | Firm root directory in Nuxeo | |
nuxeo.settings.dir | /default-domain/workspaces/Patricia/Settings | CaseBrowser settings directory in Nuxeo | |
patricia.documents.path | Patricia/Documents | Patricia documents directory in Nuxeo | |
pat.doc.log.sync.all.files | TRUE | Enable/disable sync listener to add pat_doc_log entries for documents added to a case through nuxeo drive or WebDAV. Feature available in version 1.9.5+; default changed to TRUE as of version 1.9.8.2+ | |
doc.properties.synccache.ttl | 20 | [advanced setting] Set sync listener cache TTL in sec. within which pat_doc_log properties will be retained/reapplied for documents having same name in a specific caseID after deletion. This is required as Patricia will replace files in WebDAV when being edited/saved using Patricia editor rather than just modify them. Attention: This value will require increase if the system works on high latency/low speed connections. | |
doc.properties.sync.delay | 10 | [advanced setting] Set delay in sec. after which sync listener will add/remove document to pat_doc_log if not already done so by CaseBrowser (or otherwise). Attention: doc.properties.synccache.ttl should always be > doc.properties.sync.delay; otherwise cache will be always empty. | |
old.case.id.reg.ex.conf | <empty> | A list of permitted old case id regular expressions, formatted as a json string. This is used when searching for valid old case ids in emails or free-form text such as OCR. Sample usage of old.case.id.reg.ex.conf that can scan for three types of old case number patterns: {"version":1,"regExList":["([0-9]+-[A-Z0-9]+-[A-Z0-9]+)","([0-9]+-[A-Z0-9]+-[A-Z0-9]+-[A-Z0-9]+)","(\\b[0-9]{3}[A-Z]{4}-[0-9]{1,4})"]} | |
checksum.optional.for.saving.email | TRUE | This option, when TRUE, saves emails to cases that include a case ref. with or without a checksum. If FALSE, case refs. without checksums will be skipped. | |
checksum.optional.for.assisted.scanning | TRUE | This option, when TRUE, saves assisted scan emails to cases (case refs. from OCR'ed pdfs) when the case refs. are with or without a checksum. If FALSE, case refs. without checksums will be skipped. | |
email.save.to.temp | TRUE | If set to FALSE, emails will not be saved to temp store folder "nuxeo-emails". | |
email.lines.to.parse | 12 | Define the number of lines in the email body that are being scanned for case refs. To NOT scan the body at all, set to "0". | |
auto.save.skip.subject.key | [DNS] | This key prefixing the subject line will make sure the email is not saved to the DMS despite a case ref. being in the subject line. | |
ocr.email.scan.list.config.key | <empty> | Comma separated list of all to:email addresses for which only the attachment should be saved to the case but not the email message. All pdf attachments will be OCRed immediately, ie. on saving, except when do.not.ocr.attachment.onsave = TRUE (see next key). If OCRing is set to occur on saving, any case references found in the OCRed text will be used to define to which cases the attachments are saved. Note: Given the immediate OCRing of pdf attachments to find cases to which to save to, the saving to the cases is delayed until the OCR finishes. Format: email1@email.address,email2@email.address,... | |
do.not.ocr.attachment.onsave | FALSE | This setting will eliminate OCR being run on attachments in emails sent to an address in the ocr.email.scan.list.config.key setting on saving. OCR will, however, run with next sweep run (depending on is.ocr.office.hours setting). Note: If the email subject line does not include a valid case reference, nothing will be saved! Feature available in version 1.9.8.2.2+ | |
drive.timeout | 2592000 | This value sets the trigger period for the periodic search and clean up "old" (= older than timeout period) NuxeoDrive roots. These "old" folders are unregistered so as to make sure the shared NuxeoDrive roots are not cluttering the client systems and eventually causing unwanted and unneeded system load through NuxeoDrive compare processes. Under normal circumstances no change is necessary. | |
ocr.engine.name | tesseract | Allows custom configuration of the command to use for performing ocr. Note that only set engines are supported: 'ocrkitmac', 'piocr' ocrkitmac: Configuring OCR appliance for DMS using OCRKit | |
use.crc.on.reimport | FALSE | This settings affects the behaviour of the DMS import during a re-import (aka re-sync). When set to TRUE, the DMS importer will perform a byte-by-byte check of the source files (from the filesystem) against the destination files (inside the DMS) to find documents that have been modified/changed. If FALSE, only a byte-size check will be performed to determine if a document had been modified/changed. The re-sync can be run directly after an import as a verify run to make sure all documents have been correctly imported into the DMS (generally not necessary given each transaction is acknowledged). With byte-size check (FALSE) and depending on general system performance parameters the re-sync time is ~10-15% of the original import time; with byte-by-byte check the re-sync time is ~20-25%. Feature available in version 1.9.8.2.3+ | |
file.import.completed | FALSE | Whilst this setting remains FALSE, new files added to the system will not be subject to preview generation, email analysis, text extraction or metadata syncing. For production use this setting must be set to TRUE after the import. | |
do.not.save.auto.reply.emails | FALSE | If set to TRUE, auto reply emails will not be saved. By default, auto reply emails are saved to the case. | |
email.category.default | 0 | Default category for all email addresses | |
email.category.set | <empty> | Specific email category configuration, which is a JSON string of EmailCategory set. Format: [{"email":"email1@email.address","categoryId":1},{"email":""email2@email.address","categoryId":2] | |
email.description.set | <empty> | Specific email description configuration, which is a JSON string of EmailDescription set. Format: [{"email":"email1@email.address","description":"Email 1"},{"email":"email2@email.address","description":"Email alternative"}] | |
email.excluded.attachments | ["smime.p7s"] | Attachments which match this patterns will not be saved | |
subject.line.case.ref.addition | TRUE | If set to FALSE, subject line will not be prefixed with case ref first found in email body (or OCRed attachment) | |
skip.adding.checksum | FALSE | Checksum will not be added to case ref in subject if set to TRUE. Feature available in version 1.9.4+ | |
auto.reply.headers | [{"name":"X-Autoreply","value":"*"},{"name":"X-Autorespond","value":"*"},{"name":"auto-submitted","value":"auto-generated"},{"name":"auto-submitted","value":"auto-replied"}] | List of auto reply headers that will invoke DMS not to save message to repo. | |
auto.reply.subject.prefix | ["auto:","auto response","automatic reply","autosvar","automatisk svar","automatisch antwoord","abwesenheitsnotiz","risposta non al computer","automatisch antwoord","auto response","respuesta automática","fuori sede","out of office","frånvaro","réponse automatique"] | List of auto reply strings that will invoke DMS not to save message to repo. | |
skip.adding.timestamps | FALSE | If set to TRUE, the system will not add time stamps to filenames at any point. Feature available in version 1.9.8+ | |
get.pdf.text.layer | TRUE | If set to FALSE, the text extraction logic will not attempt getting pdf text layers before running OCR of the pdf. Feature available in version 1.9.8+ | |
no.of.processing.cpus | 1 | [advanced setting] This sets the system resource consumption for text extraction processing through OCR. Per integer count, a parallel thread is started to run an OCR process. If this value is set beyond the number of available CPUs, the system performance may deteriorate significantly, in particular if tesseract OCR engine is used. It is advised that, specifically during production use, this value should not exceed 50% of the available CPU count. Attention: Setting this value too high for your environment may affect the correct functioning of your DMS system negatively. Feature available in version 1.9.8.2.3+ | |
dont.modify.filename.onopen | FALSE | If set to TRUE, the system will eliminate all filename and document name changes on files when being viewed/edited through DMS (ie. no timestamp is prefixed and no case ref or invoice no. postfixed). Feature available in version 1.9.8.2.2+ | |
view.edit.size.limit | 50 | [advanced setting] This sets the size limit for opening files using the view/edit command. The value is determining the file size in MB. It is recommended to not set the size limit to values >>50MB to warrant for correct function of the DMS, specifically if WAN connections are used to connect to the server. Attention: Setting this value too high for your environment may affect the correct functioning of your DMS system negatively. Feature available in version 1.9.8.2.3+ | |
is.email.office.hours | <empty> | [advanced setting] This sets the system behavior of email sweep runner (ie. attachment extraction and email metadata extraction and syncing):
Feature available in version 1.9.8+ | |
is.preview.office.hours | <empty> | Same as is.email.office.hours but for preview sweep runner (ie. generation of first page preview thumbs). Feature available in version 1.9.8+ | |
is.ocr.office.hours | <empty> | Same as is.email.office.hours but for OCR sweep runner (ie. text extraction of both electronically readable documents and image pdfs). Feature available in version 1.9.8+ | |
is.metadata.sync.office.hours | <empty> | Same as is.email.office.hours but for metadata sweep runner (ie. document metadata extraction and syncing). Feature available in version 1.9.8.2.2+ | |
move.copy.default.is.copy | FALSE | Sets default behavior of the copy tick box in the move/copy document command. Feature available in version 1.9.8.2+ | |
dms.license | <empty> | A valid Extended DMS license key will need to be entered. The system will only work if a valid key is provided. Key can be obtained from Patrix/PI. This will be a required setting starting version 1.9.8.2. | |
Setting deprecated as of version 1.9.8.2.2 (will need to be set in pi-nuxeo.xml). Auto deploy scripts set accordingly. | |||
show.matter.id | FALSE | If set to TRUE, CaseBrowser will display the matterID next to the case ref. in the header line of the CaseBrowser window. Similarly, starting from DocIntegrateOutlook version 1.2.8, the matterID will also be displayed in the plugin section of Outlook next to the case ref. Feature available in version 1.9.8.2.1+ | |
use.doc.descr.for.pdf | TRUE | If set to TRUE the default "Filename" of a newly created pdf will be build from the "Document description" as follows: "<timestamp>-<docdescr>.pdf" if skip.adding.timestamp = FALSE If set to FALSE the default "Filename" of a newly created pdf will be build from the "Document name" as follows: "<timestamp>-<docname>.pdf" if skip.adding.timestamp = FALSE Feature available in version 1.9.8.2.1+ | |
limit.family.case.type | FALSE | If set to TRUE, family documents will be listed only in cases belonging to the same family number and case type. If FALSE, family documents will be listed in cases of same family number (irrespective of case type). Feature available in version 1.9.8.2.2+ |