Integrator Settings - Documents

On integration of 'Documents', all files in the Document 'Watch Directory' will be sent to the web, after which they will be moved to the Document 'Archive Directory'.  

  • If no Watch Directory has been specified, the integration event will not proceed.
  • Only files with valid extensions will be integrated (as specified in Integrator Settings --> 'Documents' --> 'Valid Extensions'.)
  • Upon integration, the file name will be stored in the nominated database field in the directory. There can be multiple fields and remote directories, categorised by numeric delimiter.  

Integration Settings - Documents

Watch Directory The local folder in which documents are stored, pending integration.
Archive Directory The local folder to which documents are moved post integration.
Valid Extensions File types considered 'valid' for integration (e.g., .docx, .doc, .pdf).
Remote Directory

The location on the server to which the file is saved on integration.

Numeric Delimiter

The delimiter used between the file name and the numeric values (e.g. 1-5). The default delimiter is set to underscore (e.g. documentname_1.doc, documentname_2.pdf), but can be set to another symbol if required.

 The value after the delimiter designates the 'Database Field Name' and 'Remote Directory' to which the file name will be saved on integration. So in the screenshot above, any document with '_1' in the file name will be saved to the 'documents/manuals' Remote Directory, with the document name written to the 'InstructionManualLink' field in the database.

Max Upload File Size The maximum size, in megabytes, of document files to be integrated. Files larger than the specified maximum will not be processed.
Send Documents in Batches

This value determines how many document files the Integrator will process at one time. Keeping the number low (e.g. 10 or 20), will reduce processing time.

Please note: All document files will be processed on each send; batching simply prevents time-outs on very large files.


NOTE: If processing of files fails, documents will be moved out of Archive and back into a Failed Directory.


Have more questions? Submit a request


Powered by Zendesk