Exporting and importing tenant data

You can export tenant data from a tenant as a tenant data file. Tenant data export allows you to create a 'backup' of a tenant.

Exporting tenant data creates a JSON tenant data file (.tenant). The file name is generated using the tenant name and export date and time, for example: TenantName_20220614113304.tenant.

The following tenant data elements are included in the export file:

Exported tenant data	Description
Tenant settings	All the general tenant settings, as shown on the Tenant page. For example: Tenant Single Sign-on settings Tenant Security access restrictions Tenant Reporting settings Tenant Observability settings
Flows	All published flows within the tenant, and any linked features and elements used by these flows, such as: Page layouts, values, types, assets, and macros Connectors (including password information) Identity Providers
Players	All players set up within the tenant.

Any unused features and elements in the tenant are not included in the tenant export file.

When this file is imported:

• The exported tenant settings overwrite any settings when restored with import.
• Flows contained within the file are restored into the tenant during import.
• All elements and settings required by the flows are restored into the tenant during import.

Before you begin

• Before you can export tenant data, all the flows within the tenant must have previously been published at least once.
• Importing tenant data will overwrite all information in the current tenant, and reload the page. It is highly recommended that you export and backup your current tenant information, before you import a tenant data file.

Exporting tenant data

To export a tenant data file:

1. Ensure that you are in the correct tenant that you wish to export data from, and that all flows in the tenant have been published.
2. On the Tenant page, click Export.
3. The JSON packaged tenant data file (.tenant) is exported. The file name is generated using the export date and time, for example: TenantName_20220614113304.tenant.

Importing tenant data

caution

Importing tenant data will overwrite all information in the current tenant, and reload the page. It is highly recommended that you export and backup your current tenant information, before you import a tenant data file.

Before you import a tenant package into a tenant, ensure you meet the following requirements:

• Matching Tenant ID: You can only import a tenant package into a target tenant that shares the exact same Tenant ID as the source tenant from which you exported the package.
• Matching Environment Configuration: You can only import a tenant package into a tenant where the environment configuration matches. Specifically, the target tenant must have the same environment set and the same Environments Enabled setting as the source tenant (for example, you cannot import a package exported from an environments-disabled tenant into an environments-enabled tenant).

To import a tenant data file:

1. Ensure that you are in the correct tenant that you wish to import the tenant data into.

2. On the Tenant page, either:

   • Drag and drop a .tenant file onto the Import Tenant field.

   • Click the Import Tenant field, browse to the file and click Open.

3. The Importing Tenant form is shown.

   • To confirm that you wish to proceed, enter the name of the tenant that you wish to import the file into (as shown on the form).

   • Once you have entered the import tenant name correctly, the Import and overwrite button becomes active.

4. Click Import and overwrite.

5. A progress bar indicates the import status. Once it has completed, click Cancel to exit out of the form.