Set a variable

Task in alpha phase

This Data Factory task is in phase. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.

This task allows to store data in a variable, scoped to the job execution context. The variable can be used to store data that can be used in the job such as the result of a task, the output of a transformation, or any other data that needs to be shared between tasks.

Examples

Set a variable - simple example

 {
    "name": "Set variable",
    "taskReferenceName": "set_variable",
    "type": "SET_VARIABLE",
    "inputParameters": {
        "domain": "my-api.example.com"
    }
}

Set a variable - it's possible to set a variable with a complex data structure

 {
    "name": "Set variable",
    "taskReferenceName": "set_variable",
    "type": "SET_VARIABLE",
    "inputParameters": {
        "configuration": {
            "domain": "my-api.example.com",
            "maxAttempt": 3,
            "allowRedirect": true,
            "defaultHeaders": {
                "Content-Type": "application/json"
            }
        }
    }
}

TIP

• The variable is scoped to the job execution context. It means that the variable is not available outside the job execution
• To access the variable, you can use the syntax ${workflow.variables.variable_name}

Definition

WARNING

This task does not support the Data Factory global variables as an input parameter.

Property	Type	Required	Description
			The name (or type) of the task
			The unique name of the task in your job. It is used to reference this task in the workflow.
			The functional description of this task in your job.
			The type of the task. It must be SET_VARIABLE.
			the variables to set. The input parameters are a map of key/value pairs. The key is the name of the variable and the value is the value of the variable. The value can be a string, a number, a boolean, an array or an object.

Outputs

This task does not have any output.