- 26 Oct 2023
-
DarkLight
-
PDF
transformation
- Updated on 26 Oct 2023
-
DarkLight
-
PDF
Task Purpose
The transformation
task is used to run JSON Schema Transformations (JSTs) during job execution, allowing JSON data to be consumed by endpoints (tasks, other jobs, etc.) with disparate formatting requirements.
This guide details the variables and options available to the transformation
task and provides instructions for their configuration.
For more information about JSTs, refer to the JST Designer documentation.
Task Variables
All transformation
task variables are accessed via the Data tab of the task details window. The variables available to the task depend on what JST the task is set to run:
- Input variables sources are from the incoming schema properties of the selected JST.
- Output variable sources (with the exception of
error
) are sourced from the outgoing schema properties of the selected JST.
The data type of a variable matches the data type specified by the relevant schema property.
Figure 1: Transformation Task
Configuring Task Variables
To configure the transformation
task, you must first select which JST it will run:
- Click the Transformation drop-down located at the top of the Data tab. A menu of available JSTs will appear.
- Select the JST you would like to run from the menu. The task input and output variables will populate based on the incoming and outgoing schema properties of the JST, respectively.
Defining the Input Variables
You can then begin defining the input variables:
- Click the Input subtab to display all available input variables.
- Define your input variables as follows:
- Select the Static variable source to manually type (or paste) the data the JST will receive.
- Select the Job variable source if you want the JST to receive data directly from a job variable.
- Select the Task variable source if you want the JST to receive data directly from a previous task.
Defining the Output Variables
Task outputs can be saved as job variables in the normal manner -- from the Output subtab. Click the relevant Store Output as Job Variable check box and designate which job variable the output will be stored as.
Figure 2: Output Variables
:::
Task Options
Task behavior can be further customized by enabling or disabling any of its options. These are specified via the Task Options drop-down menu, which is located on the Advanced tab of the task details window. Available options are referenced in the table below.
Transformation Task Option | Description |
---|---|
Mask Input Variable Names | Hide input variable names at runtime. |
Mask Output Variable Names | Hide output variable names at runtime. |
Extract Output | If only a single outgoing schema property exists, it is removed from its wrapper object. |
Validate Incoming | Confirms input is compatible with the incoming schema. |
Revert to Default Value | Enables the use of the default keyword in schemas. For more information, refer to the JSON Schema documentation. |
Configuring Task Options
To enable or disable task options:
- Select the Advanced tab on the task details window.
- Expand the Task Options drop-down menu.
- Click the check box of the relevant option.
Figure 3: Task Options