PAT_DMS_SETTINGS Configuration

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.

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 value set in <SSO_STATIC_PASS> key in the "dms.conf" file of the auto-deploy.

/default-domain/workspaces/Patricia

Firm root directory in Nuxeo

/default-domain/workspaces/Patricia/Settings

CaseBrowser settings directory in Nuxeo

doc.properties.synccache.ttl

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})"]}

[DNS]

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

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+

This setting will suppress OCR being run on case updates. Case update events happen, for example, when documents are uploaded or when emails are saved. Accordingly, this setting, if set to TRUE will essentially disable OCR operations from happening, with three main exceptions:

• Users clicking "view as text" will trigger an OCR operation;
• emails sent to an address set in ocr.email.scan.list.config.key will have their pdf attachments OCRed unless disabled by do.not.ocr.attachment.onsave;
• OCR sweep runner will run as normal (depending on is.ocr.office.hours setting).
  

This setting should be set TRUE for the period of the first email-analysis sweep run after an import of a client repo.

Feature available in version 1.9.8.2.3

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
piocr: Configuring OCR appliance for DMS

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.

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+

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.

Default category for all email addresses. The category ID specified here will be applied to all in- and outbound email communication.

Specific email category configuration, which is a JSON string of a Category definition per 'to:' address. This value overrides the email.category.default setting based on the 'to:' address. While it could be used for outbound email addresses, it is only recommended to be used for email addresses that are under your own control.

Format:

[{"email":"email1@email.address","categoryId":1},{"email":"email2@email.address","categoryId":2]

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"}]

Attachments which match this patterns will not be saved

Checksum will not be added to case ref in subject if set to TRUE. Feature available in version 1.9.4+

Starting version 1.9.8.2.3, the checksum will also be omitted on creation of a draft email or a forward/reply message.

If set to TRUE, auto reply emails will not be saved as per the following pattern matches. By default, auto reply emails are saved to the case.

List of auto reply headers that will invoke DMS not to save message to repo.

List of auto reply strings that will invoke DMS not to save message to repo.

[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 CPU cores, 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 core 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+

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+

[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+

[advanced setting] This sets the system behavior of email sweep runner (ie. attachment extraction and email metadata extraction and syncing):

• If TRUE, System is set to always office hours: Sweep runner will never run (only for testing).
• If FALSE, System is set to never office hours: Sweep runner will always run (only advisable to use after import and full indexing concluded). Each specific sweep runner process will start every 15 minutes (3 different processes fired in a circle every 5 minutes).
• If left empty (default), office times (6am-7pm Mo to Fr) will apply, ie. during office hours sweep runner will not run, otherwise will run.

Feature available in version 1.9.8+

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+

The URL defined here will be used when right-click-opening a CaseBrowser document from the Nuxeo interface, if a different URL needs to be used than the standard Nuxeo URL. In this context, URL includes port definition. This can be the case in LDAP/Kerberos-authenticated environments.

For example, for LDAP/Kerberos-authenticated environments, open.nuxeo.from.dms.url = server.domain.com can be set although the standard Nuxeo URL is server.domain.com:8080. If open.nuxeo.from.dms.url is not set/defined, the standard Nuxeo URL will be used.

Setting deprecated as of version 1.9.8.2.2 (will need to be set in pi-nuxeo.xml). Auto deploy scripts set accordingly.

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
"<docdescr>.pdf" if skip.adding.timestamp = TRUE

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
"<docnamer>.pdf" if skip.adding.timestamp = TRUE

Feature available in version 1.9.8.2.1+

This sets the default state of the "Mark-ups in Black/White" tick box in the pdf generation dialogs.

Feature available in version 1.9.8.2.3-2+

This sets the default state of the "Show sidebars for mark-ups" tick box in the pdf generation dialogs.

Feature available in version 1.9.8.2.3-2+

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+

A list of google fonts can be defined and is then loaded on opening of the editor to become available to the email editor in drafting emails.

This setting is accepting a JSON object of format {<key1>:<value1>,<key2>:<value2>, ... ,<keyN>:<valueN>}. In this format, the following applies:

• <key> is a string of font name - in case insensitive format: e.g. "Lobster", "shadows into light", "robots",
• <value> is a string font options (without the font name) available for the font, e.g. "regular", "bold", "italic". <value> can be an empty string ("") to specify default font format

Example: {"Indie Flower":"cursive","gloria Hallelujah":"","Dancing Script":"bold"}

Feature available in version 1.9.8.2.3-2+