Migration Plans: Servers

The first step when creating a migration plan in the Tableau Content Migration Tool is to sign in to the source and destination servers.

In the Servers section of the Planning phase, you’ll sign in to the source and destination servers. The sites and projects you see when creating a migration plan are governed by the permissions of the user credentials you use. You can only migrate content that the user has access to.

Note: Tableau Online migration using the Content Migration Tool is in pre-release and under active development. To learn about the terms and conditions of Tableau's Pre-Release program, see Tableau Environment Migrations on the Pre-Release website(Link opens in a new window).

Required permissions and licenses

The user account(s) used to sign in to the source and destination servers must have an Explorer role or higher, and the following permissions for the content you want to migrate:

  • View
  • Download Workbook/Save a Copy
  • Optional: Administrator (to select workbooks, to access a user list)

Both the source and destination sites must have a valid Server Management Add-on license. For more information, see About Tableau Server Management Add-on.

Step 1: Source

Here is the starting point of the migration. Sign in to your server, and then select which site to use as the source. Sites are independent silos of workbooks, data, and user lists created within Tableau to group related content for selected users. You can only migrate content from one site at a time.

Sign in to the source server

Use the steps below to sign in to Tableau Online or Tableau Server.

  1. Click Sign in to Tableau.
  2. In the Select a Server dialog window, select a saved connection and click Continue.

    If no connections are available, click Add or edit saved connections to add a new connection. For more information, see Saved connections.

  3. Enter your username and password, and click Sign In.

    If your server is configured for SAML or Single Sign-On, you are redirected to the Identity Provider sign-in page to complete the authentication process.

  4. Select the site you want to use.

To change the source server or update your site selection, click Select a different source.

Step 2: Destination

Repeat the server sign-in process for the destination server (the server you are migrating content to).

If you are migrating your workbooks between two sites on the same Tableau Server, your sign-in credentials for the source and destination servers may be very similar or identical (including the Server URL). At a minimum, they will have a different site selected.

Saved connections

Using saved connections allow you to quickly sign in to the source and destination servers by creating a reusable server connection. When adding a saved connection, you must specify the preferred sign-in method for your server. As of 2021.2, the Content Migration Tool supports the following sign-in methods:

  • Personal access tokens: Allows users to create long-lived authentication tokens for improved security, auditing, and automation of migration plans. Personal access tokens let users sign in without requiring interactive login in the Content Migration Tool. For more information, see Personal Access Tokens.

  • Browser-based sign-in: Users enter their credentials and complete authentication through an embedded web browser. This option may be similar to how you usually authenticate to Tableau.

  • Username and password sign-in: Users authenticate through the Content Migration Tool instead of an embedded browser window. This option passes credentials to the server using Tableau Server REST APIs. You can use username and password sign-in to authenticate to migration plans created before version 2020.3 and when troubleshooting issues that prevent the use of browser-based sign-in.

Add or edit saved connections

A link to Add or edit saved connections is displayed at the bottom of the Content Migration Tool, and when signing in to the source and destination servers. Clicking this link will open the Manage Tableau Server Connections window.

Use the steps below to add a saved connection:

  1. On the Manage Tableau Server Connections window, click New Connection, or select an existing connection to make changes.

  2. Enter a Connection Name (name to describe your server) and the Server URL.

    If you don't include a prefix for the Server URL, the Content Migration Tool will use http://.

  3. Select the sign-in method for your connection.

    If you're using personal access tokens, see Add saved connections with personal access tokens.

  4. Click Save.

After you create a saved connection, it's listed in the Select a Server window next time you sign in to the source and destination servers.

Add saved connections with personal access tokens

Adding a saved connection with a personal access token requires more information than other sign-in methods. You will need to create a new personal access token on the source and destination servers to begin. Personal access tokens should not be shared between applications. For more information, see Personal Access Tokens.

Creating personal access tokens
  1. In a web browser, sign in to Tableau Online or Tableau Server.

  2. At the top of the page, click your profile image or initials, and then select My Account Settings.

  3. Under Personal Access Tokens, enter a descriptive name for your token in the Token Name field, and then click Create new token.

  4. In the resulting window, click Copy to clipboard and then close the window.

  5. Paste the token secret to a file. Store the file in a safe location.

Adding personal access tokens
  1. In the Content Migration Tool, click Add or edit saved connections.

  2. On the Manage Tableau Server Connections window, enter a Connection name and the Server URL.

    If you are connecting to Tableau Online, you must enter the full pod URL of your site. For example, https://10ay.online.tableau.com. Your pod is shown in the first portion of the site URL after signing in to Tableau Online.

  3. Enter the Personal access token name and Personal access token secret, obtained when creating a personal access token in the previous section.

  4. In the Site name field, enter the site name as it appears in the URL, without spaces. This is different than the friendly site name. For example, “Site A” would be “sitea” in a browser URL.

  5. Click Save.

Step 3: Continue to the next step

After successfully signing in to both source and destination servers, click Next to continue to the Migration Plans: Source Projects section of the planning phase.

Who can do this

Tableau Server user with an Explorer role or higher. To migrate content, you must have View and Download Workbook/Save a Copy permissions on the source site, and Publishing rights for the destination site. For more information, see Permissions.

Thanks for your feedback!