X-Org Migration
Gainsight NXT
|
IMPORTANT: This article applies to the new version of X-Org. If you are using the old version of X-Org, you can find the support documentation by clicking here. |
This article explains to admins about the overview of X-Org migration, prerequisites, limits, how to set up a migration and various actions that you can perform in the respective tabs.
Overview
X-Org helps you to migrate configuration and assets from source org to target org. For example, you can migrate a custom object's schema, reports, rules, and playbook assets from a source org to a target org. To access this feature navigate to the Administration > General > X-Org.
Business use case: If you have built and tested rules in your sandbox org, you may want to migrate them to your production org. This feature saves admins valuable time and is enabled within your org by default.
Prerequisites: You must be a Super Admin in order to complete a migration.
Supported Items: For a full list of supported items, refer to the Supported Migration Items article.
Limitation in Asset Migration
Conflict resolution is not supported for any of the assets, during migration. For example, if an asset with the same name already exists in the target org, the migration fails (if unique name constraint is applicable for the asset) or a new asset is created (if unique name constraint is not applicable for the asset).
Supported Modules/Assets for X-Org
The following are the supported list of features for X-Org:
Note: Dependency resolution is a functionality that helps admins to add dependent assets in a bundle, when they add an asset to the bundle.
| Gainsight Feature | X-Org Support | Assets | Dependency Resolution |
| Business Modeler | Yes | C360 Sections, R360 Sections | Yes |
| Success Plan | Yes | Success Plan Templates | Yes |
| Reports | Yes | Horizon Analytics Reports | Yes |
| Success Snapshots | Yes | All Success Snapshots | Yes |
| Data Management | Yes | Objects, Dropdown lists | Yes |
| Rules Engine | Yes | Bionic Rule | No |
| People Management (Only Bionic Rules) | Yes | NA | No |
| Cases Management (only Bionic Rules) | Yes | NA | No |
| Dashboards | Yes | Horizon Analytics Dashboards, Old Dashboards | No |
| Cockpit | Yes | Reporting Category, DA Picklist, PlayBooks | No |
| Scorecards | Yes | SC Mass Edit Report, SC Habit Report | No |
| Timeline | Yes | Activity Configuration - Activity Types | No |
| Journey Orchestrator | Yes | Programs | No |
| Communication Hub | Yes | Email templates | No |
| Surveys | Yes | All Surveys | No |
Setup Migration
To migrate assets from a source org to a target org, perform the following steps:
- Create a Connection Request
- Accept a Connection Request
- Create and Migrate a Bundle
Create a Connection Request
Admins must create a connection request from source to target org. After the request is accepted by the target org, admins can migrate the asset bundles from source to target org.
IMPORTANT:
- Your Tenant Name and ID will be shared with the request.
- This connection request will be valid for 3 days. After which you need to send a new request in order to perform the assets migration.
To create a connection:
- Navigate to the Administration > General > X-Org > Connected Tenants tab.
- Click Create Connection. The Request Tenant Connection window is displayed.
- In the Target Tenant ID field, enter the tenant ID of the target org.
Note: You can get the tenant ID of the target org in the Administration > General > Application Settings.
- Click Send Request. An email is sent to the Admin of the target org containing the connection request information.
Accept Connection Request
After a connection request is submitted from the source org, you will receive a connection request In the target org. You can approve or decline the request as per your requirement.
To accept connection request:
- Navigate to the Administration > General > X-Org > Connected Tenants tab.
- Click the three-vertical dots menu of the connection request and select Approve. The Approve Connection Request window is displayed.
- From the Connection Expiry Date field, select the preferred date.
- Click Approve.
Note: After you approve the request, your tenant name will be shared with the source org.
Create and Migrate a Bundle
Bundle is a collection of assets from various Gainsight features. You can create a Bundle with many assets from different Gainsight features.
To create and migrate a bundle:
- Navigate to the Administration > General > X-Org > Bundles tab.
- Click Create Bundle. The Basic Information step is displayed.
- In the Bundle Name field, enter a unique name for the bundle.
- In the Bundle Description field, enter a brief description of the bundle.
- Click Prepare. Preparation step is displayed.
- From the Asset Type dropdown, select the required type of asset.
- From the Entity Type dropdown, select the required type of entity.
- Drag and drop the assets from the left pane to the Preparation screen.
Note: Currently, dependency resolution is supported only for a few features, Gainsight will gradually add this capability for all the features in the future releases.
- (Optional) Click Save to save the changes and migrate the assets later.
- Click Save and select Save & Migrate to start the migration. Migrate <Bundle Name> dialog is displayed.
- From the Target Tenant dropdown, select the connection of target org.
- In the Notify via Email to field, enter the email ID to receive notification about the migration status.
- In the Fields Mapping section, click + Add Source Object to map your source object fields to target object fields for the successful migration. If you do not map the target object, then a new object will be created in the target org for the migration.
Note: You can add multiple source objects to map the respective target objects.
- (Optional) Click Run Test Migration to test the migration of assets to the target org.
- Click Migrate to submit the migration request.
Options in Connected Tenants Tab
Once the connection is accepted in the target org, you will see the connection details under the All Tenants section. The following details are displayed in this section:
- Tenant Name: Displays the name of the target org.
- Tenant ID: Displays the ID of the target org.
- Tenant Type: Displays the tenant type of the connection:
- Source: The current org is a source org from where the assets need to be migrated to target org.
- Target: The current org is a target org which receives the assets from the source org.
- Expiration Date: Displays the expiry date of the connection.
- Actions: It contains the following options based on the Tenant type:
- Edit Access: (Only applicable to target org) You can edit the connection to update the expiry date.
- Revoke Access: (Only applicable to target org) You can end the access source org’s access.
- Delete: Deletes the connection between the two orgs.
Options in Bundles Tab
After a bundle is created, you can find the following options in the Bundles tab:
- View Bundle Content: Displays the assets of the bundle. You can also perform the following activities:
- Edit: You can modify the bundle’s basic information and assets.
- Prepare for Migration: You can directly migrate the bundle to the target org.
- Edit Bundle Content: Modify the bundle’s basic information and assets.
- Refresh Bundle: Refresh the bundle to update the assets information.
- Migrate Bundle: Copies the bundles to the target org.
- Delete Bundle: Deletes the bundles permanently from the respective org.
Options in Migration Tab
In the Migration tab, you can find the following options:
- Filter Migrated Bundles: Displays the migrated bundles as per the following options:
- All, Inbound, or Outbound
- All, Failure, In Progress, Partial Success, Pending, or Success
- Refresh: Refreshes the migration bundle list.
- Search: Helps to find the specific bundle by its name.
- Context Menu of the Bundle: The three-vertical dots menu of a Bundle contains the following options:
- View Migration Detail: Displays the details of the migrated Bundle like name, migration type, target tenant ID, target tenant name, migration date and assets. You can also perform the following activities:
- Download Logs: You can download a csv file containing the details of the migration.
- Prepare for Migration: You can directly migrate the Bundle to the target org.
- View Bundle Content: (Only applicable to Source org) Displays the assets of the Bundle. You can also perform the following activities:
- Edit: You can modify the Bundle’s basic information and assets.
- Prepare for Migration: Migrate the bundle directly to the target org.
- Download Logs: Downloads a CSV file containing the details of the migration.
- View Migration Detail: Displays the details of the migrated Bundle like name, migration type, target tenant ID, target tenant name, migration date and assets. You can also perform the following activities:
Migrate Rules with S3 Dataset
If you migrate a Rule with an S3 dataset task, the bucket details are also migrated successfully. When you migrate a Rule with an S3 dataset:
- The rule and the associated S3 bucket (Gainsight Managed or Custom) are successfully migrated.
- The bucket associated with an S3 dataset task is migrated as an independent asset.
- A corresponding bucket with the same name as provided in the source org is created in the target org. However, if the target org already has a bucket with the same name as in the source org, a new bucket will not be created.
- When a new bucket is created in the target org, the associated Access Key and Security Token are not copied from the source org.
- You must go to the Connectors 2.0 page and update the Access Key and Security Token for the bucket which was created due to migration.