Advanced configuration
Prev Chapter 16. Integrated Scanning Next

Advanced configuration

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

KeyDescription

system.scan.jobs-folder

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.

This value is mandatory.

system.scan.failed-folder

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.

This value is mandatory.

system.scan.backup-folder

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

Important

The PaperCut MF administrator has full read and write access to this folder, which might contain confidential information.

system.scan.backup-days

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.

This value is mandatory.

system.scan.home-sub-folder

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.

This value is optional. If it is not set, the top level user’s home folder is used

system.scan.email-max-job-size-kb

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 (20MB).

This value is mandatory.

system.scan.folder-max-job-size-kb

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 (50MB).

This value is mandatory.

system.scan.delivery.email-body

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 optional and is empty by default.

system.scan.delivery.allow-overwrite

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 will be overwritten.

This value is mandatory.

Table 16.1. Integrated Scanning system configuration keys

Configure scanning notifications

You can configure notifications to be delivered to users for different scan job events. For example, you can set up a notification to be sent to a user if a scan job fails. Notifications can be either sent by email or displayed in the PaperCut MF client.

You can set up notifications for the following events:

  • the first attempt at a scan delivery fails

  • scan job failure

  • scan job exceeds a maximum size limit

  • scan job successfully delivered

For each of these notifications, you can set the following details:

  • whether or not the notification is enabled

  • the message contained in the notification

  • the subject of the notification

  • whether or not the notification is emailed to the user

  • whether or not the notification is displayed in the PaperCut MF client

Note

If you want to send scan job email notifications, you must ensure that PaperCut MF is configured for email notifications. For more information, see the section called “Configuring Email Notifications” .

The following scanning notification configuration keys are available from Options → Config editor (advanced):

KeyDescription

notify.scan-delivery-first-retry.enabled

Notify the user when the first attempt at a scan delivery fails.

The default value is Y.

notify.scan-delivery-first-retry.message

The notification text sent in the body of the email when the first attempt at a scan delivery fails.

The default value is:

Your scanned document is on its way.

This value is optional.

notify.scan-delivery-first-retry.subject

The subject of the email when the first attempt at a scan delivery fails.

The default value is:

Sending your scanned document

This value is optional.

notify.scan-delivery-first-retry.method.email

Whether or not the notification for the first failed attempt at scan delivery is emailed.

The default value is Y.

notify.scan-delivery-first-retry.method.client

Whether or not the notification for the first failed attempt at scan delivery is displayed in the PaperCut MF client.

The default value is Y.

notify.scan-delivery-failed.enabled

Notify the user when a scan fails.

The default value is Y.

notify.scan-delivery-failed.message

The notification text sent in the body of the email when a scan fails.

The default value is:

There seems to be a problem sending your scanned document:%files%If this persists, please contact your system administrator.

This value is optional.

notify.scan-delivery-failed.subject

The subject of the email sent when a scan fails.

The default value is:

Failure to send your scanned document

This value is optional.

notify.scan-delivery-failed.method.client

Whether or not the notification sent when a scan fails is displayed in the PaperCut MF client.

The default value is Y.

notify.scan-delivery-failed.method.email

Whether or not the notification sent when a scan fails is emailed.

The default value is Y.

notify.scan-max-job-size-exceeded.enabled

Notify the user when a scan fails due to job size exceeding the specified maximum job size limit.

The default value is Y.

notify.scan-max-job-size-exceeded.message

The notification text sent in the body of the email when a scan fails due to job size exceeding the specified maximum job size limit.

The default value is:

Your scanned document is too big:%files%You can try reducing the scanned document size by using a lower resolution, or switching color mode to grayscale or black and white. Alternatively, you can try splitting your job.If you need to send a larger scanned document, please contact your system administrator.

This value is optional.

notify.scan-max-job-size-exceeded.subject

The subject of the email when a scan fails due to the job size exceeding the specified maximum job size limit.

The default value is:

Your scanned document is too big:%files%You can try reducing the scanned document size by using a lower resolution, or switching color mode to grayscale or black and white. Alternatively, you can try splitting your job.If you need to send a larger scanned document, please contact your system administrator.

This value is optional.

notify.scan-max-job-size-exceeded.subject

The subject of the email when a scan fails due to the job size exceeding the specified maximum job size limit.

The default value is:

Failed to send your scanned document

This value is optional.

notify.scan-max-job-size-exceeded.method.client

Whether or not the notification sent when a scan fails due to the job size exceeding the specified maximum job size limit is displayed in the PaperCut MF client.

The default value is Y.

notify.scan-max-job-size-exceeded.method.email

Whether or not the notification sent when a scan fails due to the job size exceeding the specified maximum job size limit is emailed.

The default value is Y.

notify.scan-delivery-completed.enabled

Notify the user when scan delivery is complete.

The default value is Y.

notify.scan-delivery-completed.message

The notification text sent in the body of the email when scan delivery is complete.

The default value is:

Your scanned document has been delivered:%files%

This value is optional.

notify.scan-delivery-completed.subject

The subject of the email when scan delivery is complete.

The default value is:

Successful delivery

This value is optional.

notify.scan-delivery-completed.method.client

Whether or not the notification sent when a scan delivery is complete is displayed in the PaperCut MF client.

The default value is Y.

notify.scan-delivery-completed.method.email

Whether or not the notification sent when a scan delivery is complete is emailed.

The default value is Y.

Table 16.2. Integrated Scanning notification configuration keys

Advanced: Add user home folder and email details

Before a user can use a scan action, you might need to ensure the following user details are set up:

  • valid primary email

  • network home folder

You can set up these details in one of the following ways:

  • synchronize user details from an external source

  • batch import user details

  • manually add user details

Synchronize user details from an external source

You can synchronize your user details from one of the following external sources:

  • Microsoft Active Directory (AD)

  • LDAP

For more information, see the section called “User and Group Synchronization”.

Microsoft Active Directory

  • Home folder—use the homeDirectory attribute. This specifies the home directory for the account. There are two ways to set the home directory. You can use the:

    • local path, which resolves to a full UNC path, including a drive letter, for example, c:\users\joe.

    • a full UNC network path, for example, \\server\users\joe.username

    This value can be a null string.

  • Email address—use the mail attribute. Set mail to the user’s email address.

LDAP

  • Home folder—use the homeDirectory attribute. This specifies the fully qualified local path including the drive letter.

  • Email address—use the mail attribute. Set mail to the user’s email address.

Synchronize user details

After you set up the details in Microsoft Active Directory or LDAP, synchronize the details with PaperCut MF:

  1. In PaperCut MF, select Options → User/Group sync.

  2. Click Synchronize now.

    The new attribute is synced with your PaperCut MF users.

  3. Click Close.

Batch import user details

You can import the user’s home folder and email details from a text file using the Batch User Data Import. For more information, see the section called “Batch User Data Import and Update”.

Manually add user details

If you do not have many users, you can manually add the user details.

  1. Select Users.

    The User List page is displayed.

  2. Click a user.

    The User Details page is displayed.

  3. Add the following details:

    • Primary Email

    • Home directory

Verify the user home directory in PaperCut MF

When the user’s home directories have been synced, check if PaperCut MF can write a file to that destination.

  1. Select Users.

    The User List page is displayed.

  2. Click a user.

    The User Details page is displayed.

  3. In the Details area, click Test below the Home directory field.

    If the home folder is reachable, a green tick is displayed next to this link.

Prev Up Next
Setting up Integrated Scanning Home Reporting

© Copyright 1999-2015. PaperCut Software International Pty Ltd. All rights reserved.