Workflow Basics

This guide will give you a basic overview of all the steps needed to create a scan workflow.

  • Create a connector – connectors allow YSoft SafeQ 6 to connect to external systems such as Microsoft Exchange and shared folders, etc. All workflows (except scan to script) will need one connector, A connector can be used by several different workflows.

  • Create a scan workflow – a workflow allows for the configuration of the scan destination, processing steps executed on documents, scan options, access rights, etc.

Creating a connector


Before creating the first scan workflow, a connector must be created. If a connector is already created or if creating a scan to script workflow, this step can be skipped.

  1. Go to the Connectors screen and click the Add connector button.

  2. Enter the following general information to distinguish this connector from another:

    • Name – a short title, maximum of 64 characters

    • Description – additional information about the connector. Usually, detailed information to understand the purpose of the connector, maximum 300 characters

  3. Select the desired connector type and follow the specific instructions to configure it:

    • File system – see chapter Edit Workflow, section File System

    • Email (SMTP) – see chapter Edit Workflow, section Email (SMTP)

    • Microsoft Exchange – see chapter Edit Workflow, section Microsoft Exchange

    • Dropbox Business/Enterprise – see chapter Edit Workflow, section Dropbox Business/Enterprise

    • Microsoft SharePoint 2010 – see chapter Edit Workflow, section Microsoft SharePoint 2010

    • Microsoft SharePoint 2013 – see chapter Edit Workflow, section Microsoft SharePoint 2013

    • Microsoft OneDrive for Business – see chapter Edit Workflow, section Microsoft OneDrive for Business

    • Microsoft SharePoint Online – see chapter Edit Workflow, section Microsoft SharePoint Online

    • Microsoft SharePoint 2016 – see chapter Edit Workflow, section Microsoft SharePoint 2016

    • HPE Records Manager – see chapter Edit Workflow, section HPE Records Manager

    Some connector types may not be available in your YSoft SafeQ license.

  4. Save changes and continue to workflow creation. The created connector is available to be used in workflows now.

Creating a workflow


Create a workflow using a connector configured in the previous step or without configuring a connector if creating a scan-to-script workflow. Use variables in parameters to further customize the workflow. There are two kinds of variables:

  • capture – defined during the document capture phase, it can be used in both the capture and processing phase, e.g. user and device information

  • user input/process – defined from either a result of processing or user input fields, it can be used in the processing phase only, e.g. outputs from document processing, user input fields

For the list of available variables, see chapter Edit Workflow, section Workflow Variables.

  1. Go to the Workflows screen and click the Add workflow button.

  2. Enter the following general information to distinguish this workflow from another:

    • Name – should be a short description that helps terminal users with workflow selection, maximum 64* characters

    • Description – usually, instructions for the terminal user that provide guidance on using the workflow, maximum 300* characters

    * Some embedded terminals do not support text of this length. In such cases, the text is trimmed.

  3. Select a destination connector or scan to script and fill in information specific to the connector type:

    • File system – see chapter Edit Workflow, section File System

    • Email (SMTP) – see chapter Edit Workflow, section Email (SMTP)

    • Microsoft Exchange – see chapter Edit Workflow, section Microsoft Exchange

    • Dropbox Business/Enterprise – see chapter Edit Workflow, section Dropbox Business/Enterprise

    • Microsoft SharePoint 2010 – see chapter Edit Workflow, section Microsoft SharePoint 2010

    • Microsoft SharePoint 2013 – see chapter Edit Workflow, section Microsoft SharePoint 2013

    • Microsoft OneDrive for Business – see chapter Edit Workflow, section Microsoft OneDrive for Business

    • Microsoft SharePoint Online – see chapter Edit Workflow, section Microsoft SharePoint Online

    • Microsoft SharePoint 2016 – see chapter Edit Workflow, section Microsoft SharePoint 2016

    • HPE Records Manager – see chapter Edit Workflow, section HPE Records Manager

    • Scan to script – see chapter Edit Workflow, section Scan to script

  4. Select the processing that should be applied to documents:

    • Barcode – see chapter Edit Workflow, section Barcode

    • Scan Job Separation – see chapter Edit Workflow, section Scan Job Separation

    • Highlighter extraction – see chapter Edit Workflow, section Highlighter extraction

    • Highlighter redaction – see chapter Edit Workflow, section Highlighter redaction

    • OCR – see chapter Edit Workflow, section OCR

    Some processing steps may not be available in your YSoft SafeQ license.

  5. Select suitable scan settings:

    • Scan resolution – determines the DPI of the scanned document

    • Sides – determines whether the document will be scanned as duplex or simplex

    • Color – determines the color scheme of a scan

    Settings are locked for users on the YSoft SafeQ terminal by default, i.e. terminal users are not allowed to change them. If you want to allow terminal users to customize scan settings, check the Can be modified by the user on the device option below the settings. In this case, the selected values become defaults on YSoft SafeQ terminals.

  6. Define and rearrange user input fields. User input fields are helpful for collecting information from terminal users along with a scanned document. The value of each user input field is stored in a variable and can be accessed in the workflow during processing or delivery. Please note, process variables cannot be used in the capture phase, i.e. variables defined by user input fields cannot be used in other user input fields. Add a new user input by clicking the Add user input button.

  7. Provide roles with access to the workflow. This ensures that users in the roles will be permitted to use the workflow at YSoft SafeQ terminals. If no role is specified, the workflow will not be available to any users.

  8. Save your changes. The workflow is now available on terminals to all users in the roles to whom you provided access. It is suggested to test a newly created workflow first before providing access to the workflow to other users. Test a workflow by providing access to administrators only.