Skip to main content

Tableau - Trigger Datasource Refresh

info

This Blueprint is classified as "Free" and does not incur billable runtime. Learn more.

Overview​

Manually trigger a refresh of a datasource in Tableau.

This Blueprint will kick off the refresh and will almost always return a status of success. It will create and store the generated job ID to shipyard-artifacts/tableau-blueprints/variables/job_id.pickle

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Authentication MethodTABLEAU_SIGN_IN_METHODSelectβœ…username_passwordUsername & Password: username_password

Access Token: access_token

Determine which authentication method to use when connecting to Tableau.
Username or Access Token NameTABLEAU_USERNAMEAlphanumericβœ…--Your personal username or the name of the access token that you use to log in with Tableau.
Password or Access TokenTABLEAU_PASSWORDPasswordβœ…--The password associated with the provided username OR the access token associated with the provided access token name.
Server URLTABLEAU_SERVER_URLAlphanumericβœ…--The scheme, subdomain, domain, and top-level domain (TLD) of your Tableau URL.
Site IDTABLEAU_SITE_IDAlphanumericβœ…default-Typically found in the URL as /site/YOURSITEID/
Project NameTABLEAU_PROJECT_NAMEAlphanumericβœ…--The project name that the Datasource belongs to.
Datasource NameTABLEAU_DATASOURCE_NAMEAlphanumericβœ…--Name of the published datasource you want to refresh.
Wait For CompletionTABLEAU_WAITBooleanβž–TRUE-None

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: Tableau - Trigger Datasource Refresh
inputs:
TABLEAU_SIGN_IN_METHOD: username_password ## REQUIRED
TABLEAU_USERNAME: null ## REQUIRED
TABLEAU_PASSWORD: null ## REQUIRED
TABLEAU_SERVER_URL: null ## REQUIRED
TABLEAU_SITE_ID: default ## REQUIRED
TABLEAU_PROJECT_NAME: null ## REQUIRED
TABLEAU_DATASOURCE_NAME: null ## REQUIRED
TABLEAU_WAIT: 'TRUE'
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '200'
- '201'
- '202'
- '203'
- '204'
- '205'