Resource Migration

Overview

Feature Introduction

Online Migration is suitable for customers whose test and production environments are network-connected. By centrally configuring migration settings on the Resource Migration > Online Migration Settings page and then clicking Migrate on the corresponding Resource page, you can synchronize test Resources to the production environment. For details, see Online Migration.

Offline Migration is suitable for customers whose test and production environments are network-isolated. You can centrally configure and export a Resource package on the Resource Migration page, then import it under the same path in the production environment to synchronize test Resources to production. For details, see Offline Migration.

Applicable Scenarios

Migrate from test to production: when test and production environments are strictly separated, modified Resources need to be migrated from test to production to reduce direct modifications in production, keep the two environments consistent, and improve migration efficiency.
Synchronize templates from headquarters to branches: when headquarters data standards or Dashboard templates need to be synchronized to branch companies, use the migration feature to sync headquarters templates to other environments.
OEM vendors initializing Dashboards in customer environments: after integrating Guandata BI into another B-end platform, you can use migration to initialize Dashboards, migrate industry templates, and continue updating them over time.

Migration Logic

Terminology

Export Settings > Export Upstream Resources: includes upstream Resources of the selected Resource. For example, exporting a Dashboard can also include upstream Data Accounts, Datasets, and ETL. During import, you can choose not to import some of them.
Related Resources: Resources that are not displayed on the Resource Lineage page. For example, related Resources of a Dashboard include specific Cards, while related Resources of a Dataset include Global Parameters and custom drivers.

Resource Migration Logic Diagrams

When the Selected Import ID Changes

When the Selected Import ID Remains Unchanged

Note

For Online Migration, imported Resource IDs remain unchanged by default.

Usage Restrictions

Relevant restrictions are also described in the operation steps.

Supported for administrators. If regular users also need this capability, you must grant the relevant RBAC permissions to regular users through custom roles.
During migration, Resource Permissions, row- and column-level permissions of Datasets, and Data Masking templates are not migrated.
For Data Account security, password-related information of Data Accounts is not migrated.
To avoid performance risks and excessive migration time, data itself is not migrated.
Some special configurations or Resources may not be fully covered by migration and must be checked again, such as custom fonts and component templates.
Online Migration currently supports only cross-environment migration. It does not support migration across multiple domains within the same environment, such as migrating from domain A in environment A to domain B in environment A, or migrating from environment A to domain A in environment B and then to domain B in environment B.

Offline Migration

Entry

Admin Center > Resource Management > Resource Migration.

Notes Before Migration

Version: using the same version is recommended.
Feature switches: make sure the enabled features are consistent across the two environments.
If regular users also need to perform migration, you can configure the corresponding feature permissions for the regular user role under Admin Center > User Management > Role Configuration.

Procedure

Export an Appropriate Resource Package

You can export Dashboards, big screens, Intelligent Attribution pages, mobile lightweight apps, desktop apps, ETL, and Datasets that you have permission to access.

Package Name: supports names up to 20 characters. It is recommended to use unique identifiers such as dates or content descriptions for easier follow-up management.
Export Settings: choose whether to select Export Upstream Resources. It is recommended to select this option for the first migration unless the relevant upstream Resources already exist in the target environment. For subsequent migrations, this option is usually left unselected.
Resource Selection: select the Resources to export by Resource type.

After clicking Export Resources, go to the Migration Records page to download the package. If many Resources are included, a waiting period may be required.

Description

Export of Card Datasets has been supported since V6.5.0.

Import a Resource Package

Resource Import: only .zip package files exported by the system are supported.
Resource Parsing:
- Whether the Resource ID changes:
  - Select Yes when the imported Resource ID should change. This is commonly used in the following scenarios:
    1. One-time import with no follow-up iterations
    2. The same Resource is needed across multiple domains in the target environment
  - Select No when the imported Resource ID should remain unchanged. This is commonly used in the following scenarios:
    1. Continuous iteration through migration is still required after import
    2. You want to keep the same Resource unique in the target environment
- Parsing List:
  - Before import, the system displays the Resource type, Resource name, pre-import Resource ID, and import method. You can choose to import or skip each item, but make sure that any skipped upstream Resource already exists in the target environment with the same ID. Otherwise, import may fail.
  - After import, the system additionally displays the post-import Resource ID, path, and import status. Keep this page open until the import is complete.

If an import error occurs, adjust the package based on the error message and import again.

If ID remains unchanged is selected, you can directly re-import the adjusted package.
If ID changes is selected, make sure to clean up the Resources that were previously generated successfully.

Post-Import Checklist

After a successful import, check the migrated Resources from top to bottom in the order below. You can click the corresponding Resource from the post-import list page to jump to it directly. Data Accounts need to be searched manually.

Resource Type	Items to Check and Possible Issues
Data Account	For password confidentiality, the Data Account password must be re-entered, and User permission must be granted again.
Dataset	Because Datasets can be large and may cause performance risks, data itself is not migrated. For live or extract Datasets, manually run refresh and check refresh settings, row- and column-level permission templates, Data Masking templates, and user permissions. For file Datasets, manually replace the Dataset and check row- and column-level permission templates, Data Masking templates, and user permissions. For Form Datasets and FTP Datasets, manually verify that the writeback feature works properly. The following Dataset types are currently not supported for migration: third-party Datasets such as 2Dfire, SalesEasy, Wenjuanwang, WeChat Official Account, Sanqianke, Jinshuju, rolling plan Datasets, and Account Datasets.
ETL	Manually run ETL and check refresh settings and user permissions.
Dashboard	Check Quick Query and user permissions. If the Dashboard uses special Resources, check them again, such as indoor maps, custom icons, user attributes, custom fonts, and component templates.
Big Screen	Check user permissions.
Lightweight App	Check user permissions.
Desktop App	Check user permissions.

Possible Causes of Import Failure

Failed Resource Type	Error Description	Example
Entire Package	The feature switch is disabled. Contact your Guandata CSM to enable it.	-
Entire Package	The feature license limit has been exceeded. Contact Guandata sales.	Error message: `[message] = The application contains big screens, and the number of big screens has exceeded the upper limit`
Card	When IDs change, the import path becomes invalid. Adjust the import path and import again.	-
ETL	The input Dataset of the ETL is not included in the import package.	`Input Dataset not matched`
ETL	Datasets in the same directory cannot have duplicate names. Rename the Dataset in the source environment and then import again.	`A file with the same name already exists in the output dataset directory. Please modify it`
Dataset	A Dataset with the same ID was deleted in the target environment. Use import with ID changes or copy a Dataset in the source environment and replace it.	`The current dataset has been deleted in the target environment and cannot be imported repeatedly`
Dataset	The target environment is multi-domain, and another domain already contains a Dataset with the same ID. Use import with ID changes or copy a Dataset in the source environment and replace it.	`Another domain contains the same dataset id, and the dataset cannot be imported repeatedly into the current domain`
Dataset	A field with the same ID has been deleted from the Dataset. Use import with ID changes or copy a Dataset in the source environment and replace it.	`Duplicate entry 't991094c76a394229b308950-a23d2757620fc47b7a6e0534' for key 'ds_fd'`
Data Account	Data Account names must be unique. If the ID differs, rename the Data Account in the source environment.	`Duplicate Data Account name`