Transformation Options 2023.1.x

Overview

This guide will cover the options available when working with JSON Schema Transformations (JSTs) in the New Canvas and the Legacy workflow canvas of Itential Automation Platform (IAP). The steps involved in selecting JST options for the New Canvas will be discussed first, followed by the options that are available in the Legacy Canvas.

Create Workflow

From the IAP home page:

1. Select Automation Studio from the left navbar. The application screen displays.

2. Click + Create a Workflow from the Quick Start card. The Create dialog opens.

   Figure 1: Automation Studio

3. Workflow is pre-selected from the dropdown list. Enter a name (required) for the workflow.

4. Select the appropriate IAP canvas using the toggle switch. The default will use the New Canvas. Clicking the toggle switch will use the Legacy canvas. Click Create. The workflow canvas displays.

   Figure 2: Create Workflow

New Canvas Workflow

To add a JST in the New Canvas :

1. In the Search bar (top of the Task panel), start typing Transformation to locate the transformation task.

2. Drag the Transformation task to the canvas.

3. Connect the Transformation task to the Start and End tasks. Transformation tasks can be connected to any two tasks that require you to transform data due to different data formatting requirements​.

Figure 3: Finding and Adding the Transformation Task

4. Double-click the Transformation task to view available settings. Choose the Transformation needed and then edit the incoming variables.

Figure 5: Edit Transformation Task

5. Select the appropriate options (see table below) you would like to use prior to running your transformation.

   Option (New Canvas)	Description
   Mask Input Variable Values	This option is available on all tasks. It encrypts incoming variables and displays them as asterisks in Jobs (formerly Job Manager).
   Mask Output Variable Values	This option is available on all tasks. It encrypts outgoing variables and displays them as asterisks in Jobs (formerly Job Manager).
   Extract Output	This option only applies if you have a single outgoing schema. It removes the wrapper object from the output and returns only the value of that property.
   Validate Incoming	Validates your input. Checks if the input is the correct type and compatible with any keywords set in that incoming schema i.e. enum or const.
   Revert To Default Value	Enables use of a default keyword. Default values from the incoming schemas will be used whenever a key/incoming data value is not provided. If an outgoing schema has a default value, an incoming schema is assigned to it. If the incoming schema does not have a default defined, then the default for the outgoing schema will be used. If an outgoing schema has a default value defined, and nothing is assigned to it, then the default values will be in the transformation output.

6. Close out of the task and it will automatically Save the task choices.

7. Save the Workflow and then click the Start button (top-right) to run the transformation.

Figure 6: Run Transformation Task

Legacy Workflow

To add a JST in the Legacy Workflow canvas:

1. In the Search bar (top-right corner), type JST to locate the transformation task.

2. Click the plus (+) sign to the left of the task. This will add a new JST task labeled JSON Transformation to the Legacy canvas.

   Figure 7: Add JST Task (Legacy)

3. Connect the JST task to the Start and End tasks. Transformation tasks can be connected to any two tasks that require you to transform data due to different data formatting requirements. You can also hover over the JST task to display the tooltip.

   Figure 8: Connect JST Task (Legacy)

4. Double-click the JSON Transformation task. The edit modal displays.

   Figure 9: Edit JST Task (Legacy)

5. Select the appropriate options (see table below) you would like to use prior to running your transformation.

   Option (Legacy)	Description
   Mask Input Variable Values	This option is available on all tasks. It encrypts incoming variables and displays them as asterisks in Jobs (formerly Job Manager).
   Mask Output Variable Values	This option is available on all tasks. It encrypts outgoing variables and displays them as asterisks in Jobs (formerly Job Manager).
   Extract Output	This option only applies if you have a single outgoing schema. It removes the wrapper object from the output and returns only the value of that property.
   Validate Incoming	Validates your input. Checks if the input is the correct type and compatible with any keywords set in that incoming schema i.e. enum or const.
   Revert To Default Value	Enables use of a default keyword. Default values from the incoming schemas will be used whenever a key/incoming data value is not provided. If an outgoing schema has a default value, an incoming schema is assigned to it. If the incoming schema does not have a default defined, then the default for the outgoing schema will be used. If an outgoing schema has a default value defined, and nothing is assigned to it, then the default values will be in the transformation output.

6. Click Save and you will return to Legacy Workflow canvas.

7. Click the Start button (top-right) to run the transformation.

   Figure 10: Run JST (Legacy)