Scan workflows can be created and edited in the SAFEQ Cloud web UI on the “Workflows” tab in the “Scan Workflows” section.
Adding/editing a workflow
- Go to “Scan Workflows” > “Workflows”.
- To add a workflow, click the “Add” button.
- To modify a workflow, click the edit icon aside from the selected workflow.
The form is the same for adding and editing a workflow and consists of several sections with a specific set of fields.
General
Fields with basic information about the workflow.
Destination
Fields specific to a selected Scan Connector. Initially, only the “Destination” field is available, upon selecting a Connector, its per-workflow customizable fields are shown below. Connectors are managed separately.
Processing
Additional workflow processing can be enabled in this section. Same as with destination, when a Processing step is enabled, its configurable fields are shown.
Output
Fields with general output file settings for the scan.
Available formats are PDF, Compact PDF, JPEG, TIFF, and Multipage TIFF.
When OCR processing is enabled
Upon enabling the OCR processing in the above sections, available formats change to Searchable PDF, Microsoft Word, Microsoft Excel, Microsoft PowerPoint, RTF, and TXT.
There are also additional options possible to configure when the Searchable PDF format is selected.
Scan settings
Fields with general scanner settings.
Changing the order of workflows
To alter the order in which workflows are presented on terminals (and in this configuration), the “Reorder” button in the list of workflows will switch to re-ordering mode, where paging is disabled and individual workflows can be dragged & dropped in the desired position.
Deleting a workflow
A workflow can be deleted by the user with the “DeleteScanWorkflow” permission, either directly from the list or via the “Delete” button in the individual workflow’s detail.
Workflow variables
Variables are used to further customize workflows.
Variables start with the %
character followed by a variable name (no spaces allowed) and end with the %
character, e.g. %userEmail%
, %userFullName%
, etc.
Name | Usage |
---|---|
%userEmail% |
The email of the terminal user who made a scan. |
%userFullName% |
The full name of the terminal user who made a scan. |
%userDepartment% |
The department of the terminal user who made a scan. |
%userHome% |
The home folder of the terminal user who made a scan. |
%deviceName% |
The name of the device where a scan was made. |
%deviceID% |
The ID of the device where a scan was made. |
%deviceDescription% |
The description of the device where a scan was made. |
%scanDate% |
The local date on the SAFEQ Cloud server at the time of a scan in the format yyyy-MM-dd, e.g., ’2022-12-21’ for December 21, 2022. |
%scanTime% |
The local time on the SAFEQ Cloud server at the time of a scan in format HH-mm-ss-fff, e.g., ’12-15-00-000’ for the quarter past twelve. |
%workflowID% |
The ID of the workflow used to make the scan. |
%workflowName% |
The name of the workflow used to make the scan. |
%scanJobID% |
(available only during scan workflow execution) The unique ID of the scan job instance. This identifier of the scan job is visible also in the log files. |
If the information is not configured, e.g. %userFullName%
, %deviceDescription%
is not set, the variable will be replaced with an empty value: User full name is userFullName. → User full name is .
Post your comment on this topic.