One enterprise capability of Elements for Tableau is its migration feature. App admins can set up migration targets. These migration targets are other environments of the same app (the web UI is the same, they have the same features and components).
Migration allows for operating multiple environments simultaneously through the effortless transfer of resources between the environments e.g. Through migration it is possible to maintain a Development, a Test, and a Production environment. Admins can easily transfer resources like Workspaces, Annotation Rules, even the Extension without having to reconfigure the entire app.
Once a migration is completed, further changes to the initial environment will not appear automatically in the other Migration Target environments.
Migration can only be executed if one user exists in both environments with the same login details and permissions.
How to set up Migration Targets?
A Migration Target is another Elements for Tableau environment to which you can transfer all of the resources of your current environment. The following guide walks you through the steps of setting up a Migration Target:
1. Create another Elements for Tableau environment
Note: You do not need to fully configure the new environment
2. Go back to your initial environment and click on “Migration Targets”
3. Click on “Add migration target”
4. Give a custom name to your Migration Target e.g. If you want to create a Test environment, then name it “Test”
5. Copy the URL of your new environment created in Step 1 (Ctrl + C/ Cmnd + C)
6. Go back to your initial environment and paste the URL into the “Server URL field”
7. (Optional) Give a description of what the new environment was set up for
8. (Recommended) Find the secret key used by the Migration Target to enhance secure information transfer between the two environments
9. Open the JSON (appsettings) configuration file of your new environment and find the secret key
10. Copy the secret key
11. Paste it to the JWT Symmetric Key field
Note: If you leave the field empty, your Migration Target will use the secret key of the initial environment to sign tokens when the transfer is being made
12. Click on “Create”
How to migrate resources?
There are two main ways how migration can be completed:
Creating a new resource (Workspace/Data Source/Tableau Server) in the new environment
This way a new resource will be created in the migration target environment and the current resource’s data will be transferred into the newly created resource.
It is recommended to perform migration in the following order to save time and maintain clarity:
1. Workspace Migration
2. Data Source Migration
3. Tableau Server Migration
4. Annotation Rule Migration
5. Notification Channel Migration
Migration by creating new resources in the new environment
Workspace Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
3. Select “Create a new workspace”
4. Give a custom name to the workspace in the migration target environment. Tip: To maintain clarity choose a name that makes identifying the original workspace easy e.g. original: Workspace1 new: Workspace1_test
5. (Recommended) Leave “Migrate permission matrix” ticked in order to migrate all of the users with their permissions into the new environment
6. Click on “Perform migration”
Data Source Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
Note: If you have already completed the migration of the workspace, the "Select Remote Workspace" field should be auto completed for you, otherwise go to Step 3
3. Select a remote workspace (from the Migration target environment) the Data Source should belong to (hence it was important to first migrate the workspace)
4. Select “Create a new data source”
5. Give a custom name to the data source in the migration target environment. Tip: To maintain clarity choose a name that makes identifying the original data source easy e.g., original: Datasource1 new: Datasource1_test
6. Click on “Perform migration”
Tableau Server Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
Note: If you have already completed the migration of the workspace, the "Select Remote Workspace" field should be auto completed for you, otherwise go to Step 3
3. Select a remote workspace (from the Migration target environment) the Tableau Server should belong to (hence it was important to first migrate the workspace)
4. Select “Create a new server”
5. Give a custom name to the Tableau Server in the migration target environment. Tip: To maintain clarity choose a name that makes identifying the original Tableau Server easy e.g., original: Server1 new: Server1_test
6. Click on “Perform migration”
Annotation Rule Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
Note: If you have already completed the migration of the workspace, the "Select Remote Workspace" field should be auto completed for you, otherwise go to Step 3
3. Select a remote workspace (from the Migration target environment) the Annotation Rule should belong to (hence it was important to first migrate the workspace)
4. Select “Create a new rule”
5. Give a custom name to the annotation rule in the migration target environment. Tip: To maintain clarity choose a name that makes identifying the original annotation rule easy e.g., original: Rule1 new: Rule1_test
Note: if you completed the steps beforehand in the right order, the following fields should be auto completed for you, otherwise go and complete Step 6 and 7
6. Select a remote Tableau Server (from the Migration target environment) the Annotation rule should use (hence it was important to migrate the Tableau server beforehand)
7. Select a remote Data Source (from the Migration target environment) the Annotation r ule should use (hence it was important to migrate the Data Source beforehand)
8. If kept ticked, the Annotation Rule will be opened in a separate tab once the migration is successfully completed
9. Click on “Perform migration”
Note: Every property of the remote rule will be updated except for Notification Channels. You have to migrate these Notification Channels separately
App Notification Channel Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
3. Select “Create a new notification channel”
4. Give a custom name to the notification channel in the migration target environment. Tip: To maintain clarity choose a name that makes identifying the original notification channel easy e.g. original: Email2 new: Email2_test
5. Click on “Perform migration”
Workspace Notification Channel Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
Note: If you have already completed the migration of the workspace, the "Select Remote Workspace" field should be auto completed for you, otherwise go to Step 3
3. Select a remote workspace (from the Migration target environment) the Notification Channel should belong to (hence it was important to first migrate the workspace)
4. Select “Create a new notification channel”
5. Give a custom name to the notification channel in the migration target environment. Tip: To maintain clarity choose a name that makes identifying the original notification channel easy e.g. original: Email1 new: Email1_test
6. Click on “Perform migration”
Migration by updating an already existing resource
(Workspace/Data Source/Tableau Server)
This way you can select an already existing resource from your migration target environment and update it with the current resource’s data.
The order of the migration is negligible as you only update already existing resources with current information.
Workspace Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
3. Select “Update an existing workspace”
4. Select an already existing workspace (from the Migration Target environment) from the dropdown list that should be updated
Note: If the workspace you intend to use does not pop up within the first five options, search for its name in the search bar
5. (Recommended) Leave “Migrate permission matrix” ticked in order to migrate all of the users with their permissions into the other environment
6. Click on “Perform migration”
Data Source Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
3. Select a remote workspace (from the Migration target environment) the Data Source should be migrated to
Note: If the workspace you intend to use does not pop up within the first five options, search for its name in the search bar
4. Select “Update existing Data Source”
5. Select an already existing data source (from the Migration Target environment) from the dropdown list that should be updated
6. Click on “Perform migration”
Tableau Server Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
3. Select a remote workspace (from the Migration target environment) the Tableau Server should be migrated to
Note: If the workspace you intend to use does not pop up within the first five options, search for its name in the search bar
4. Select “Update existing server”
5. Select an already existing Tableau Server (from the Migration Target environment) from the dropdown list that should be updated
6. Click on “Perform migration”
Annotation Rule Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
3. Select a remote workspace (from the Migration target environment) the Annotation Rule should be migrated to
4. Select “Update existing rule”
5. Select an already existing Annotation Rule (from the Migration Target environment) from the dropdown list that should be updated
6. Click on “Perform migration”
Note: Every property of the remote rule will be updated except for Name, Data Source, Server, and Notification Channels
App Notification Channel Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
3. Select “Update existing notification channel”
4. Select an already existing notification channel (from the Migration Target environment) from the dropdown list that should be updated
5. Click on “Perform migration”
Workspace Notification Channel Migration
1. Click on the migrate button on the right-hand side
2. Select the Migration Target from the dropdown list
3. Select a remote workspace (from the Migration target environment) the Notification Channel should be migrated to
4. Select “Update existing notification channel”
5. Select an already existing notification channel (from the Migration Target environment) from the dropdown list that should be updated
6. Click on “Perform migration”
