Skip to main content

Data Sources

Tools for authoring calculations, parameters, sets, and actions, and for inventorying datasources and workbooks.

This category contains the tools:

  • Get Worksheet Underlying Data: Reads row-level underlying data for one of a worksheet's logical tables in the workbook open in the connected Tableau Studio instance — the table's rows, not the aggregated summary of the view.
  • Author Action: Authors an action in the workbook currently open in Tableau Studio.
  • Author Calc: Authors a new calculated field — a caption plus a Tableau formula — into a datasource of the workbook open in Tableau Studio.
  • Author Parameter: Adds a new parameter to the workbook open in the local Tableau Studio instance.
  • Author Set: Authors a set on a dimension in the workbook open in Tableau Studio and applies it to the live workbook.
  • Get App Info: Reports application information about the Tableau Studio instance that is currently running, including live UI state.
  • Get Summary Data: Reads the aggregated summary rows on a populated worksheet in the workbook open in the connected Tableau Studio instance — only the fields on the view, not its chart specification.
  • Get Datasources: List every datasource in the open workbook, or read one of them.
  • List Worksheet Logical Tables: Lists the logical tables of one worksheet in the workbook open in the connected Tableau Studio instance, returning each table's id and caption — the identifiers you pass when reading that worksheet's row-level underlying data with get-worksheet-underlying-data.
  • Apply Datasource Changes: Replaces an existing datasource definition in the workbook currently open in Tableau Studio with a document previously retrieved from that workbook.
  • Get Datasource Underlying Data: Read raw row-level data for one of a datasource's logical tables (see list-datasource-logical-tables), independent of any worksheet.
  • List Datasource Logical Tables: List a datasource's logical tables (id + caption), the input to get-datasource-underlying-data.
  • List Saved Data Sources: Lists Tableau Studio's Saved Data Sources (My Tableau Repository, including bundled samples like World Indicators and Sample - Superstore).
  • Set Data Source Page Active: Switch Tableau Studio to the Data Source page or back to a sheet, and return the page state read back.
  • Validate Calculated Field: Check a new or edited calculated field against a datasource without changing the workbook.
  • Refresh Datasource: Refresh a datasource in the open workbook.