System Variables Reference

Automation's default system variables are read-only. You can reference these variables in any JSON or text file. Note that Python (.py) and shell scripts (.sh) cannot use these variables directly.

Certain system variables compile anytime, while some compile only at runtime.

Warning

System variable names are reserved: do not use the names reserved for Automation system variables to define your custom variables, as this can create conflicts and errors in recipes.

System variables that compile anytime

Variable	Type	Description and details
CurrentKitchen	string	The name of the current kitchen.
CurrentUser	string	The username (login ID) of the user who submitted or scheduled the referenced order to run.
CurrentUserName	string	The full name of the user who submitted or scheduled the referenced order.
CurrentVariation	string	The name of the current variation for which the recipe is being compiled.
now	datetime	Represents current datetime in format YYYY-MM-DD HH:mm:SS.SS. Built-in Functions may be applied to parse the returned result.
ParentKitchen	string	The name of the immediate parent kitchen. For the master kitchen, the parent is always master.
RecipeName	string	The name of the current recipe.
WarningCount	integer	The number of warnings logged during an order run.
WorkDir	string	The current working directory, also known as the recipe root directory.

System variables that compile at runtime

Many system variable values are only defined when an order run starts.

Variable	Type	Description and details
Agent	string	The host name of the Kubernetes agent where the recipe runs.
CurrentOrderId	string	The ID of the current order.
CurrentOrderRunId	string	The ID of the current order run.
KeyName	string	The name of the current key (or mapping) being executed in a data source or sink. Only available for the mapping's sql statements and sql file paths.
NodeName	string	The name of the current node being executed.
OrderRunHistoryKitchen	string	The name of the kitchen marked as history-kitchen, to be used in metrics.
PreviousOrderRunId	string	The ID of the previous order run for the recipe variation within the same kitchen.
PreviousOrderRunIdList	array of strings	An array containing the previous order run IDs for the recipe variation within the same kitchen. This variable is limited to the 10 most recent order run IDs.
ResumedOrderRunId	string	The ID of the original failed order run, compiled at runtime of the resumed order run.
ScheduledOrderRunTime	long integer	The time an order run was scheduled to execute per its order's schedule. Used with actual runtime to calculate the delay for a run, which will always be less than the configured Epsilon interval. If using in a non-analytic container, this variable can be passed as a command line: /bin/bash -c "echo ScheduledOrderRunTime > somefile"