Skip to main content

KBA1634 Export and Import of Environment in Masking Engine


Delphix Masking: This article describe Environment Export and Import. The export format is an editable XML file.

Export and Import 

Export and Import of masking environments can be done to:

  • Backup an Environment.
  • Make changes to an Environment;
    • Masking large Environments.
    • Changes multiple objects. 
  • Migrate an Environment:
    • To another engine.
    • To another version*.

* Note: There is no guarantee that future version will change the XML structure. 

Objects Exported

These objects are exported from the selected Environment:

  • Connectors
  • Rule Sets and configurations
  • Inventories 
  • Jobs

Objects Not Exported

Note that there are key engine objects that are not exported. These are:

  • Any Masking Engine setup items:
    • Domain configurations.
    • Algorithms nor algorithm data.
    • Profiles nor profile data (i.e. expressions).
    • Data formats. 
  • Log files
  • Execution history

Note: Mapping algorithms need to be reimported. This might change the masking result (still to be confirmed).  


There are some gotchas:

  1. Export and Import can take a long time.
    • Especially if there are many objects (usually tables and columns) in the Environment,
    • There is no visual progress feedback.
  2. All domains need to exists prior to import.
    • It is recommended to also create any missing Algorithms prior to import. 
  3. Data Formats need to exists prior to import.
    • The same goes for all custom data formats for file, Excel and copybooks etc. 

Export Procedure 

From the Masking Engine UI:

  1. Go to the Environments screen.
  2. Export the environment by clicking the Export button.
    • Before clicking the Export button again, please take note of the XML file.
    • A popup window is opened which will have the link to the XML when finished - if this fails, see Issues below. 
    • This step can take some time depending on the number of objects.

    • Docs -Export Popups.png
  3. If multiple environments need to be exported, repeat step 2 for each environment. 
  4. Take note of Domains and custom Algorithms 
    • Click the tab Setup and Domain and Algorithm.
    • These are not copied and need to be manually recreated.


Import Procedure 

For importing the Environment XML file and creating a new Environment.

From the Masking Engine UI:

  1. Go to the Environments screen.
  2. Recreate custom Algorithms and Domains.
  3. Select Import Environment and enter required information.
    • Select Save & View.
    • This step can take some time depending on the number of objects.

  4. If there are multiple environments, repeat step 3 for each environment. 


Issue and Resolutions


Popup Window disabled

 Popup window might be disabled in your browser. 


  • Please enable popup windows on the Browser from this site.

Export Popup Window Closed 

When the XML generation process is taking a long time, it might happen that one close the Export popup window. 


  • Capture the XML File Name:
    • either from the Export process described above; 
    • or from the Logs described below.
  • Open a new tab and specify "http://[Engine Name}:8282/dmsuite/Export/[XML File name]"

Domain not defined on the engine

If the Import fails due to the Domain name not present (see error message below).

Domain names [Domain] not present. Import of Environment failed.


  • Create the Domain (and Algorithm) prior to importing the Environment


As noted above, there is no progress indicator available when Exporting and Importing the environment. To troubleshoot completion, one can search for the following strings in the masking logs.

In the Masking Engine UI:

  • Go to the Admin tab and select Logs in the submenu.
  • View the logs on screen or download the Logs. 

Logs for Export 

## Comment - Start Export
[Date]... INFO ...ExportImportEnvironmentAjaxFacade - startFileCreationToExport export path [/var/delphix/dmsuite/Export]

## Comment - Export finised and download link
[Date]... INFO ...ExportImportEnvironmentAjaxFacade - basePath : http://[Engine Name]:8282/dmsuite/Export/Env_192131426965.xml

Logs for Import

## Comment - Start Export
[Date]... INFO ...dmsuite.manager.EnvironmentManager - ### Start import process.....
[Date]... INFO ...dmsuite.manager.EnvironmentManager - Unmarshalling the file ................Env_192131426965.xml
[Date]... INFO ...dmsuite.manager.EnvironmentManager - Unmarshalling DONE ................
[Date]... INFO ...dmsuite.manager.EnvironmentManager -  1. Actual start algo present ..............
[Date]... INFO ...dmsuite.manager.EnvironmentManager - FileFormat already present for File 'history.txt'.
[Date]... INFO ...dmsuite.manager.EnvironmentManager - User is admin: 1
## Comment - Import finished


Additional Information