Skip to main content

Load Metadata from Tableau Server

Use the Tableau Loader to upload metadata to Alteryx Connect for Tableau reports located in a specified Tableau server.

Review Loader Requirements

  • The Alteryx Connect Loaders must be installed on the machine where Alteryx Server is installed. To install the loaders:

    1. Go to downloads.alteryx.com. For compatibility, the Loaders installer version must match your Alteryx Connect version. Find your version of Connect and select it to see available files. Download the Alteryx Connect Loaders EXE.

      Connect downloads screen

    2. Run the installer as an administrator.

  • Obtain the Tableau web URL (for example, http://tableau.mycompany.com:8000), username, and password.

  • Ensure that the Tableau REST API (v2.5 with Tableau Server 10.2 or later) is enabled. The REST API is enabled by default.

Tableau Authentication Method

  • Tableau loader provides two mechanisms for authenticating against Tableau Server: username/password or a Personal Access Token.

  • Personal Access Token is currently a recommended authentication method by Tableau.

  • To generate the Personal Access Token, go to Tableau, select My Account Settings > Settings > Personal Access Tokens. Please note that the token expires after 15 days of not being used.

  • You can still use username/password for direct access, especially when SAML is not used, to login to Tableau server (see Tableau REST API and SAML).

  • To obtain metadata about workbook users, you need to run the loader under a user with administrator or site-administrator permissions.

Tableau REST API and SAML

Tableau loader uses REST API to communicate with Tableau server. When you use SAML/SSO to login to your Tableau server, you have to create a native Tableau user and login with those credentials or use Personal Access Token to establish the connection to Tableau server.

Open the Loader

  1. Open Alteryx Designer.

  2. Select Help > Sample Workflows > Alteryx Connect Metadata Loaders > Tableau Loader > Tableau Loader.

Run the App

Important

To run the Tableau loader as an app for a Tableau Online server, you should be assigned to Site Administrator Explorer role (in Tableau Online) needed to communicate to Tableau Graph API.

The missing role assignment will be indicated in the engine log with the following message:

Get response from GraphQL: Can't run the query because you must be an admin...

  1. Select Run as Analytic App

    Run as analytic app button

    .

  2. In the Tableau server tab, type the Tableau connection information.

    1. Provide Tableau server URL.

    2. Indicate whether the Tableau server is either on-premises- or online- Tableau server.

    3. When loading on-premises server you can optionally filter the loaded sites. Select to load either all available sites or provide a list of sites to load. Otherwise, only the “Default” site will be loaded by default.

    4. Choose your authentication method and fill in the credentials.

    5. Optionally adjust the Project level filter – all projects, favourite projects only, or comma-delimited list of project names.

    6. Optionally disable loading workbook thumbnails.

    1. In the Alteryx Connect tab, type the URL for your Alteryx Connect instance and your credentials.

      https://yourcompany.alteryxconnect.com

    2. Before running the app, select Save button and save the app configuration to the following directory:

      C:\ProgramData\Alteryx\AlteryxConnect\Tableau_Loader\

      The .yxwv app values file is used for scheduling the loader to run in the Gallery. See Schedule Metadata Loaders.

  4. Select Finish to run the app.

    Depending on how much metadata is being imported, the app can take a long time to run.

    • If the run succeeds, "Success" appears in the App Results window.

    • If the run fails, a "There were Errors" message appears.

View the Metadata

  1. Go to the Alteryx Connect URL and log in.

  2. From the main menu, select Reports > Tableau.

  3. Select a folder to view its contents.

In this section: