Breadcrumbs

Tableau - Check Refresh Status (Deprecated)

Overview

This Blueprint has been deprecated. Please use the vendor's "Trigger" Blueprint and set the "Wait for Completion" option to "True". Using this new option is free, more stable, and will complete faster. Read more about this change [here](https://www.shipyardapp.com/blog/orchestrate-data-tools-free). Check the job status of a workbook or datasource that has recently been refreshed in Tableau. **Recommended Setup:** 1. A Vessel built with this Blueprint should be paired with guardrail retries. This will allow the Vessel to continually check for status until a final result is found. 2. This Vessel should run immediately after a Vessel built with the _Tableau - Trigger Workbook/Datasource Refresh_ Blueprint. With this setup, you can leave the Job ID field blank and this Vessel will check for the results of the recently created job.

Variables

Name

Reference

Type

Required

Default

Options

Description

Authentication Method

TABLEAU_SIGN_IN_METHOD

Select

username_password

Username & Password: username_password

Access Token: access_token

Determine which authentication method to use when connecting to Tableau.

Username or Access Token Name

TABLEAU_USERNAME

Alphanumeric

None

-

Your personal username or the name of the access token that you use to log in with Tableau.

Password or Access Token

TABLEAU_PASSWORD

Password

None

-

The password associated with the provided username OR the access token associated with the provided access token name.

Server URL

TABLEAU_SERVER_URL

Alphanumeric

None

-

The scheme, subdomain, domain, and top-level domain (TLD) of your Tableau URL.

Site ID

TABLEAU_SITE_ID

Alphanumeric

None

-

Typically found in the URL as /site/YOURSITEID/

Job ID

TABLEAU_JOB_ID

Alphanumeric

None

-

The ID of a specific job you check the status of. If left blank, will try to find the job ID from an "Refresh Workbook/Datasource" Vessel that ran upstream.

YAML

Below is the YAML template

YAML

source:
  template: Tableau - Check Refresh Status (Deprecated)
  inputs:
    TABLEAU_SIGN_IN_METHOD: username_password
    TABLEAU_USERNAME:
    TABLEAU_PASSWORD:
    TABLEAU_SERVER_URL:
    TABLEAU_SITE_ID:
    TABLEAU_JOB_ID:
  type: TEMPLATE
guardrails:
  retry_count: 12
  retry_wait: 0h5m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 200
    - 201
    - 202
    - 203
    - 204
    - 205
    - 210
    - 211