Skip to main content

Variables

Variables let you inject a string into a field.

The available variables are based on the flow nodes before the current node.

E.g. if you use a Video File node this will insert {vi.Video.Codec} etc

Using in Text Fields

To use a variable inside a text field, they must be wrapped in {}.

For example, {file.Name}

Typing { will open up a variable selector of available variables.

Text Variables

Using in a Function or Script

To use a variable inside a function or script, call the Variables object

For example,

Variables.file.Name

Function Variables

Always Available

VariableDescriptionTypeExample
tempThe temporary working directory where files are saved to during the flows executionstring/temp/Runner-44d4501b-7599-4f88-88f5-e8a95d57bcde
extExtension of working filestring.mkv
file.OriginalNameThe original library file name unmodified/mappedstring/mnt/library/file.mkv
file.NameShort filename of working file with extensionstringb0d11434-8fce-4d3c-ad55-774e05061bdf.mkv
file.NameNoExtensionShort filename of working file without extensionstringb0d11434-8fce-4d3c-ad55-774e05061bdf
file.FullNameFull filename of working filestring/temp/Runner-44d4501b-7599-4f88-88f5-e8a95d57bcde/b0d11434-8fce-4d3c-ad55-774e05061bdf.mkv
file.ExtensionExtension of working filestring.mkv
file.SizeSize of working file in byteslong100000000
folder.FileNameShort folder name of working filestringRunner-44d4501b-7599-4f88-88f5-e8a95d57bcde
folder.FullNameFull folder name of working filestring/temp/Runner-44d4501b-7599-4f88-88f5-e8a95d57bcde
file.CreateCreation DateTime of original fileDateTimeJavascript new Date()
file.Create.YearCreation Year of original fileint2020
file.Create.MonthCreation Month of original fileint3
file.Create.DayCreation Day of original fileint28
file.ModifiedModified DateTime of original fileDateTimeJavascript new Date()
file.Modified.YearModified Year of original fileint2020
file.Modified.MonthModified Month of original fileint3
file.Modified.DayModified Day of original fileint28
file.ModifiedModified DateTime of original fileDateTimeJavascript new Date()
file.Modified.YearModified Year of original fileint2020
file.Modified.MonthModified Month of original fileint3
file.Modified.DayModified Day of original fileint28
file.Orig.ExtensionExtension of original filestring.mkv
file.Orig.FileNameShort filename of original file with extensionstringTestFile.mkv
file.Orig.FileNameNoExtensionShort filename of original file without extensionstringTestFile
file.Orig.FullNameFull filename of original filestringC:\Files\TestFile.mkv
file.Orig.SizeSize of original file in byteslong100000000
folder.Orig.NameShort folder name of original filestringFiles
folder.Orig.FullNameFull folder name of original filestringC:\Files
time.processingThe total processing time of the flowstring00:12:31
time.processingRawThe total processing time of the flow as a timespan objectTimeSpanSystem.TimeSpan
time.nowThe current time, localisedstring12:45 p.m.

Formatters

When using a variable inside a text field, you can alter how that variable is displayed by using a formatter

FormatterNameDescriptionExample
!UpperCaseConverts the value to upper caseMYVALUE
0DigitsWill pad a number with the number of 0s specified, eg :0000 for 0001, 00100002
dateDateFormats a value as a date
timeTimeFormats a value as a time
datetimeDateTimeFormats a value as a datetime
MyhHmsft:-_DateTimeFormats a value as a custom date time string, eg d-MMM-yyyy h:mm:ss tt2-Nov-2022 5:34:49 p.m.
sizeSizeFormats a value in B, KB, MB, GB, TB.1.4GB
fileFileFormats a value as a safe file name ans removes or replaces any unsafe chartactersmy-safe-name

To use a formatter append | then the format, eg

{file.Name!} - {file.Size|size} {file.Create|dd-MM-yyyy} {file.Create|time}

Produces

FILENAME.EXT - 32.78 GB 29-10-2022 11:41

Hint: You can even use a formatter on any value you type in, for example

{645645654|size}

Produces

645.65 MB