Skip to main content

Preparing to run the Tableau collector

Setting up pre-requisites for running the collector

Make sure that the machine from where you are running the collector meets the following hardware and software requirements.

Table 1.



Hardware (for on-premise runs only)

Note: The following specs are based upon running one collector process at a time. Please adjust the hardware if you are running multiple collectors at the same time.


8 GB


2 Ghz processor

Software (for on-premise runs only)


Click here to get Docker. specific objects (for both cloud and on-premise runs)


You must have a ddw-catalogs dataset set up to hold your catalog files when you are done running the collector.

If you are using Catalog Toolkit , follow these instructions to prepare the datasets for collectors.

Setting up Tableau

Enabling Metadata API

The collector harvests from Tableau using the Tableau Metadata API. The Metadata API is always enabled for Tableau Cloud. However, by default, the Metadata API is disabled by default for Tableau Server.


For detailed instructions, see the Tableau documentation.


  1. You must be on Tableau Server 2019.3 or later

  2. The REST API must not be disabled.

  3. You must use an account with server admin role to enable the Metadata API on Tableau Server using the Tableau Services Manager (TSM) command line interface (CLI).

To enable metadata API:

For detailed instructions about doing this task, refer the Tableau documentation.

  1. Open a command prompt as an admin on the initial node where TSM is installed in the cluster.

  2. Run the following command:

    tsm maintenance metadata-services enable
  3. If you do not have the Data Management license, you will need to enable derived permissions to see related external assets. For details see the Tableau documentation.

Setting up permissions

  1. Set up a new user in Tableau with the Server Admin role.

  2. Create a Personal Access Token (PAT) for the new user. See Tableau docs for details.