Importing & Exporting Settings

To import or export a user-configurable object, go to Administration > Import/Export. From this page, you can import or export the following:

  • Releases
  • Classification Models
  • Field Locator Models
  • Table Locator Models
  • Field Dictionary
  • System Settings

Note that only users with the "Export Settings" permission can export settings and only users with the "Import Settings" permission can import settings. By default, the System Admin Permission Group is the only group with these permissions.

Releases

Exporting releases

The release file contains the layout versions within the release and all of the data types present inside those layout versions.

When exporting a release, you can do the following:

  • Export a live release or any of the locked releases
  • Organize the list of release names by alphabetical order
  • Enter keywords to search for a release

Note that we now have support for large downloads. The system will create a ZIP file and send a notification after it is finished downloading, as opposed to immediately starting the download on the browser.

Importing releases

When importing a release, you can do the following:

  • Indicate whether to update custom field data types or skip duplicates

Classification models

Note that these models are release-wide.

Exporting classification models

When exporting Classification models, you can do the following:

  • Organize the list of layout names by alphabetical order
  • Enter keywords to search for a model

Importing classification models

Use the Import button to upload a Classification model.

Field/table locator models

Note that these models are layout-specific.

Exporting models

When exporting field/table locator models, you can do the following:

  • Filter by model status (Candidate vs Live)
  • Organize the list of layout names by alphabetical order
  • Enter keywords to search for a layout
  • Download a model associated with a layout

Importing models

When importing field/table locator models, you can do the following:

  • Organize the list of layout names by alphabetical order
  • Enter keywords to search for a layout
  • Upload a model to a specific layout

Field dictionary

Exporting the field dictionary

Select the Export button to download a CSV with the following data:

  • Display name - the name used for lookup and display in the layout editor
  • Data type - reflects the kind of information stored in a field entry
  • Output name - (optional) an additional name which can be used for reference by a downstream system or process
  • Status - enabled or disabled
  • Groups - what groups is the field associated with

Importing the field dictionary

Import a CSV file to quickly add fields to the Field Dictionary.

Adhere to the following CSV formatting instructions to properly update:

ImportingFieldDictionaryInstructions.png

You can download a sample CSV template here.

System settings

To let you move system settings between multiple instances that are on the same major version, you can export and import your system settings.

Exporting system settings

To export system settings:

  1. Click the Export button ( ExportButton.png ).

  2. Deselect the system settings that you do not want to export.
    ExportSettingsSelectSettings.png

  3. Click the Download Settings button.

The system settings are exported in a JSON file. You can then use this JSON file to import these system settings into another instance that uses the same major version of the application. 

Importing system settings

To import system settings:

  1. Click the Import button ( ExportButton.png ).

  2. Drag and drop your settings file and click the Import button.

    ImportSystemSettings.png

  3. Deselect the settings you do not want to import. All settings that you choose not to import will keep their current value.

    ImportSettingsSelectSettings.png

  4. Click the Apply changes now button.
Was this article helpful?
0 out of 0 found this helpful