Skip to main content

Tableau assets package

The Tableau assets package crawls Tableau assets and publishes them to Atlan for discovery.

Direct extraction​

Will create a new connection

This should only be used to create the workflow the first time. Each time you run this method it will create a new connection and new assets within that connection — which could lead to duplicate assets if you run the workflow this way multiple times with the same settings.

Instead, when you want to re-crawl assets, re-run the existing workflow (see Re-run existing workflow below).

To crawl Tableau assets directly from Tableau:

Direct extraction from Tableau
Workflow crawler = TableauCrawler.creator( // (1)
      client, // (2)
      "production", // (3)
      List.of(client.getRoleCache().getIdForName("$admin")), // (4)
      null,
      null
    )
    .direct(  // (5)
      "example.online.tableau.com",
      "atlan-site",
      true
    )
    .basicAuth( // (6) (7)
      "atlan-user",
      "atlan-pass"
    )
    .include( // (8)
      List.of("fc2923bd-cf94-2b29-9cdd-9cc2f7a4f029")
    )
    .exclude(List.of()) // (9)
    .crawlUnpublished(true)  // (10)
    .crawlHiddenFields(false)  // (11)
    .alternateHost("https://alternate.tableau.com")  // (12)
    .build()  // (13)
    .toWorkflow();  // (14)
WorkflowResponse response = crawler.run(client);  // (15)

  1. The TableauCrawler package will create a workflow to crawl assets from Tableau.

  2. You must provide Atlan client.

  3. You must provide a name for the connection that the Tableau assets will exist within.

  4. You must specify at least one connection admin, either:

    • everyone in a role (in this example, all $admin users).
    • a list of groups (names) that will be connection admins.
    • a list of users (names) that will be connection admins.

  5. To configure the crawler for extracting data directly from Tableau then you must provide the following information:

    • hostname of your Tableau instance.
    • site to crawl within Tableau.
    • whether to use SSL for the connection.

  6. When using basicAuth(), you must provide the following information:

    • your username for accessing Tableau.
    • your password for accessing Tableau.

  7. or you also can use personalAccessToken() auth, then you must provide the following information:

    • your username for accessing Tableau.
    • your access token for accessing Tableau.

  8. You can also optionally specify the list of projects to include in crawling. For Tableau assets, this should be specified as a list of project GUIDs. (If set to null, all projects will be crawled.)

  9. You can also optionally specify the list of projects to exclude from crawling. For Tableau assets, this should be specified as a list of project GUIDs. (If set to null, no projects will be excluded.)

  10. You can also optionally set whether to crawl unpublished worksheets and dashboards (true) or not (false).

  11. You can also optionally set whether to crawl hidden datasource fields (true) or not (false).

  12. You can also optionally set an alternate host to use for the "View in Tableau" button for assets in the UI.

  13. Build the minimal package object.

  14. Now, you can convert the package into a Workflow object.

  15. You can then run the workflow using the run() method on the object you've created. Because this operation will execute work in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    Workflows run asynchronously

Remember that workflows run asynchronously. See the packages and workflows introduction for details on how you can check the status and wait until the workflow has been completed. :::

Offline extraction​

Will create a new connection

This should only be used to create the workflow the first time. Each time you run this method it will create a new connection and new assets within that connection — which could lead to duplicate assets if you run the workflow this way multiple times with the same settings.

Instead, when you want to re-crawl assets, re-run the existing workflow (see Re-run existing workflow below).

To crawl Tableau assets from the S3 bucket:

Coming soon

Re-run existing workflow​

To re-run an existing workflow for Tableau assets:

Re-run existing Tableau workflow
List<WorkflowSearchResult> existing = WorkflowSearchRequest // (1)
    .findByType(client, TableauCrawler.PREFIX, 5); // (2)
// Determine which of the results is the Tableau workflow you want to re-run...
WorkflowRunResponse response = existing.get(n).rerun(client); // (3)

  1. You can search for existing workflows through the WorkflowSearchRequest class.

  2. You can find workflows by their type using the findByType() helper method and providing the prefix for one of the packages. In this example, we do so for the TableauCrawler. (You can also specify the maximum number of resulting workflows you want to retrieve as results.)

  3. Once you've found the workflow you want to re-run, you can simply call the rerun() helper method on the workflow search result. The WorkflowRunResponse is just a subtype of WorkflowResponse so has the same helper method to monitor progress of the workflow run. Because this operation will execute work in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    • Optionally, you can use the rerun(client, true) method with idempotency to avoid re-running a workflow that is already in running or in a pending state. This will return details of the already running workflow if found, and by default, it is set to false
    Workflows run asynchronously

Remember that workflows run asynchronously. See the packages and workflows introduction for details on how you can check the status and wait until the workflow has been completed. :::

Was this page helpful?