Tableau - Trigger Workbook Refresh

info

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

Overview

Manually trigger a refresh of a workbook 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

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	✅	-	-	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	✅	-	-	The password associated with the provided username OR the access token associated with the provided access token name.
Server URL	TABLEAU_SERVER_URL	Alphanumeric	✅	-	-	The scheme, subdomain, domain, and top-level domain (TLD) of your Tableau URL.
Site ID	TABLEAU_SITE_ID	Alphanumeric	✅	default	-	Typically found in the URL as /site/YOURSITEID/
Project Name	TABLEAU_PROJECT_NAME	Alphanumeric	✅	-	-	The project name that the Datasource belongs to.
Workbook Name	TABLEAU_WORKBOOK_NAME	Alphanumeric	✅	-	-	Name of the published workbook you want to refresh.
Wait For Completion	TABLEAU_WAIT	Boolean	➖	TRUE	-	Enable if you wish for the vessel to wait for the resource to finish loading before exiting

YAML

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

source:
  blueprint: Tableau - Trigger Workbook 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_WORKBOOK_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'