Transformations Wizard

12 min

Transformations allow to transform the data collected in instances by converting raw JSON data to a desired format by defining the JSON-based schema.

To assist with the definition of the Transformations and ensure that the JSON Object is correctly formatted, the DT Model Management Tool provides a Transformation Wizard.

Access the Transformation Wizard

Notes:

To access the Transformation Wizard it is required that:

A Model Type is selected
A Model Name is defined

Select the respective cell in Column Transformations for the Model you want to define Transformation.

If all conditions are met, the Transformation Wizard button is shown in the Help section of the LitmusConfiguration ribbon.

Open the Transformation Wizard by pressing the Transformation Wizard button.

The Transformation wizard will show.

Notes:

If the Model has already Transformations defined, they will be shown in the List.

Add a new Transformation Schema

To add a new Transformation Schema, press the Add option from the left panel.

Transformation Schema are a set of three Parameters:

Name: The name of the Transformation Schema.
Schema Type: The format used by the Transformation Schema
Schema: The Transformation Schema code.

To accept the entry press the green Modify button.

Notes:

If not all Parameters for the Transformation Schema are provided, the Modify button will remain grayed out and the Transfromation Schema can not be saved.

The wizard also performs a verification for each entry and will show any violation in red. In this case the Modify button will also be grayed out to prevent the saving of any invalid Transformation Schema.

Notes:

The tool will also verify that the Schema is correctly formated. If the Schema doesn't parse the Modify button will remain grayed out.

Notes:

Optionally you can use System Variables to define the Schema code.

Edit a Transformation Schema

Select the Transformation Schema you want to edit to open its Edit screen.

Edit any of the Transformation Schema Parameters:

Name: The name of the Transformation Schema.
Schema Type: The format used by the Transformation Schema
Schema: The Transformation Schema code

And press the Modify button.

Notes:

If not all Parameters for the Transformation Schema are provided, the Modify button will remain grayed out and the Transfromation Schema can not be saved.

Delete a Transformation Schema

Select the Transformation Schema you want to delete to open its Edit screen.

To delete the Transformation Schema press the Delete button.

Save the Transformations

To save all the defined Transformation Schemas as a new Transformations JSON Object, press the Save button.

This will create the correctly formatted Transformations JSON Object and store it in column Transformations for the Model.

Important: This will overwrite the current value in column Transformations.

Cancel the Transformation Wizard

If a user decides to not save the current Transformation Wizard configuration, they can press the Cancel button.

Notes:

This will not overwrite the current value in column Meta Data.