Transformation Options

Prev Next

This guide covers the options available when working with JSON Schema Transformations (JSTs) in the canvas of Itential Platform. The steps involved in selecting JST options for the canvas are discussed below.

Create Workflow

From the Itential Platform home page:

  1. Select Studio from the left navbar. The application screen displays.
  2. Click + Create a Workflow from the Quick Start card. The Create dialog opens.
  3. Workflow is pre-selected from the dropdown list. Enter a name (required) for the workflow.
  4. Click Create. The workflow canvas will now display.

Figure 1: Automation Studio
01_Transformation_Options_23_2

 

Figure 2: Create Workflow
02_Transformation%20Options_23_2

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