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.

Note-1: as of Omniphlex v8.17.0 all user-defined variables are encoded using the following format: <{var:varname}>
Example: <{var:Counter}>

Before v8.17.0 variables were encoded as: <varname>

The "old" way of encoding variables is still supported by Omniphlex but it is strongly recommended to use the new encoding syntax.

The new encoding ensures that Omniphlex can better identify strings as variables.

Note-2: internal variables do NOT need to be encoded using the new format.

You can choose from the following sets of internal variables;

File	<ScanPathFileName> <FileName> <FileNameExt> <FileNameNoExt>	Directory	<ScanDir> <ScanPath> <SubDir>
Fileinfo	<FileSize> <FileTimestamp> <FileCreationDate> <FileLastAccessed> <FileLastWritten> <FileOwner> <CurrentFileNumber> <TotalFileNumber>	Date	<dd-mmm-yyyy> <dd-mm-yyyy> <yyyy-mm-dd> <yyyy-mmm-dd> <yyyy-mm-dd hh:mm:ss.ms> <ddmmyyyy> <yyyymmdd> <yymmdd> <dd> <mmm> <date_mm> <date_m> <yyyy> <yy> <WeekNum> <DayOfWeek> <DayOfYear> <Quarter> <Yesterday> <Tomorrow> <ShortDate> <LongDate> <FullDateTime>
Workflow	<WorkflowName> <WorkflowDescription> <WorkflowHotfolder> <WorkflowLog> <ParentWorkflow> <ParentWorkflowLog> <ParentHotfolder> <RootWorkflow> <ForNextValue> <ForEachValue> <ForEachStepNo> <ForEachMaxStep> <ProcessedFilesWorkflow> <WorkflowValue> <WorkflowErrorCounter> <WorkflowLastOverdueTime>	Time	<hh:mm:ss> <hhmmss> <hh> <mm> <ss> <ms> <ShortTime> <LongTime> <sunrise> <sunset>
System	<ComputerName> <DaemonInstance> <DaemonDescription> <CrLf> <Cr> <Lf> <TAB> [Chr(nnn)] <ErrorMessage> <ErrorCommandID> <ErrorCounter> <ProcessedFilesCounter> <LocationLatitude> <LocationLongitude>	AWS	<S3QuickDownload> <S3key> <GlacierArchiveID> <GlacierArchiveName>
Functions	Regular Expression <RE_TEST ¦str ¦expr ¦opt> <RE_Test_File¦filepath¦expr¦opt> <RE_Replace ¦str ¦expr ¦replstr ¦opt> <RE_Replace_File¦filepath¦expr¦replstr¦opt> Strings <SF_Format¦str¦format> <SF_HtmlDecode¦str> <SF_HtmlEncode¦str> <SF_Left¦str¦len> <SF_Length¦str> <SF_Lowercase¦str> <SF_PadLeft¦str¦width¦char> <SF_PadRight¦str¦width¦char> <SF_RandomString¦type¦len> <SF_Right¦str¦len> <SF_Split¦str¦sep¦pos> <SF_Substring¦str¦start¦len> <SF_Trim¦str> <SF_Uppercase¦str> Mathematical <MF_Calculate¦val1+val2-val3...> Other <OF_PID¦ProcesName> <OF_WFvalue¦workflowname¦commandsonly>	FTP	<FtpQuickDownload> <FtpFileName> <FtpDirectory> <FtpSubDir>
Azure	<AzureBlobQuickDownload> <AzureBlobPathName> <AzureBlobName> <AzureBlobDirectory>	Google	<GoogleStorageQuickDownload> <GoogleStorage PathName> <GoogleStorage Name> <GoogleStorage Directory>

File

<ScanPathFileName>	Contains the complete path and filename of the file that was found by a daemon.
<FileName>	Contains the complete filename of the file that was found.
<FileNameExt>	Contains the extension of the file that was found.
<FileNameNoExt>	Contains the filename without its extension.

Directory

<ScanDir>	Contains the directory which the workflow was programmed to scan. This is the "Scan Directory" value of the workflow properties
<ScanPath>	Contains the complete path of where the file was found.
<SubDir>	Contains the subdirectory in which the file was found relative to <ScanDir>. (<SubDir> = <ScanPath> - <ScanDir>)

FileInfo

<FileSize>	Contains the size of the current file in bytes.
<FileTimestamp>	Contains the timestamp of the file in the format "dd-mmm-yyyy hh:mm:ss".
<FileCreationDate>	Contains the creation timestamp of the file in the format "dd-mmm-yyyy hh:mm:ss".
<FileLastAccessed>	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".
<FileOwner>	Contains, on NTFS filesystems, the owner of the file.
<CurrentFileNumber>	Contains the number of the file that is currently being processed.
<TotalFileNumber>	Contains the total number of files that were found in "Scan Directory".

Date

<dd-mmm-yyyy>	Contains the current date in the "dd-mmm-yyyy" format.
<dd-mm-yyyy>	Contains the current date in the "dd-mm-yyyy" format.
<yyyy-mm-dd>	Contains the current date in the "yyyy-mm-dd" format.
<yyyy-mmm-dd>	Contains the current date in the "yyyy-mmm-dd" format.
<yyyy-mmm-dd hh:mm:ss.ms>	Contains the current date in the "yyyy-mmm-dd hh:mm:ss.ms" 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.
<dd>	Contains the current day-of-the-month number.
<mmm>	Contains short-form of the current month.
<date_mm>	Contains the numerical month-of-the-year number in mm format (may is 05).
<date_m>	Contains the numerical month-of-the-year number in m format (may is 5).
<yyyy>	Contains the complete current year-number.
<yy>	Contains only the last two digits of the current year.
<WeekNum>	Contains the current week-number.
<DayOfWeek>	Contains the current day-of-the-week. 1=monday.
<DayOYear>	Contains the current day-of-the-year (1-365).
<Quarter>	Contains the current quarter (1-4).
<Yesterday>	Contains date of yesterday.
<Tomorrow>	Contains the date of tomorrow.
<ShortDate>	Contains current date in "short" format.
<LongDate>	Contains current date in "long" format.
<FullDateTime>	Contains current full date/time.

Time

<hh:mm:ss>	Contains the current time in the "hh:mm:ss" format.
<hhmmss>	Contains the current time in the "hhmmss" format.
<hh>	Contains the system-time hour.
<mm>	Contains the system-time minute.
<ss>	Contains the system-time second.
<ms>	Contains the system-time milli-second.
<ShortTime>	Contains the current time in "short" format.
<LongTime>	Contains the current time in "long" format.
<sunrise>	Contains the time of the next sunrise.
<sunset>	Contains the time of the next sunset.

Workflow

<WorkflowName>	Contains the name of the active workfow.
<WorkflowDescription>	Contains the description of the active workflow.
<WorkflowHotfolder>	Contains the hotfolder setting of the active workflow.
<WorkflowLog>	Contains the complete path/filename of the logfile of the active workflow.
<WorkflowErrorCounter>	Contains the number of errors the current workflow has had since last startup.
<ParentWorkflow>	Contains the name of the parent-workflow (when a workflow has been activated with the ForkWorkflow command).
<ParentWorkflowLog>	Contains the complete path/filename of the logfile of the parent-workflow.
<ParentHotfolder>	Contains the hotfolder directory of the parent workflow.
<RootWorkflow>	Contains the name of the root-workflow (oldest parent workflow) from which the workflow was launched.
<WorkflowValue>	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.
<ForEachValue>	Contains the current ForEach-value during a ForEach command.
<ForEachStepNo>	Contains the current numerical index for the current ForEach step during a ForEach command.
<ForEachMaxStep>	Contains the maximum value of the current ForEach command.
<ForNextValue>	Contains the current ForNext-value during a ForNext command.
<WorkflowLastOverdueTime>	Contains the last "overduetime" of the current workflow.

System

<ComputerName>	Contains the netbios computername.
<DaemonInstance>	Contains the Instance-number of the current Daemon (1-30).
<DaemonDescription>	Contains the description of the current Daemon (1-30).
<CrLf>	Contains a carriage-return-linefeed (0D, 0A).
<Cr>	Contains a carriage-return (0D).
<Lf>	Contains a linefeed (0A).
<TAB>	Contains a TAB (ASCII-code 9).
<ErrorMessage>	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)
<ProcessedFilesCounter>	Contains the number of files that has been processed since the last time the daemon was launched.
<LocationLatitude>	Contains the latitude of the current location.
<LocationLongitude>	Contains the longitude of the current location.

Functions

Regular Expression

<RE_TEST¦str¦expr¦opt>	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

[Chr(asciicode)]	returns the character belonging to the configured "asciicode"
<SF_HtmlDecode¦str>	Decodes the html-encoded string "str" to a normal string str=string to perform function on
<SF_HtmlEncode¦str>	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
<SF_Length¦str>	returns length of string str=string to perform function on
<SF_Left¦str¦len>	returns left "len" number of characters of str str=string to perform function on len=numerical value of number of characters to return
<SF_Right¦str¦len>	returns right "len" number of characters of str str=string to perform function on len=numerical value of number of characters to return
<SF_Trim¦str>	removes all leading and trailing spaces from str str=string to perform function on
<SF_Uppercase¦str>	converts str to uppercase str=string to perform function on
<SF_Lowercase¦str>	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
<SF_Format¦str¦format>	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>
<SF_Split¦str¦sep¦pos>	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)

Azure

<AzureBlobQuickDownload>	Contains the key that contains all necessary data to download a blob from Azure Storage using the "AzureBlobQuickDownload" plugin..
<AzureBlobPathName>	Contains the full path of the blob that was found by the AzureBlob Hotfolder-trigger.
<AzureBlobName>	Contains the name of the blob that was found by the AzureBlob Hotfolder-trigger.
<AzureBlobDirectory>	Contains the directory part of the full path of the blob that was found by the AzureBlob Hotfolder-trigger.

Google Storage

<GoogleStorageQuickDownload>	Contains the key that contains all necessary data to download ab object from Google Storage using the "GoogleStorageQuickDownload" plugin..
<GoogleStoragePathName>	Contains the full path of the object that was found by the GoogleStorage Hotfolder-trigger.
<GoogleStorageName>	Contains the name of the object that was found by the GoogleStorage Hotfolder-trigger.
<GoogleStorageDirectory>	Contains the directory part of the full path of the object that was found by the GoogleStorage Hotfolder-trigger.

AWS

<S3QuickDownload>	Contains the key that contains all information necessary to download a files from S3 using the S3QuickDownload plugin..
<S3key>	Contains the key as it was found by the S3-trigger.
<GlacierID>	Contains the ArchiveID of the current Amazon Glacier entry (AwsGlacier trigger).
<GlacierName>	Contains the ArchiveName (Description) of the current Amazon Glacier entry (AwsGlacier trigger).

FTP

<FtpQuickDownload>	Contains the quick-download-key to download a file from an fp-server by the "FTPquickDownload" plugin.
<FtpFileName>	Contains the filename of the current file found by the FTP-Trigger.
<FtpDirectory>	Contains the full directoryname of the current file found by the FTP-Trigger.
<FtpSubDir>	Contains the relative subdirectory of the current file found by the FTP-Trigger.

SetConnect

Internal Variables

Documentation