Variables
Agile Data Engine supports predefined and user-defined variables to enable customization in various different use cases.
See also:
Usage
Variables are referred to by encapsulating the variable name in angle brackets, for example:
<variable_name>Notes
If environment variables are used in loads and changes are made to the environment variables, the loads must also be redeployed for the changes to take effect.
Variable types
Level | Type | Example | Scope |
|---|---|---|---|
0 | Predefined environment level variables | Environment | |
1 | Environment variables in ADE main configuration (Private Edition) |
| Environment |
2 | Environment variables in CONFIG_ENVIRONMENT_VARIABLES |
| Environment |
3 | Predefined schedule level variables | Workflow | |
4 | Schedule level variables in a configuration package |
| Workflow |
5 | Predefined load level variables | Load |
Predefined variables
See list of predefined variables below. Depending on the variable, it can be used in:
Deployment: Control parts in deployment procedures such as grants.
Loads: Use variables in load step definitions.
Variable | Deployment | Loads | Description |
|---|---|---|---|
x | Resolved as the Snowflake copy options in file load execution. | ||
x | x | Resolved as the DAG generation mode name in load execution. | |
x | Synonymous to storage_integration, resolved as the storage integration (Snowflake) or external data source (Azure SQL Database) in file load execution. | ||
DISABLE_SRC_SYS_NAME_IN_FILE_NAME | x | x | Used for backward compatibility only. |
x | x | Resolved as the environment name in deployments and in load execution. | |
x | x | Deprecated. Alias to environment_name. Use environment_name instead. | |
x | Resolved as the file format options in file load execution. | ||
x | Resolved as the source file path in file load execution. | ||
x | Resolved as a comma-separated source file list in file load execution. | ||
x | Resolved as the source path(s) in file load execution. | ||
x | Resolved as a comma-separated list of loadable batch ids in load execution. Used with the Run ID Logic. | ||
| x | Resolved as the load name in load execution. | |
| x | Resolved as the package name in load execution. | |
| x | Resolved as the package version in load execution. | |
x | x | Resolved as the schedule name in load execution. | |
| x | Deprecated. Resolved as the data source batch id attribute name in load execution. Used with the Run ID Logic. | |
| x | Resolved as the data source run id attribute name in load execution. Used with the Run ID Logic. | |
x | Resolved as data source credentials in file load execution. | ||
x | Resolved as encryption settings in file load execution. | ||
x | Resolved as the source entity name in load execution. | ||
x | Resolved as the source entity schema in load execution. | ||
x | Deprecated. Resolved as the staging table batch id attribute name in load execution. Used with the Run ID Logic. | ||
x | Resolved as the storage integration (Snowflake) or as the external data source (Azure SQL Database). | ||
| x | Deprecated. Resolved as a new target batch id value in load execution. Used with the Run ID Logic. | |
| x | Resolved as a new target run id value in load execution. Used with the Run ID Logic. | |
| x | Deprecated. Resolved as the target table batch id attribute name in load execution. Used with the Run ID Logic. | |
| x | Resolved as the target table run id attribute name in load execution. Used with the Run ID Logic. | |
| x | Resolved as the target database name in load execution. | |
x | Resolved as a comma-separated list of target entity attributes in file load execution. | ||
x | Resolved as the target entity logical name in load execution. | ||
x | Resolved as the target entity name in load execution. | ||
x | Resolved as the schema of the target entity in load execution. |