Migrate settings

Use the Migrate Settings capability to import and export settings from one account to another. For example, when your test environment passes the acceptance criteria, you can export the settings from the test environment to production.

The Migrate Settings are available on the Administrator Settings window. You can run imports and exports, and you can also see the history of both actions.

Exports

When you export settings, the settings are stored in JSON format to a .resz file, which is a .res file within a .zip file.

Incident types, artifact types, fields, data table definitions, and roles are always included in the exported file, even when you choose not to include other settings. Some settings, such as users, are not exported.

The Export History shows information about each of the previous exports, including a link to the export file that was created.

Table 1. Export settings
Settings Description
Common Layouts

Common layouts are layouts that are the same for all users.

The following layouts are common: New Incident Wizard, Incident tab, and Close incident. Each account can have only one layout for each type.

Common layouts are automatically included in the export if you also include shared layouts.

Shared Layouts

Shared layouts are created by users and shared with the account. They include layouts such as dashboards, report templates, and incident views, including preset filters and tab layouts. You can have an unlimited number of shared layouts within an account.

If you include shared layouts in your export, you must also include the common layouts.

Note: This setting applies only to stand-alone accounts. In configuration and provider accounts, you cannot export shared layouts.
Rules, Scripts, Destinations, Functions, Workflows, Playbooks and Case Matching Profiles

If the account has at least one installed app, you must include Rules, Scripts, Message Destinations, Functions, Workflows and Playbooks in the export settings.

If you do not export these settings, the app might not function correctly when it is imported into another account.

Phases and Tasks

Phases define each stage of the incident response, and each phase contains tasks that must be completed before the incident can progress to the next stage.

Phases and tasks are automatically included in the export if you also include rules and workflows.

Administrator Settings The following settings are included when you export the Administrator Settings.
  • Groups
  • Inbound email

    Includes Name, API name, and description only.

  • Time frames
  • Notifications

Imports

Before you import, make sure that no users are currently logged in. In addition, make sure that all users referenced in any rule’s conditions exist in the target account. If any do not exist, create them before you import.

You can include groups in the import, but you cannot import the users in a group. Importing and exporting users is not supported.

During an import, the following activities occur:

  • All incident fields, types, and data table definitions are updated.
  • Non-unique task names are reconciled.

    Task names are not unique even within the same incident type. To mitigate non-unique task names, the Orchestration & Automation attempts to match tasks that use a unique ID, and then attempts to match by using the name and type. If only one attribute matches, the system overwrites the task. If more than one attribute matches, the system creates a new task and displays a warning.

  • The message destination and type are checked.

    Message destinations are not overwritten unless both the name and type match.

  • The user list for message destinations is ignored.

    For an updated message destination, the system ignores the updated user list and keeps the original user list intact. The user list is empty for a new message destination.

  • Checks for rules that have a condition that refers to incident members.

    For example, the system checks for a rule that is initiated only when the incident member list contains a specific user. In this case, the user is retained if the imported condition contains an exact match of the user. If it is not an exact match, a message is displayed that indicates the user was removed from the condition.

The Import History shows the changes between the existing settings and the imported settings, such as incident fields, layouts, and custom rules. The import does not delete items; therefore, the View page provides a list of items that are no longer used, which you can then remove manually.

Important:

You can import settings from the same version or previous major version of Orchestration & Automation.

If you import from an account that is configured for a different language, as determined by the locale setting, the imported language setting overwrites the existing language setting.