On this page:

Migrate Transformations

Migration Procedure for Transformations After IAP Upgrade

This guide covers how to migrate a JSON Schema Transformation (JST) after upgrading Itential Automation Platform (IAP) to the most current available version.


Before upgrading IAP it is imperative that the database be backed up. The backup is best performed using the mongodbdump utility, which creates a binary export of the database contents. The instructions for using the mongodump utility can be found in the mongodump documentation.

Upgrading IAP

The procedure for upgrading IAP can be found on the Itential document repository. Click the link to access the documentation: IAP Upgrade Docs.

Make sure to verify that all the correct dependency packages have been installed. The correct versions are listed in the Version Verification section of the upgrading procedures guide.

Importing Transformations to Upgraded IAP

Importing transformations is actually a two-step process. First you will need to export your JST. Once the export file is saved you can import the JST back into the upgraded version of IAP.

Export and Save the JST

From the IAP home page:

  1. Click Admin Essentials in the left navbar.

    Figure 1: IAP Welcome Screen

    IAP Home

  2. Select Authorization in the Quick Start card.

    Figure 2: Admin Essentials Authorization

    Authorization Manager

  3. Set permissions in Authorization Manager for the application to APP-JST.

    Figure 3: Set Permissions

    Set Permissions

  4. Go to IAP → Automation Studio → Transformations.

    Figure 4: Navigate to Transformations

    Navigate to Transformations

  5. Search for the transformation to be downloaded.

    Figure 5: Locate Transformation

    Locate Transformations

  6. Export the JST using the JST Designer. Click the Download arrow.

    Figure 6: Download JST

    Download JST

  7. Select the Save File radio button to save the downloaded JST (the default location is Downloads) and click OK.

    Figure 7: Save JST

    Save JST

  8. Verify the location of the saved file.

    Figure 8: Verify JST Location

    Verify JST Location

Import the Saved JST

To import the saved transformation:

  1. Click Import Automation from the Automation Studio page.

    Figure 9: Import Automation

    Import Automation

  2. Select Transformation from the dropdown menu and click the Import button.

    Figure 10: Select Transformation

    Select Transformation

  3. Click the Chose New File icon.

    Figure 11: Select Transformation File

    Choose New File

  4. Navigate to the JST to be imported. Click Open to upload the JST file.

    Figure 12: Locate JST

    Locate JST

  5. Click the Import button.

    Figure 13: Import JST

    Import JST File

  6. A success message will appear, indicating the JST was imported.

    Figure 14: Import Successful

    Import Successful

Note: If the import and update to existing fails, confirm the JST-ENGINE version from the Mongo documentation.