Edit Workflow - Workflow variables

*

%barcode%

all

process

Contains the value extracted from the upper-left most barcode. For more details, see section Barcode.

%barcode<X>%

all

process

Contains each barcode value with X starting from 1. For more details, see section Barcode.

%barcodeInsecure<X>%

all

process

Contains each unmodified barcode value with X starting from 1. The value may contain unsafe user input that should not be directly used in a workflow. For more details, see section Barcode.

%barcode_<JSON key path>%

all

process

Contains barcode JSON values with key path using dot notation replaced by underscore character. For more details, see section Barcode.

%separationBarcode%

all

process

Contains the value extracted from a barcode that triggered a separation of scan jobs. For more details, see section Scan Job Separation.

%billingCode%

all

process

The code of billing code used for this scan job (can be null if none is assigned).

%fileLocations%

all

process

The comma-separated file paths of all scanned files in the destination.

%highlightedText%

all

process

Contains the text from highlighted text extraction. For more details, see section Highlighter Extraction.

%deviceID%

all

capture

The ID of the device where a scan was made.

%deviceName%

all

capture

The name of the device where a scan was made.

%deviceDescription%

all

capture

A description of the device where a scan was made.

%deviceGroupID%

all

capture

The ID of a group to which the device where a scan was made belongs.

%deviceGroupName%

all

capture

The name of a group to which the device where a scan was made belongs.

%deviceGroupIP%

all

capture

The IP address of a group to which the device where a scan was made belongs.

%deviceLocation%

all

capture

The location of the device where a scan was made.

%deviceIP%

all

capture

The IP address of the device where a scan was made.

%deviceActivationDate%

all

capture

The activate date of the device where a scan was made (in the 'YYYY-MM-DD HH:MM:SS.MS' format).

%deviceEquipmentID%

all

capture

The equipment ID of the device where a scan was made.

%deviceServiceAgreementID%

all

capture

The device service agreement ID of the device where a scan was made.

%deviceContactPerson%

all

capture

The contact person for the device where a scan was made.

%deviceCostCenterID%

all

capture

The cost center number of the device where a scan was made.

%deviceCostCenterName%

all

capture

The cost center name of the device where a scan was made.

%invitationLink%

OneDrive for Business (OAuth 2.0)

capture

The invitation link where users authorize access to their OneDrive storage.

%safeqHome%

all

capture

The full path to the folder where YSoft SafeQ is installed on the server where the Workflow Processing System is running (typically C:\SafeQ6).

%scanDate%

all

capture

The local date on Terminal Server at the time of a scan in the format yyyy-MM-dd, e.g., ' 2012-12-21' for December 21, 2012.

%scanTime%

all

capture

The local time on Terminal Server at the time of a scan in format HH-mm-ss-fff, e.g., '12-15-00-000' for a quarter past twelve.

%userCostCenterID%

all

capture

The cost center number of the terminal user who made a scan.

%userCostCenterName%

all

capture

The cost center name of the terminal user who made a scan.

%userEmail%

all

capture

The email of the terminal user who made a scan.

%userFirstName%

all

capture

The first name of the terminal user who made a scan.

%userHome%

all

capture

The home folder of the terminal user who made a scan.

%userSurname%

all

capture

The surname of the terminal user who made a scan.

%userUsername%

all

capture

The YSoft SafeQ username of the terminal user who made a scan.

%pdfPassword%

all

capture

The Password being used to encrypt a PDF document. For more details, see section Highlighter Extraction.

%fileLocations%

except script

capture

The final comma-separated list of processed files, including the path to file. This variable is only accessible in notifications.

%filePath%

script

process

The full path of the currently executed file if script execution mode is "Per file", or the path of the last file processed by the Workflow Processing System if script execution mode is "One time". For more details, see section Scan to Script.

%fileList%

script and external processing step

process

Full path to the file-list file containing the list of all scanned files. Relevant for the External Processing Step and for the "One time" execution mode of the Scan to script destination. For more details, see the sections Scan to Script and External Processing Step.

%metadata%

script and external processing step

process

Full path to the metadata file containing the list of all workflow variables. Relevant for the External Processing Step and for the "One time" execution mode of the Scan to script destination. For more details, see the sections Scan to Script and External Processing Step.

%externalStepExitCode%

all

process

After executing the External Processing Step, this variable will contain the numeric exit code from the external process. If the exit code is not zero, the workflow is aborted and the failure notification is delivered, which is where this variable may be useful.

%externalStepStdOut%

all

process

After executing the External Processing Step, this variable will contain the captured standard output from the external process (but not the standard error output).

%targetDir%

script

process

Specifies the location where scanned files (and optionally, metadata and file list files) are stored. For more details, see section Scan to Script.

%scanJobID%

all

process

The unique ID of the scan job instance. This identifier of the scan job is also visible in the log files.

%scanJobSize%

all

process

A summary of the scan job files sizes. The variable is available only when there is a restriction set on the connector.

%scanJobFileCount%

all

process

The scan job files count. The variable is available only when there is a restriction set on the connector.

%connectorFileCountLimit%

all

process

The max file count restriction limit. The variable is available only when there is a file count restriction set on the connector.

%connectorFileSizeLimit%

all

process

The file size restriction limit. The variable is available only when there is a file size restriction set on the connector.

%connectorRestrictionsDirectory%

all

process

The path to the folder where the scan jobs are stored when a restriction is applied. The variable is available only when there is a restriction set on the connector.

%workflowID%

all

capture

The ID of the workflow used to make the scan.

%workflowName%

all

capture

The name of the workflow used to make the scan.