Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Param nameDefault valueDescriptionVersionFurther examples & use case
-- provided by Patrix --
save.outbound.emailFALSE

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.

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

1.9.7+ 
nuxeo.firm.root

/default-domain/workspaces/Patricia

Firm root directory in Nuxeo

1.0+ 
nuxeo.settings.dir

/default-domain/workspaces/Patricia/Settings

CaseBrowser settings directory in Nuxeo

1.0+ 
patricia.documents.pathPatricia/DocumentsPatricia documents directory in Nuxeo1.0+ 
pat.doc.log.sync.all.filesTRUE

Enable/disable sync listener to add pat_doc_log entries for documents added to a case through nuxeo drive or WebDAV.

-- Default value changed to TRUE as of version 1.9.8.2+

1.9.6+ 

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.

1.9.5+ 
doc.properties.sync.delay10[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.1.9.5+ 
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})"]}

1.9.7+

View file
nameOLD CASE ID AS IDENTIFIER WHEN AUTO SAVING EMAILS.pdf
height250
 

checksum.optional.for.saving.emailTRUEThis 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.1.9.5+ 
checksum.optional.for.assisted.scanningTRUEThis 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.1.9.5+ 
email.save.to.tempTRUEIf set to FALSE, emails will not be saved to temp store folder "nuxeo-emails".1.9.5+ 
email.lines.to.parse12Define 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".1.9.5+ 
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.1.9.6+ 
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. Accordingly, only case references found in the text of pdf documents will be used for auto-saving.

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

1.9.6+ 
do.not.ocr.attachment.onsaveFALSE

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!

1.9.8.2.2+ 
do.not.ocr.onupdateFALSE

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.

1.9.8.2.3+ 
ocr.engine.nametesseract

Allows custom configuration of the command to use for performing ocr. Note that only set engines are supported: 'tesseract' (default), 'ocrkitmac', 'piocr'.

The default will make use of the tesseract package internal to the nuxeo container. To make user of the external tesseract container solution, please refer to: Configuring external dockerized tesseract appliance for DMS

ocrkitmac: Configuring OCR appliance for DMS using OCRKit
piocr: Configuring OCR appliance for DMS

1.9.6+ 
drive.timeout2592000

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.

1.9.3+ 
use.crc.on.reimportFALSE

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

1.9.8.2.3+ 
file.import.completedFALSE

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.

1.0+ 
email.category.default0

Default category for all email addresses. The category ID specified here will be applied to all in- and outbound email communication unless there is a more specific hit by email.category.set or subject.category.set. Order of priority is: email.category.set → subject.category.set → email.category.default (highest to lowest).

1.9.5+ 
email.category.set<empty>

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

1.9.7.2+

 

email.description.set<empty>

Specific "Document description" description configuration, which is a JSON string of a description definition per 'to:' address.

Format:

[{"email":"email1@email.address","description":"Email 1"},{"email":"email2@email.address","description":"Email alternative"}]

1.9.7.2+

 

subject.category.set<empty>

Specific subject line keywords as a JSON string of a category definition per keyword. This value is overridden by a definition in email.category.set, ie. if a keyword defined in subject.category.set hits as well as a 'to:' address defined in email.category.set, the latter definition wins. If multiple defined keywords are present in the subject, the first hit wins.

This setting can be used for outbound email communication as well as inbound one.

Format:

[{"keyword":"subjectString1","categoryId":1},{"keyword":"subjectString2","categoryId":2}]

1.9.8.2.3-3+
subject.description.set<empty>

Specific subject line keywords as a JSON string of a "Document description" definition per keyword. This value is overridden by a definition in email.description.set, ie. if a keyword defined in subject.description.set hits as well as a 'to:' address defined in email.description.set, the latter definition wins. If multiple defined keywords are present in the subject, the first hit wins.

This setting can be used for outbound email communication as well as inbound one.

Format:

[{"keyword":"subjectString1","description":"Email 1"},{"keyword":"subjectString2","description":"Email alternative"}]

1.9.8.2.3-3+
email.excluded.attachments["smime.p7s"]

Attachments which match this patterns will not be saved. Attachment names that are to be omitted should be listed each by their own entry in the value area.

Format:

["smime.p7s","image001.jpg","image002.jpg"]

1.9.7+ 
subject.line.case.ref.additionTRUEIf set to FALSE, subject line will not be prefixed with case ref first found in email body (or OCRed attachment)1.9.7.1+ 
skip.adding.checksumFALSE

Checksum will not be added to case ref in subject if set to TRUE.

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

1.9.4+ 
do.not.save.auto.reply.emailsFALSE

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.

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.


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

1.9.5+ 
skip.adding.timestampsFALSEIf set to TRUE, the system will not add time stamps to filenames at any point.1.9.8+ 
get.pdf.text.layerTRUEIf set to FALSE, the text extraction logic will not attempt getting pdf text layers before running OCR of the pdf.1.9.8+ 
no.of.processing.cpus1

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

1.9.8.2.3+ 
dont.modify.filename.onopenFALSE

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

1.9.8.2.2+ 
view.edit.size.limit50

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

1.9.8.2.3+ 
allow.concurrent.editsTRUE

By default, the EDMS allows concurrent editing of a document by two users upon explicit decision by user B to concurrently edit the document that is also edited by user A. EDMS's versioning will make sure non data is lost, however, a previous version may need to be restored from the nuxeo console, which is an admin task.

If this setting is set to FALSE, user B will receive a note that a document cannot be concurrently edited and will only be given the option of opening the document read-only.

1.9.8.2.4-1+
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):

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

1.9.8.2.2+ 
is.preview.office.hours<empty>Same as is.email.office.hours but for preview sweep runner (ie. generation of first page preview thumbs). 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).

1.9.8+ 
move.copy.default.is.copyFALSE

Sets default behavior of the copy tick box in the move/copy document command.

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.1.9.8.2+ 
show.matter.idFALSE

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.

1.9.8.2.1+ 
use.doc.descr.for.pdfTRUE

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

1.9.8.2.1+ 
set.description.to.filename.onduplicateFALSE

If set to TRUE the "Document description" of the duplicate is set to match the "Filename" thereof in a duplication action:

set.description.to.filename.onduplicate = FALSE:
"document description" (destination) = "document description" (source)

set.description.to.filename.onduplicate = TRUE:
"document description" (destination) = "document filename" (destination)

1.9.8.2.3-3+
mark.ups.bwFALSE

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

1.9.8.2.3-2+ 
show.sidebars.for.markupsFALSE

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

1.9.8.2.3-2+ 
limit.family.case.typeFALSE

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

1.9.8.2.2+ 
hyphenation.enabledFALSE

If set to TRUE, previews and pdfs of .doc/.docx/.rtf documents will be generated with hyphenated text in the major languages, provided that the document setting for hyphenation is set to true. Hyphenation cannot be activated on a paragraph by paragraph basis.

Note: A preview or text will only be hyphenated if the current setting is TRUE at the time the preview or the pdf is generated.

1.9.8.2.3-3+
custom.google.fonts.for.email.editor<empty>

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

1.9.8.2.3-2+ 
email.style.definitions<empty>

A list of font style definitions provided in JSON or JavaScript Object Literal that will be displayed in the "Formats" menu. If the value is <empty> the "Formats" menu will be hidden and instead the "Paragraphs" menu with the default html style definitions shown.

Example: [{"title":"Boldtext","inline":"strong"},{"title":"Redtext","inline":"span","styles":{"color":"#ff0000"}},{"title":"Redheader","block":"h1","styles":{"color":"#ff0000"}},{"title":"Badge","inline":"span","styles":{"display":"inline-block","border":"1pxsolid#2276d2","border-radius":"5px","padding":"2px5px","margin":"02px","color":"#2276d2"}},{"title":"Tablerow1","selector":"tr","classes":"tablerow1"}]

Please check https://www.tinymce.com/docs/demo/format-custom/ to see the resulting "Formats" menu.

1.9.8.2.3-3+
disable.rtf.email.replacementTRUE

If set to FALSE, the EMDS will replace .rtf email documents in Patricia by the finally sent email (after it's processing). This way, a .rtf document (representing the source email and which is modifiable) will be replaced by the corresponding sent email when processed by the autosaving mechanism so as to have an immutable copy of the email message as sent.

Note: If the EDMS does not receive the outbound email for processing or cannot identify the case this email refers to (because of a missing subject line), the .rtf email document in Patricia remains unchanged.

1.9.8.2.3-3+

...