Variables List

The Variable Selection Dialog allows inserting Variables automatically, choosing from a drop down list containing a mix of server standard variables and user created variables (Global questions, workflow questions, processing derived such as Barcode and OCR recognition). The server standard variables are:

General

ACTIVATIONKEYMachine unique hardware activation key
LICENSEKEYCurrent installed license key
SMTPAUTHENTICATION
SMTP server authentication enabled (true/false)
SMTPIMPLICITSSLSMTPserver Implicit SSL enabled (0/1)
SMTPPASSWORDGeneral configured password for SMTP authentication
SMTPPORTGeneral configured SMTP server port
SMTPSERVERGeneral configured SMTP server address
SMTPSSLSMTP server SSL enabled (true/false)
SMTPUSERNAMEGeneral configured username for SMTP authentication

Date and Time

YYear in 1-digit format
YYYear in 2-digit format
YYYYYear in 4-digit format
MMonth in 1-digit format, without leading-zero
MMMonth in 2-digit format, with leading zero
MMMMonth in short text format
MMMMMonth in long text format
DDay in 1 digit-format, without leading-zero
DDDay in 2 digit-format, with leading-zero
DDDDay in short text format
DDDDDay in long text format
HH12Hour in 12-hour format
HH24Hour in 24-hour format
NMinutes without leading-zero
NNMinutes with leading-zero
SSeconds without leading-zero
SSSeconds with leading-zero
WWeek of year as decimal number in 1-digit format
WWWeek of year as decimal number in 2-digit format
W4Week number with the four days calendar rule in 1-digit format
WW4Week number with the four days calendar rule in 2-digit format
FMilliseconds in 1-digit format
FFMilliseconds in 2-digit format
FFFMilliseconds in 3-digits format
DATELONGLong date pattern in format “Wednesday May 16, 2001”
DATESHORTShort date pattern in format “5/16/2001”
TIMELONGLong time pattern in format “3:02:15 AM”
TIMESHORTShort time pattern in format “3:02 AM”
UTCHH24Coordinated Universal Time 24-hour format
UTCHH12Coordinated Universal Time 12-hour format
UTCNNCoordinated Universal Time Minutes with leading-zero
UTCNCoordinated Universal Time Minutes without leading-zero
UTCDDDDCoordinated Universal Time Day in long text format
UTCDDDCoordinated Universal Time Day in short text format
UTCDDCoordinated Universal Time Day in 2 digit-format, with leading-zero
UTCDCoordinated Universal Time Day in 1 digit-format, without leading-zero

Filenames

PROCESSFILENAMEInternal process filename of the document being stored

PROCESSFILENAMEWITHOUTEXTENSION
Internal process filename of the document being stored without extension
PROCESSFILENAMEWITHPATHFull path internal filename of the document being stored
PROCESSFILENAMEWITHPATHWITHOUTEXTENSIONFull path internal filename of the document being stored without extension
ORIGINALFILENAMEPATHOriginal file path (e.g. d:\test\input)ORIGINALFILENAMEOriginal filename of the document being processed (e.g. Input.pdf)
ORIGINALFILENAMEWITHOUTEXTENSIONOriginal filename of the document being processed without extension  (e.g. Input )
ORIGINALFILENAMEEXTENSIONOriginal filename extension of the document being processed (e.g. .pdf)
ORIGINALFILENAMEWITHPATHFull path original filename of the document being processed (e.g. d:\test\input\Input.pdf)
ORIGINALFILENAMEWITHPATHWITHOUTEXTENSIONFull path original filename of the document being processed without extension (e.g. d:\test\input\Input)
ORIGINALFILESIZEOriginal file size of the document being processed
PAGESCOUNTERNumber of pages composing the current document being processed
CURRENTPAGESCOUNTERNumber of pages composing the current block document being processed, e.g. during the split document
CURRENTPAGECurrent process page

Image properties

IMAGEBITSDEPTHBits depth of the current image being processed
IMAGEHEIGHTHeight in pixel of the current image being processed
IMAGEHRESOLUTIONHorizontal resolution of the current image being processed
IMAGEVRESOLUTIONVertical resolution of the current image being processed
IMAGEWIDTHWidth in pixel of the current image being processed

Clients

CLIENTADDRESSClient IP address if using client capture
CLIENTMACADDRESSClient MAC address (or serial number) if using client capture

Users

USERDEPARTMENTUser department, will only be set if a user authentication source is enabled
USERDOMAINUser domain, will only be set if a user authentication source is enabled
USERMAILUser email will only be set if a user authentication source is enabled
USERHOMEFOLDERUser home folder, will only be set if a user authentication source is enabled
USERNAMEUser name, will only be set if a user authentication source is enabled or an authentication software is installed on the MFP
USERPASSWORDUser password, will only be set if a user authentication source is enabled
USERFIRSTNAMEUser first name, will only be set if a user authentication source is enabled
USERLASTNAMEUser last name, will only be set if a user authentication source is enabled
USERFULLNAMEUser full name, will only be set if a user authentication source is enabled
USERADSWhen using SSO returs user ADS

Workflows

WORKFLOWCOUNTERReturns the number of times a document was processed with that workflow.
WORKFLOWERRORReturn the same log line marked as Error (ONLY IN THE  FAILOVER CONDITION)
WORKFLOWFAILOVERCOUNTReturn the failover number count workflow.
WORKFLOWIDThe internal id of the current workflow
WORKFLOWNAMEThe name of the current workflow
WORKFLOWMODULESReturn the modules list, comma separated, used for the current document being processed (e.g.: Watch Folder, Barcode Reader, Windows File System)

Barcode

BARCODEREADER_SEPARATIONPAGESIn it you can find the pages where separation occurred (example: 3,7,8,9)
BARCODE01_P01(or name your barcode)In case there were barcodes for multiple pages, NAMEBARCODE_P and the last two numbers eg MYBARCODE_P07 (get barcode if present on page 7)

Email Capturing

EMAILATTACHMENTSNumber of attachments to the mail
EMAILATTACHMENTSIZESize of attachment to the mail
EMAILBCCSList of emails in hide cc
EMAILBODYBody of mail
EMAILCCSList of emails in cc
EMAILDOMAINDomain of the email
EMAILHTMLBODYEmail html body for email capturing
EMAILMESSAGEIDEmail internal ID for email capturing
EMAILPASSWORDEmail password for email capturing
EMAILPORTEmail port for email capturing
EMAILRECIPIENTSEmail recipients for email capturing
EMAILSENDEREmail sender for email capturing
EMAILSERVEREmail server for email capturing
EMAILSUBJECTEmail subject for email capturing
EMAILUSERNAMEEmail username for email capturing
EMAILISSIGNEDCheck if the signed / certified email for email capturing
EMAILDATESENTEmail data sent for email capturing
EMAILDATARECEIVEDEmail data received for email capturing
EMAILMESSAGEIDEmail internal ID for email capturing

FreeForm

FREEFORMCONFIDENCEConfidence level of FreeForm profile on the processing document
FREEFORMPROFILEName of FreeForm profile recognized

FTP

FTPFOLDERFTP folder for ftp capturing
FTPPASSWORDFTP password for ftp capturing
FTPPORTFTP port for ftp capturing
FTPSERVERFTP server for ftp capturing
FTPUSERNAMEFTP username for ftp capturing

HL7 Input

HL7INPUTSUBPATH
Return the path from the root selected HL7 input source folder to the subfolder where the message has been inserted (only works if  Check subfolder has been enabled)

Image processing

IMAGEPROCESSING_REMOVEDEMPTYPAGESTotal amount of detected and removed pages by the image processing module
IMAGEPROCESSING_EMPTYPAGESCONFIDENCEList of confidence for every removed page, separated by ; (PAGE:CONFIDENCE;PAGE:CONFIDENCE;…)

OCR

ABBYYKEYCurrent installed Abbyy license key
ABBYYPAGESLEFTNumber of remaining monthly pages allowed to scan with the current installed Abbyy license (if any)
IR_MONTHLYPAGESMonthly pages available in the current license for the Smart Invoice module
IR_MONTHLYPAGESLEFTNumber of remaining monthly pages allowed to process with the current installed Smart Invoice license (if any)
IR_TOTALLINEITEMS, IR_TOTALLINEITEMS_PXTotal number of line items found in the current invoice by the Smart Invoice module. If multipage document _PX will indicate the page where X is the page number.
IR_TOTALPAGESTotal amount of document pages for the Smart Invoice module
OCRENGINEThe OCR engine used by either of the OCR main process or OCR zone / rule modules
OCRENGINE, ICRENGINE, MICRENGINE, OMRENGINE, SMARTOCRENGINE, ZOCRENGINEText found during OCR
OCRTEXTFILEIt is a full path pointing to the text file that contains the ocr (temporary text file, which will be deleted at the end of the process)
OMRROWSCOUNTNumber or rows when using OMR with Abbyy Engine and zones group
ZONEOCR_SEPARATIONPAGESIn it you can find the pages where separation occurred (example: 3,7,8,9)

Unique Counter

Note

Available for: Windows File System (WFS), Data Output connectors and Data Export and Report Generator modules.

UNIQUECOUNTERUnique number which increases when name/file exists
UNIQUECOUNTER3Unique number which initially not existing when file doesn’t exist, it is formatted by x (3) digits (e.g. 000)
UNIQUECOUNTER3+7Unique number which initially not existing when file doesn’t exist, it is formatted by x (3) digits and starting from y (7) (e.g. 007)
UNIQUECOUNTER3+7IUnique number which (Inclusive) same as before but initially inclusive (so first file it will come directly with 007 rather than empty) -> this is your case
UNIQUECOUNTER3+7+_existing or not initially according the usage of I which can be added or not but using the _ character as separation from the previous filename (e.g. _007). This is for cases when you don’t want the extra char when the counter isn’t used (example without I so counter not used initially) because if you put the _ in the filename then the initially filename will just end in _ being without the counter.

Verification

VERIFICATION_APPROVER_USERNAMEUsername of the user approver document in verification
VERIFICATION_APPROVER_PASSWORDPassword of the user approver document in verification
VERIFICATION_APPROVER_ADSComplete strinf RDN of AD user approver document in verification
VERIFICATION_APPROVER_DESCRIPTIONDescription (if available in AD) of user approver document in verification
VERIFICATION_APPROVER_EMAILEmail (if available in AD) of the user approver document in verification
VERIFICATION_APPROVER_HOMEFOLDERHomeFolder (if available in AD) of user approver document in verification

Web / API

WEBCAPTUREURL
The Web Service URL specified in the module settings
WEBCAPTURENAMESPACEThe Web Service Namespace specified in the module settings
WEBCAPTUREUSERNAMEUsername to login to the Web Service as specified in the module settings
WEBCAPTUREPASSWORDPassword to login to the Web Service as specified in the module settings

WatchFolder

WATCHFOLDERSUBPATH
Return the path from the root selected Watchfolder to the subfolder where the file has been inserted (only works if  Check subfolder has been enabled)
Next Article

Escaping the % sign