Scan Workflow-related System Settings

Several Dispatcher Paragon system settings affect the way Workflows function. System settings can be found on the Dispatcher Paragon System screen under Configuration. System settings are common to all scan workflows and connectors and other Dispatcher Paragon modules.

Category

Level

Key

Default value

Used by

Description

NETWORK

Expert

ftp-port

21

Terminal Server

The port used for FTP server communication.

NETWORK

Advanced

ftp-anonymous

true

Terminal Server

If enabled, anonymous login is allowed for FTP server authorization.

NETWORK

Advanced

scanServerType

WebDAV,HTTP,FTP

Terminal Server

The transfer protocols allowed for scanned document transfer from an MFD to Dispatcher Paragon. Possible values are:

  • "FTP" – for the FTP protocol

  • "WebDAV" – for the WebDAV protocol. Can be secured by SSL/TLS, see the webdavSsl system property, only KM and Xerox devices are supported

  • "SwA" - for SOAP with Attachments. Can be used as a secure alternative to FTP on Fuji Xerox devices. Please review the limitation of this methond and recommendation for additional setup in Requirements and known limitations of Dispatcher Paragon Embedded Terminal for FujiXerox

  • "HTTP" is also available as secure alternative for FTP on all Brother and Konica Minolta BSI devices.

  • "WebDAV,FTP" – WebDAV will be used for all MFD vendors that support it. For other vendors, FTP will be used. Note that MFDs using WebDAV must be correctly configured in order to function.

NETWORK

Advanced

scanServerUsername

anonymous

Terminal Server

The username used by embedded terminals to authorize on a scan server (FTP or WebDAV) before sending data.

NETWORK

Advanced

scanServerPassword

code,-31,-2,43,-90,-103,124,3,-49,58,-107,-31,40,74,-57,-1,-120

Terminal Server

The password used by embedded terminals to authorize on a scan server (FTP or WebDAV) before sending data.

NETWORK

Advanced

workflowStorageType

local

Terminal Server

Workflow Processing System

Scan storage type. Can be:

  • local: local server folder

  • remote: network shared folder

  • webdav: webdav server shared folder

NETWORK

Advanced

workflowStorageRoot

C:\Dispatcher Paragon\SPOC\terminalserver\scan

Terminal Server

Workflow Processing System

The root path to scan storage. Can be the relative path to WPS/Terminal Server or a UNC path, see the workflowStorageType parameter.

NETWORK

Advanced

workflowRemoteStorageUsername


Terminal Server

Workflow Processing System

The username to access remote scan storage, e.g., "qa13s162\Administrator"

NETWORK

Advanced

workflowRemoteStoragePassword

code,-31,-2,43,-90,-103,124,3,-49,58,-107,-31,40,74,-57,-1,-120

Terminal Server

Workflow Processing System

The encrypted password to access remote scan storage.

NETWORK

Expert

webdavSsl

Enabled

Terminal Server

Enables the use of the SSL protocol for connection to WebDAV repositories. When this setting is enabled, all WebDAV connections will be secured. When it is disabled, encryption for WebDAV connections is disabled.

NETWORK

Expert

webdavPort

5610

Terminal Server

The port used to connect to the WebDAV server.

NETWORK

Expert

soapWithAttachmentsSsl

Enabled

Terminal Server

Enable the use of SSL protocol for connection to SOAP with Attachments (SwA) endpoints. When this setting is enabled, all SOAP with Attachments connections will be secured. When it is disabled, encryption for SOAP with Attachments connections is disabled.

NOTIFICATIONS

Basic

mailserver


Management Server

Mobile Print Server

Site Server

Workflow Processing System

Payment System

The IP address or hostname of the primary mail (SMTP) server. Used by Dispatcher Paragon to send all emails, including scans, notifications, alerts, and reports.

NOTIFICATIONS

Advanced

mailSmtpPort

25

Management Server

Mobile Print Server

Site Server

Workflow Processing System

Payment System

The TCP port used for communication with the SMTP mail server

NOTIFICATIONS

Advanced

mailSmtpEncryption

Disabled

Management Server

Mobile Print Server

Site Server

Terminal Server

Workflow Processing System

Payment System

NONE is the default value, which means no encryption is used.

When set to the SSL/TLS option, the direct SSL/TLS (port 465) is used for communication.

When set to the STARTTLS option, the STARTTLS command is sent after the communication channel is created (port 587) to upgrade to the secured channel.

NOTE: Mobile Print Server does not support the SSL/TLS encryption option. It always uses STARTTLS. This behavior can be overridden by the setting "handleSslTlsMailSmtpEncryptionOptionAsStartTls" in mps.config to false. Then no encryption will be used for the SSL/TLS option



NOTIFICATIONS

Basic

mailuser


Management Server

Mobile Print Server

Site Server

Workflow Processing System

Payment System

The username used to log into the SMTP server. Use only if your SMTP server requires authentication, otherwise, leave empty.

NOTIFICATIONS

Basic

mailpass


Management Server

Mobile Print Server

Site Server

Workflow Processing System

Payment System

The password used to log into the SMTP server. Use only if your SMTP server requires authentication, otherwise, leave empty.

NOTIFICATIONS

Basic

mailfrom

noreply@example.com

Management Server

Mobile Print Server

Site Server

Workflow Processing System

Payment System

The notification sender's email address for emails sent by Dispatcher Paragon (that is, what will be in the From: header).

NOTIFICATIONS

Expert

mailEncoding

utf-8

Site Server

Workflow Processing System

The encoding used for creating email messages.

EXPERT

Expert

scanDateFormat

yyyy-MM-dd

Site Server

Workflow Processing System

The C# string format for the date used in the scanDate variable.

EXPERT

Expert

scanTimeFormat

HH-mm-ss-fff

Site Server Workflow Processing System

The C# string format for the time used in the scanTime variable. The list of formats is available here https://msdn.microsoft.com/en-US/library/8kb3ddd4(v=vs.110).aspx

Note, be careful when using scanTime/scanDate variables in file names. They may contain invalid characters (for example, ":").

FEATURES

Basic

filesystemReplacementCharacter

-

Workflow Processing System

The character to be used for replacement when a forbidden character for the FILESYSTEM connector is encountered.

FEATURES

Advanced

scanJobsDetailAccounting

Disabled

Management Server

Site Server

If enabled, the administrator can enter detailed prices for the accounting of scan jobs depending on color (B&W/color) and paper size (large/small).

TERMINAL ADMINISTRATION

Advanced

sharpPdfCompressionLevel

LOW

Terminal Server

Specifies the PDF compression level for Sharp devices, can be:

  • LOW = the highest quality, the biggest file

  • MIDDLE

  • HIGH = the lowest quality, the smallest file

TERMINAL ADMINISTRATION

Expert

hpScanJobAssemblyEnabled

Disabled

Terminal Server

This property enables native HP scan job assembly feature. When disabled, the feature is hidden.