Internal Variables
|
Description |
The
Internal-Variables are a powerful feature. They consist of an extensive
set of variables which you can use in the workflow-script. During runtime
the variables are substituted with their respective values.
You can choose
from the following sets of internal variables;
|
|
File |
|
Contains
the complete path and filename of the file that was found by a
daemon. |
|
Contains
the complete filename of the file that was found. |
|
Contains
the extension of the file that was found. |
|
Contains
the filename without its extension. |
|
Directory |
|
Contains
the directory which the workflow was programmed to scan. This is the
"Scan Directory" value of the workflow properties |
|
Contains
the complete path of where the file was found. |
|
Contains
the subdirectory in which the file was found relative to
<ScanDir>. (<SubDir> = <ScanPath> -
<ScanDir>) |
|
FileInfo |
|
Contains
the size of the current file in bytes. |
|
Contains
the timestamp of the file in the format "dd-mmm-yyyy
hh:mm:ss". |
|
Contains
the creation timestamp of the file in the format "dd-mmm-yyyy
hh:mm:ss". |
|
Contains
the last-accessed timestamp of the file in the format "dd-mmm-yyyy
hh:mm:ss". | <FileLastWritten> |
Contains
the last-written timestamp of the file in the format "dd-mmm-yyyy
hh:mm:ss". |
|
Contains,
on NTFS filesystems, the owner of the file. |
|
Contains
the number of the file that is currently being
processed. |
|
Contains
the total number of files that were found in "Scan
Directory". |
|
Date |
|
Contains
the current date in the "dd-mmm-yyyy" format. |
|
Contains
the current date in the "yyyy-mm-dd" format. | <ddmmyyyy> |
Contains
the current date in the "ddmmyyyy" format. | <yyyymmdd> |
Contains
the current date in the "yyyymmdd" format. | <yymmdd> |
Contains
the current date in the "yymmdd" format. |
|
Contains
the current day-of-the-month number. |
|
Contains
short-form of the current month. |
|
Contains
the numerical month-of-the-year number in mm format (may is
05). |
|
Contains
the numerical month-of-the-year number in m format (may is
5). |
|
Contains
the complete current year-number. |
|
Contains
only the last two digits of the current year. |
|
Contains
the current week-number. |
|
Contains
the current day-of-the-week. 1=monday. |
|
Contains
the current day-of-the-year (1-365). |
|
Contains
the current quarter (1-4). |
|
Time |
|
Contains
the current time in the "hh:mm:ss" format. |
|
Contains
the current time in the "hhmmss" format. |
|
Contains
the system-time hour. |
|
Contains
the system-time minute. |
|
Contains
the system-time second. |
|
Contains
the system-time milli-second. |
|
Workflow |
|
Contains
the name of the active workfow. |
|
Contains
the description of the active workflow. |
|
Contains
the hotfolder setting of the active workflow. |
|
Contains
the complete path/filename of the logfile of the active
workflow. |
|
Contains
the number of errors the current workflow has had since last
startup. |
|
Contains
the name of the parent-workflow (when a workflow has been activated
with the ForkWorkflow command). |
|
Contains
the complete path/filename of the logfile of the
parent-workflow. | <RootWorkflow> |
Contains
the name of the root-workflow (oldest parent workflow) from which
the workflow was launched. |
|
Contains
the value set by the "Set Workflow Value" command of the "SetWorkflow" plugin. | <ProcessedFilesWorkflow> |
Contains
the number of files that have been processed by the
workflow. |
|
Contains
the current ForEach-value during a ForEach command. |
|
Contains
the current numerical index for the current ForEach step during a ForEach command. |
|
Contains
the maximum value of the current ForEach command. |
|
Contains
the current ForNext-value during a ForNext
command. |
|
System |
|
Contains
the netbios computername. |
|
Contains
the Instance-number of the current Daemon (1-30). |
|
Contains a
carriage-return-linefeed (0D, 0A). |
|
Contains a
carriage-return (0D). |
|
Contains a
linefeed (0A). |
|
Contains a
TAB (ASCII-code 9). |
|
Contains the last
error-message. | <ErrorCommandID> |
Contains the ID of the
command that caused the error. This is the ID that is visible when
the Configuration option "Show Command Identifiers" is enabled and
is useful to identify the correct command in a
workflow. | <ErrorCounter> |
Contains the number of
errors that has occurred (if ErrorCollecting is
enabled) |
|
Contains the number of files
that has been processed since the last time the daemon was
launched. |
|
Functions |
Regular Expression
|
|
execute a "test"
regular-expression: str=string, expr=regular-expression,
opt=options (gim) |
<RE_TEST_File¦filepath¦expr¦opt> |
execute a "test"
regular-expression on the contents of a file: filepath
=filepath, expr=regular-expression, opt=options
(gim) |
<RE_REPLACE¦str¦expr¦replstr¦opt> |
execute a "replace"
regular-expression: str=string, expr=regular-expression,
replstr=replacement-string, opt=options (gim) |
<RE_REPLACE_File¦filepath¦expr¦replstr¦opt> |
execute a "replace"
regular-expression on the contents of a file: filepath
=filepath, expr=regular-expression,
replstr=replacement-string, opt=options (gim)
|
|
Strings |
|
returns the character
belonging to the configured "asciicode" |
|
Decodes the
html-encoded string "str" to a normal string str=string to
perform function on |
|
encodes the configured
normal string "str" to an HTML encoded string str=string
to perform function on |
<SF_Substring¦str¦start¦len> |
String-Function:
substring str=string to perform function on start=start
position len=length of substring |
|
returns length of
string str=string to perform function on |
|
returns left "len"
number of characters of str str=string to perform function
on len=numerical value of number of characters to
return |
|
returns right "len"
number of characters of str str=string to perform function
on len=numerical value of number of characters to
return |
|
removes all leading
and trailing spaces from str str=string to perform function
on |
|
converts str to
uppercase str=string to perform function on |
|
converts str to
lowercase str=string to perform function on |
<SF_PadLeft¦str¦width¦char> |
returns a string of
the specified "width" in which the beginning of the string
"str" is padded with the specified character "char"
str=string to perform function on width=the length of
the new string char=the padding character |
<SF_PadRight¦str¦width¦char> |
returns a string of
the specified "width" in which the end of the string "str" is
padded with the specified character "char" str=string to
perform function on width=the length of the new
string char=the padding character |
<SF_RandomString¦type¦len> |
returns a random
string of length "len" which consists of the following
characters: type: a=a-z, A=A-Z, 0=0-9, S=special chars (or
any combination) len: the length of the new
string |
|
converts str to the
specified format str=string to perform function
on format=desired format specification example:
<SF_Format¬01-12-2005¬dd-mmm-yyyy> |
|
splits the configured
string "str" using separator character "sep" and returns the
string which is in position "pos" of the resulting
array str=string to perform function on sep=separator
character or string pos=position in array of the string to
be returned |
|
Mathematical |
<MF_Calculate¦val1+val2-val3...> |
Perform simple
mathematical functions like +, -, * and
/ |
|
Other |
<OF_PID¦ProcesName> |
Returns the ProcesID
of proces ProcesName |
<OF_WFvalue¦workflowname|commandsonly> |
Runs workflow
"workflowname" and returns the <WorkflowValue> (must be
set with the "Set Workflow Value" of the "SetWorkflow"
plugin) |
|
|
AWS |
|
Contains the key as it was
found by the
S3-trigger. |
|
Contains the ArchiveID of
the current Amazon Glacier entry (AwsGlacier trigger). |
|
Contains the ArchiveName (Description)
of the current Amazon Glacier entry (AwsGlacier trigger). |
|
FTP |
|
Contains the quick-download-key
to download a file from an fp-server by the "FTPquickDownload"
plugin. |
|
Contains the filename of the
current file found by the FTP-Trigger. |
|
Contains the full directoryname
of the current file found by the FTP-Trigger. |
|
Contains the relative subdirectory
of the current file found by the FTP-Trigger. |
|