Scan Workflow-related System Settings
Several YSoft SafeQ system settings affect the way the Workflows function. System settings can be found on the YSoft SafeQ System screen under Configuration. System settings are common to all scan workflows and connectors and other YSoft SafeQ 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 YSoft SafeQ. The possible values are:
|
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 | The scan storage type. It can be:
|
NETWORK | Advanced | workflowStorageRoot | C:\SafeQ6\SPOC\terminalserver\scan | Terminal Server Workflow Processing System | The root path to scan storage. Can be a 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 | Enable 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. |
EXPERT | Expert | ocrPoolSize | 1 | Workflow Processing System | The maximum number of scan jobs that involve OCR that will be processed in parallel by a single Workflow Processing System server (scan server). More jobs will wait in a queue. See also ocrProcessesPerJob, which controls the number of OCR threads that can be used to process a single job. Together, these two options limit the number of CPU cores that can be used for OCR processing. For example, ocrPoolSize = 2 and ocrProcessesPerJob = 3 means that the system will process a maximum of two jobs in parallel and will utilize as many as 6 CPU cores in total. If the customer produces a large number of small jobs, you should increase ocrPoolSize and keep ocrProcessesPerJob low. If the customer produces large jobs, you should keep ocrPoolSize low and increase ocrProcessesPerJob. |
EXPERT | Expert | ocrProcessesPerJob | 1 | Workflow Processing System | The maximum number of simultaneous OCR threads that can be used to process a single job. Higher numbers speed up the processing of large scan jobs. The maximum supported value is 8. See also ocrPoolSize, which controls the number of jobs that involve OCR that can be processed in parallel. Note that the number of OCR threads actually used to process a single job is further limited by the number of pages and the total number of CPU cores in the system. Also note that t he final document synthesis is done in a single thread because it cannot be parallelized. Example: ocrPoolSize = 2 a nd ocrProcessesPerJob = 2. At most, two jobs are processed simultaneously. More jobs will wait in a queue. Each job utilizes, at most, two CPU cores. In total, OCR processing may utilize as many as 4 CPU cores. If the host only has four cores, other applications running on the same host may not have enough resources. |
EXPERT | Expert | ocrDefaultProfile | Disabled | Workflow Processing System | The default OCR profile used for all workflows in the OCR processing step. It can be overwritten on a workflow level, see the ocrProfilePerWorkflow system property.
Use this property to set advanced OCR engine parameters (e.g., balance the speed and accuracy of OCR, blank page removal conditions, etc.). If you need any help, please contact Y Soft. Please note that YSoft SafeQ is tested only with the default OCR configuration and it is not possible to test all combinations of different OCR configurations. If you change the configuration, you should test that OCR is working properly. Note: This setting is affecting only OCR processing, other processing using the OCR engine (e.g., highlighted text extraction) is not affected. |
EXPERT | Expert | ocrProfilePerWorkflow | Workflow Processing System | It enables an option to overwrite the default profile (stored in the ocrDefaultProfile system property) per workflow. A new checkbox "Change default OCR Profile" will be available under the OCR processing step in the workflow definition after enabling this property. Please note that YSoft SafeQ is tested only with the default OCR configuration and it is not possible to test all combinations of different configurations. If you change the configuration, you should test that OCR is working properly. | |
EXPERT | Expert | ocrInputFileType | JPG | Workflow Processing System | This specifies the file format of the scan document that is being sent from the MFD for OCR processing. |
FEATURES | Basic | sharepointClientId | Workflow Processing System | The GUID on which the WPS connector add-in is registered (see Impersonation in Sharepoint 2013). | |
FEATURES | Basic | sharepointIssuerId | Workflow Processing System | The GUID on which the identification certificate is registered in Sharepoint (see Impersonation in Sharepoint 2013). | |
FEATURES | Basic | sharepointClientCertificateThumbprint | Workflow Processing System | The thumbprint of the identification certificate (must be installed in the WPS certification storage). Be aware of hidden leading symbols if you copy/paste the value. | |
NETWORK | Expert | useProxy | Disabled | Workflow Processing System | Instructs the system to use a proxy for connecting to the Internet. |
NETWORK | Expert | useHostProxy | Disabled | Workflow Processing System | Instructs the system to use the proxy that the system administrator has set up for the host system. |
NETWORK | Expert | proxyEndpoint | Workflow Processing System | Specify the endpoint for the proxy in the format IP:Port. Example: 127.0.0.1:9999. The parameter is used if useHostProxy is disabled. | |
NETWORK | Expert | proxyAuthenticate | Disabled | Workflow Processing System | Instructs the system to authenticate to the specified property proxyEndpoint . |
NETWORK | Expert | proxyUser | Workflow Processing System | The username to use for authentication to the property proxyEndpoint . Example, "username" or "domain\user". The p arameter is used if proxyAuthenticate is enabled. | |
NETWORK | Expert | proxyPassword | Workflow Processing System | The password to use for authentication to the property proxyEndpoint . Use an encription tool to set this value. The parameter is used if proxyAuthenticate is enabled. | |
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 YSoft SafeQ 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 | NONE | 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, then the direct SSL/TLS (port 465) is used for communication. When set to the STARTTLS option, then a 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 setting "handleSslTlsMailSmtpEncryptionOptionAsStartTls" in mps.config to false. Then there will be no encryption 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 | Management Server Mobile Print Server Site Server Workflow Processing System Payment System | The notification sender's email address for emails sent by YSoft SafeQ (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 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 FILESYSTEM connector is encountered. |
FEATURES | Basic | sharepoint2010ReplacementCharacter | - | Workflow Processing System | The character to be used for replacement when a forbidden character for SHAREPOINT_2010 connector is encountered. |
FEATURES | Basic | sharepoint2013ReplacementCharacter | - | Workflow Processing System | The character to be used for replacement when a forbidden character for SHAREPOINT_2013 connector is encountered. |
FEATURES | Basic | sharepoint2016ReplacementCharacter | - | Workflow Processing System | The character to be used for replacement when a forbidden character for SHAREPOINT_2016 connector is encountered. |
FEATURES | Basic | sharepointOnlineReplacementCharacter | - | Workflow Processing System | The character to be used for replacement when a forbidden character for SHAREPOINT_ONLINE connector is encountered. |
FEATURES | Basic | dropboxReplacementCharacter | - | Workflow Processing System | The character to be used for replacement when a forbidden character for DROPBOX connector is encountered. |
FEATURES | Basic | onedriveReplacementCharacter | - | Workflow Processing System | The character to be used for replacement when a forbidden character for ONEDRIVE 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:
|
TERMINAL ADMINISTRATION | Expert | hpScanJobAssemblyEnabled | Disabled | Terminal Server | This property enables native HP scan job assembly feature. When disabled, the feature is hidden. |