Task Variables
Every task outputs values of certain variables. You can use these values in other tasks, or in the Variable Monitor task. You can view the list of Task Variables using the 'Utilities' Menu - 'Task Variables'.
Using task variables in text fields
|
Task Type |
Variable Name |
Variable Description |
|
All Tasks |
LastTaskTitleRun |
Task title of last task run |
|
All Tasks |
LastTaskTypeRun |
Task Type of last task run LOC:: returns the localized version of the variable. |
|
All Tasks |
LastExitCode |
Exit Code of last task run |
|
All Tasks |
TaskType::LastTaskRun |
Task title of last task run for each task type |
| Engine | CurrentInstanceRunningTasks | Total currently running tasks in current instance of engine. Not reset to 0 if engine shuts down while tasks are running |
| Engine | StoppedInstanceRunningTasks | Updated periodically during maintainance task and shutdown requests while engine is waiting for tasks to complete. Reset to 0 when engine shuts down |
| Eingine | StoppedInstanceKilledTasks | Total running tasks when engine shuts down due to wait time expired |
|
All Tasks |
TaskTitle::ExitCode |
Task exit code value |
|
All Tasks |
TaskTitle::LastRunEndTime |
Time last run finished |
|
All Tasks |
TaskTitle::LastRunStartTime |
Time last run started |
|
All Tasks |
TaskTitle::LastRunRunTime |
Duration of last run |
|
Command |
TaskTitle::ErrorMsg |
Task error message. This variable is BLANK unless an error is detected during the task run. This variable is set to BLANK before each run. |
|
Command |
TaskTitle::OutputMsg |
Task output message. This variable is BLANK unless output is detected during the task run. This variable is set to BLANK before each run. |
|
WinCommand |
TaskTitle::ErrorMsg |
Task error message. This variable is BLANK unless an error is detected during the task run. This variable is set to BLANK before each run. |
|
CopyFile |
TaskTitle::TotalFiles |
Number of files in directory |
|
CopyFile |
TaskTitle::PassFilename |
Number of files passing filename filter check |
|
CopyFile |
TaskTitle::PassDate |
Number of files passing date modified criteria |
|
CopyFile |
TaskTitle::ForceCopy |
Number of older(or same) source files copied |
|
CopyFile |
TaskTitle::SourceOlder |
Number of source files older (or same date) than target files (i.e. not copied) |
|
CopyFile |
TaskTitle::CopyFailed |
Number of files failed to copy |
|
CopyFile |
TaskTitle::DeleteFailed |
Number of files failed to delete after move/rename options |
|
CopyFile |
TaskTitle::FilesCopied |
Number of files copied |
|
DeleteFile |
TaskTitle::TotalFiles |
Number of files in directory |
|
DeleteFile |
TaskTitle::PassFilename |
Number of files passing filename filter check |
|
DeleteFile |
TaskTitle::PassDate |
Number of files passing date modified criteria |
|
DeleteFile |
TaskTitle::FilesDeleted |
Number of files deleted |
|
ZipDirs |
TaskTitle::TotalFiles |
Number of files in directory |
|
ZipDirs |
TaskTitle::PassFilename |
Number of files passing filename filter check |
|
ZipDirs |
TaskTitle::PassDate |
Number of files passing date modified criteria |
|
ZipDirs |
TaskTitle::FilesZipped |
Number of files zipped |
|
ZipDirs |
TaskTitle::ZipFilePath |
Zip file path |
|
ZipDirs |
TaskTitle::ZipFileSize |
Zip file size |
|
TextSearch |
TaskTitle::FilesSearched |
Number of files searched |
|
TextSearch |
TaskTitle::FilesFound |
Number of files search term(s) were found in |
|
TextSearch |
TaskTitle::TotalFound |
Total number of times search terms were found |
|
TextSearch |
TaskTitle::ResultsFile |
Results filename |
|
TextSearch |
TaskTitle::TotalTermsFound |
Total number of search terms found. This variable is useful for searches in single file. If you have X search terms, but only Y terms were found in 1 file, then the value of this variable = Y. But if, you have multiple files being searched, this value may be greater than the number of search terms. |
|
TextSearch |
TaskTitle::LastLineNumber |
The last line number where a search term was found. Value is 1000000 if no search term is found. |
|
Ftp |
TaskTitle::TotalFiles |
Number of files in directory |
|
Ftp |
TaskTitle::LocBackup |
Total local files backed up |
|
Ftp |
TaskTitle::FailLocBackup |
Total local files failed to back up |
|
Ftp |
TaskTitle::RemBackup |
Total remote files backed up |
|
Ftp |
TaskTitle::FailRemBackup |
Total remote files failed to back up |
|
Ftp |
TaskTitle::FilesDeleted |
Total source files deleted |
|
Ftp |
TaskTitle::DeleteFailed |
Total source files failed to delete |
|
Ftp |
TaskTitle::FailRename |
Total temporary files failed to rename |
|
Ftp |
TaskTitle::PassFilename |
Total files meeting filename criteria |
|
Ftp |
TaskTitle::PassDate |
Total files meeting filename and date criteria |
|
Ftp |
TaskTitle::PassNew |
Total files meetings newly modified files criteria |
|
Ftp |
TaskTitle::FailedXfers |
Total failed transfers |
|
Ftp |
TaskTitle::FilesXfered |
Total files transferred |
|
FtpMonitor |
TaskTitle::SourceDir |
Remote Directory being monitored |
|
FtpMonitor |
TaskTitle::DirChanged |
true if directory change is detected since last run, else false |
|
FtpMonitor |
TaskTitle::FileFound |
Name of last file found that satisfies the monitoring criteria |
|
FtpMonitor |
TaskTitle::FirstFileFound |
Name of first file found that satisfies the monitoring criteria |
|
FtpMonitor |
TaskTitle::FileSize |
Size of file found that satisfies the monitoring criteria |
|
FtpMonitor |
TaskTitle::FileDate |
Date of file found that satisfies the monitoring criteria |
|
FtpMonitor |
TaskTitle::TotalFiles |
Total files in directory, if 'Total Files' criteria is selected |
|
Ftp Monitor |
TaskTitle::PassFileName |
Number of files that pass the filename filter |
|
Ftp Monitor |
TaskTitle::Filenames |
Files that pass monitoring criteria. The format is #file1^#file2... so that this variable can be directly used in other tasks filename field (example copy/ftp/delete etc..) |
|
Ping |
TaskTitle::LastResult |
Last result for this task |
|
Ping |
TaskTitle::TestCount |
Total test count |
|
Ping |
TaskTitle::UpCount |
Total successfull connections |
|
Ping |
TaskTitle::UpPercent |
Percent uptime |
|
Ping |
TaskTitle::LastRuntime |
Last run time |
|
Telnet |
TaskTitle::Response1 |
The initial connection response from server + login prompt (All task variables are reset to BLANK before task runs) |
|
Telnet |
TaskTitle::Response2 |
password prompt |
|
Telnet |
TaskTitle::Response3 |
Authentication response/welcome message |
|
Telnet |
TaskTitle::Response4+ |
Response4, Response5 etc.. are the reply strings from the server for each command you send. |
|
Telnet(Adv) |
TaskTitle::Response1 |
The initial connection response from server + login prompt (All task variables are reset to BLANK before task runs). |
|
Telnet(Adv) |
TaskTitle::Response2 |
password prompt |
|
Telnet(Adv) |
TaskTitle::Response3 |
Authentication response/welcome message |
|
Telnet(Adv) |
TaskTitle::Response4+ |
Response4, Response5 etc.. are the reply strings from the server for each command you send. |
|
EmailBulk |
TaskTitle::Successful |
Number of Successful emails |
|
EmailBulk |
TaskTitle::Failed |
Number of Failed emails |
|
EmailBulk |
TaskTitle::Total |
Number of Total emails |
|
EmailCheck |
TaskTitle::PassCrit1 |
Number of messages passing criteria 1 |
|
EmailCheck |
TaskTitle::PassCrit2 |
Number of messages passing criteria 2 |
|
EmailCheck |
TaskTitle::Messages |
Number of messages being downloaded |
|
EmailCheck |
TaskTitle::Subject |
Subject for the last email downloaded |
|
EmailCheck |
TaskTitle::From |
Sender for the last email downloaded |
|
Database SQL |
TaskTitle::Rows |
Number of rows returned or updated |
|
File Monitor |
TaskTitle::FileName |
Filename for the last file that satisfied the monitoring criteria |
|
File Monitor |
TaskTitle::FirstFileName |
Filename for the first file that satisfied the monitoring criteria |
|
File Monitor |
TaskTitle::FilePath |
Filepath for the file that satisfied the monitoring criteria |
|
File Monitor |
TaskTitle::FileSize |
File size in bytes for the file that satisfied the monitoring criteria |
|
File Monitor |
TaskTitle::FileDate |
File timestamp for the file that satisfied the monitoring criteria |
|
File Monitor |
TaskTitle::TotalFiles |
Total files in directory, if total files criteria is selected |
|
File Monitor |
TaskTitle::PassFileName |
Number of files that pass the filename filter |
|
File Monitor |
TaskTitle::Filenames |
Files that pass monitoring criteria. The format is #file1^#file2... so that this variable can be directly used in other tasks filename field (example copy/ftp/delete etc..) |
|
Dir Monitor |
TaskTitle::Filenames |
Files that pass monitoring criteria. The format is #file1^#file2... so that this variable can be directly used in other tasks filename field (example copy/ftp/delete etc..) |
|
Dir Monitor |
TaskTitle::ModifiedObjects |
Total modified objects (directories + files) in directory tree |
|
Dir Monitor |
TaskTitle::TotalObjects |
Total objects (directories + files) in directory tree |
|
Dir Monitor |
TaskTitle::FileName |
Last filename that passes monitoring criteria. |
|
Dir Monitor |
TaskTitle::FirstFileName |
First filename that passes monitoring criteria. |
|
Ftp Command |
TaskTitle::ResponseX |
Response1, Response2 etc.. are the reply strings from the ftp server for each command you send |
|
Chain |
TaskTitle::LastRunStepTitle |
Latest step task title run in this chain task |
|
Chain |
TaskTitle::LastRunStepType |
Latest step task type run in this chain task |
|
Chain |
TaskType::LastRunStepTitle |
Latest step task title run in any chain task |
|
Chain |
TaskType::LastRunStepType |
Latest step task type run in any chain task |
|
Web |
TaskTitle::FileSize |
File size as reported by web server |
|
Web |
TaskTitle::TotalBytes |
Total bytes downloaded |
|
Web |
TaskTitle::ContentType |
File content type |
|
Web |
TaskTitle::ContentEncoding |
File content encoding |
|
Web |
TaskTitle:: LastModifiedHeader |
value of the last-modified header field |
|
Web |
TaskTitle:: DateHeader |
value of the date header field |
|
Web |
TaskTitle:: ExpirationHeader |
value of the expires header field |
|
LogFile Monitor |
TaskTitle::TotalAlerts |
Total new alerts detected in this run |
|
LogFile Monitor |
TaskTitle::AlertLines |
Variable contains all new alert lines. Use the File variable task to output lines to file. |
|
LogFile Monitor |
TaskTitle::LastAlertTime |
Last alert time |
| Unzip Archive | TaskTitle::TotalFiles | Total files extracted |
| Unzip Archive | TaskTitle::TotalZips | Total zip files |
| Unzip Archive | TaskTitle::TotalSuccessUnzip | Total zip files successfully unzipped |
| Unzip Archive | TaskTitle::TotalFailUnzip | Total zip files failed to unzip |
| Unzip Archive | TaskTitle::FailZipnames | Zip filenames which failed to unzip |
| Unzip Archive | TaskTitle::SuccessZipnames | Zip filenames successfully unzipped |