Transformation Options
  • 12 Dec 2024
  • Dark
    Light
  • PDF

Transformation Options

  • Dark
    Light
  • PDF

Article summary

This guide will cover the options available when working with JSON Schema Transformations (JSTs) in the Canvas of Itential Automation Platform (IAP). The steps involved in selecting JST options for the Canvas will be discussed below.

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
01_Transformation_Options_23_2

  1. Workflow is pre-selected from the dropdown list. Enter a name (required) for the workflow.
  2. Click Create. The workflow canvas will now display.

Figure 2: Create Workflow
02_Transformation%20Options_23_2

For Previous Release Versions
Click here for 2023.1.x

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

01_Transformation_Opptions_23_1

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

  2. 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 will now display.

    Figure 2: Create Workflow

02_Transformation_Options_23_1

Click here for 2022.1.x

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

01-21.2-jst-options

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

  2. Select the appropriate IAP canvas (Gen 1 or Gen 2) Click Create. The workflow canvas will now display.

    Figure 2: Create Workflow

02-21.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
03_Drag_Transformation_23_2

Note

Hover over the Transformation task to display the tooltip.

Figure 4: Viewing the Tooltip
06_Transformation_Tooltip_23_2

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

Figure 5: Edit Transformation Task
04_Edit_Transformation_23_2

  1. 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.
  2. Close out of the task and it will automatically Save the task choices.

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

Figure 6: Run Transformation Task
05_Run_Transformation_23_2

Click here to view Previous Release Versions

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.