Find your dream job at PaperCut

Choose your language

Choose your login

Contact us

Help Center menu

PRODUCT MANUALS

PaperCut NG & PaperCut MF Manual

PRODUCTS FEATURED

Configure advanced Integrated Scanning (config keys)

PaperCut MF has default settings for Integrated Scanning that you can change to meet your needs. You can:

Modify the default scanning system settings

The following scanning system configuration keys are available from Options > Config editor (advanced):

Integrated Scanning system configuration keys
KeyDescription
system.scan.backup-daysThis value is mandatory. The number of days to keep the scan and XML backup files. For example, if the value is set to 7, backup files are kept for 7 days. A daily maintenance task cleans the old files from the directory. If you set the value to 0, scanned files are not backed up. The default value is 0.
system.scan.backup-folderA relative path in which scan and XML backup files are saved. This path is used only if system.scan.backup-days is greater than 0. The path is relative to the /server/data folder in the PaperCut MF install directory, for example, C:/Program Files/PaperCut MF NG/server/data/. Alternatively, you can enter a full path to which the server has access. The default path is scan/backup. This value is mandatory.
system.scan.docproc.blank-thresholdThe detection threshold, above which a page is classified as blank. A completely blank page is 1, and the default threshold value is 0.9999995. Decreasing the value makes blank page detection less sensitive, allowing more image and text content to still count as a blank page. Affects Blank Page Removal and Batch Splitting by blank page separator.
system.scan.docproc.deskewThe binary Y/N status of Document Processing Deskew for all scan jobs. The default value is N.
system.scan.docproc.despeckleThe binary Y/N status of Document Processing Despeckle for all scan jobs. The default value is N.
system.scan.failed-daysThe number of days to keep the files for failed scan jobs. If the value is set to 0, the maintenance task removes all files every day. The default value is 30.
system.scan.failed-folderThis value is mandatory. A relative path in which failed scan and XML files are saved. The path is relative to the /server/data folder in the PaperCut MF install directory, for example, C:/Program Files/PaperCut MF/server/data/. Alternatively, you can enter a full path to which the server has access. The default path is scan/failed.
system.scan.failed-maintenance-enabledEnables or disables the maintenance task. The default value is N.
system.scan.home-sub-folder(Scan to Folder only) This value is optional. A subfolder under the user’s home folder to save scan and XML files. If you do not specify this value, the scan files are saved in the root of the user's home folder as defined in PaperCut MF. You can specify only one level of subfolder, for example, Scans is valid, but PaperCut MF/Scans is not. The default value is Scans. If it is not set, the top level user’s home folder is used.
system.scan.email-max-job-size-kb(Scan to Email only) This value is mandatory. The maximum email size (in KB) for an email scan job. If a scan job has multiple files, the files are sent in a single email. The default value is 20480 (20 MB).
system.scan.folder-max-job-size-kb(Scan to Folder only) The maximum size of a scan job (in KB), including all scanned documents and XML files, when the scan destination is a folder. The default value is 51200 (50 MB). This value is mandatory.
system.scan.cloud-max-job-size-kb(Scan to Cloud Storage only) This value is mandatory. The maximum size of a scan job (in KB), including all scanned documents, when the scan destination is cloud storage. The default value is 204800 (200 MB).
system.scan.delivery.email-body(Scan to Email only) This value is optional. The default email body to use (if the email body is not specified) when delivering scan files to an email address. You can include the following macros:
  • %user% and %username%—the username of the user sending the message.
  • %date% and %time%—the date and time the message was sent.
  • %full_name%—the full name of the user sending the message.
  • %id_num%—the primary Card/Identity Number of the user sending the message.
  • %client-url%—the URL of the user's page on the server, (for example, http://host-name:9191/user)
This value is empty by default.
system.scan.delivery.allow-overwrite(Scan to Folder and Scan to Email) Whether or not to overwrite existing scan files in the destination folder, if the file name is identical. The default value is N to not overwrite existing files. In this case, an incrementing number (for example, 0001) is appended to the filename for each subsequent scan with the same name. If you set this value to Y, existing files with the same name are overwritten. This value is mandatory.
system.scan.delivery.debug-akkaDefault is N. Set to 'Y' to turn on extra debugging for scan delivery.
system.scan.delivery.custom-dispatcher.enabledSet to 'Y' to enable a custom thread pool for scan job delivery.
system.scan.delivery.custom-dispatcher.pool-sizeControl the size of the custom thread pool for scan job delivery. Requires system.scan.delivery.custom-dispatcher.enabled to be set to 'Y'.
system.scan.jobs-folderThis value is mandatory. A relative path in which scan and XML files are stored temporarily before the scan job is delivered. The path is relative to the /server/data folder in the PaperCut MF install directory, for example, C:/Program Files/PaperCut MF/server/data/. Alternatively, you can enter a full path to which the server has access. The default path is scan/jobs.
system.scan.ocr.cloud.download-polling-timeout-secsThe number of seconds after a scanned file is uploaded that PaperCut MF will wait for the OCR job to download the output file before timing out. The default value is 1800 seconds (30 mins). Minimum value is 300 seconds (5 mins).
system.scan.ocr.transfer-retry-timeout-minsThe number of minutes for a retry to occur when uploading or downloading a file as part of the OCR processing. The retry can occur as many times as possible within the timeout period. The default value is 30 mins. Minimum value is 5 mins.
ext-device.scan.paper-sizesSpecify the list of paper sizes displayed on the device’s Scan Settings screen’s Paper Size field.Values: Comma-separated valid paper sizes:
  • Letter
  • Legal
  • SIZE_11X17 (maps as Ledger on the device)
  • A5
  • A4
  • A3
  • AUTO_SAME (maps as Same on the device)
  • AUTO_MIXED (maps as Mixed on the device)
For example:
  • A3, A4, A5
  • A3, A4, A5, AUTO_MIXED
  • LEGAL, AUTO_SAME
  • AUTO_MIXED
Note:
  • This config key is unavailable by default. It must be manually added and then configured with valid values.
  • Manually adding this config key and configuring it with valid values, overrides the config key system.scan.default-locale.
  • The config key system.scan.default-locale takes effect if:
    • this config key is not added, OR
    • its values are invalid (configured incorrectly), OR
    • its value is empty (not configured)
  • The Auto options are only available on some devices. On these devices:
    • AUTO_SAME - applies the first page’s paper size to all other pages.
    • AUTO_MIXED - retains each page’s original paper size.
ext-device.scan.default-paper-sizeSpecify the default paper size that is highlighted on the device’s Scan Settings screen’s Paper Size field.Values: Any ONE of the following:
  • For ISO standard:
    • A3
    • A4
    • A5
    • AUTO_SAME (maps as Same on the device)
    • AUTO_MIXED maps as Mixed on the device)
    Default: A4
  • For North American standard:
    • Letter
    • Legal
    • SIZE_11X17 (maps as Ledger on the device)
    • AUTO_SAME (maps as Same on the device)
    • AUTO_MIXED (maps as Mixed on the device)
    Default: Letter
Note:
  • This config key is unavailable by default. It must be manually added and then configured with a valid value.
  • Manually adding this config key for a device and configuring it with a valid value, overrides the paper size default specified on the PaperCut MF Admin web interface (Devices > Scan Actions > Details > Input settings > Paper size) for the corresponding device.
  • The paper size default specified on the PaperCut MF Admin web interface (Devices > Scan Actions > Details > Input settings > Paper size) takes effect if:
    • this config key is not added, OR
    • its value is invalid (configured incorrectly), OR
    • its value is empty (not configured).
  • The Auto options are only available on some devices. On these devices:
    • AUTO_SAME - applies the first page’s paper size to all other pages.
    • AUTO_MIXED - retains each page’s original paper size.

Change the hosting region for PaperCut MF Cloud Services

PaperCut MF Cloud Services offers three hosting regions to choose from:

  • Australia

  • Europe (Germany)

  • USA

The hosting region is configured the first time one of the following happens:

  • the first Document Processing feature, (including Batch Splitting or creating text searchable documents using OCR) is configured

  • the first Scan to Cloud Storage scan action is created.

You can change the hosting region at any time.

  1. In PaperCut MF, click Options > Advanced. The Advanced screen in displayed.

  2. In the Cloud Services area, next to the Hosting region field, click Change. A warning message about canceling all active scan jobs is displayed.

  3. Click Change region. A popup is displayed showing the result of the change.

  4. Click Close. From now, all scan jobs will be processed in the new hosting region.

Comments