Tableau Component
Manage projects and workbooks in your Tableau site
Component key: tableau
Description
Tableau is an interactive data visualization software company focused on business intelligence. The Tableau component allows you to manage your users, projects, workbooks, and connections through the Tableau Rest API.
Connections
Tableau Token Connection
This component uses token authentication to interact with the Tableau API. To generate a token:
- Log in to Tableau
- Click the user icon in the top right, and click My Account Settings
- Under Personal Access Tokens, type in a Token Name and select Create new token. Take note of the Token Name and Token Secret - you'll enter those into Prismatic in a moment
- Look at your Tableau URL.
It'll look like
https://10ay.online.tableau.com/#/site/MarketingTeam/workbooks. You'll use the10ay.online.tableau.comportion as your Host Name, andMarketingTeamas your Site ID.
Now, add a Tableau step to Prismatic. This will automatically create a Tableau connection config variable. Fill in the config variable with the Token Name, Token Secret, Host Name and Site ID that you noted above.
For additional information regarding authentication, please refer to the Tableau docs.
| Input | Notes | Example |
|---|---|---|
Host Name string / Required hostName | Provide a string value for the host name of the Tableau server, without the https:// | 10ay.online.tableau.com |
Site ID string / Required siteId | The ID of your Tableau site (MarketingTeam part of https://10ay.online.tableau.com/#/site/MarketingTeam/workbooks) | MarketingTeam |
Token Secret string / Required token | Provide a string value for the Tableau Token. This value can be created from your Tableau account. | xxxxxxxxxxxxxxxxxxxxxx==:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Token Name string / Required tokenName | Provide a string value for the name of the Tableau Token. | My Token |
Triggers
Scheduled Event
Receive data from scheduled events in real time with webhook subscriptions. | key: tableauTrigger
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string apiVersion | 3.6 | The version of the Tableau API to use | 3.6 |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
API Event Name string / Required Value List events | The events to subscribe to. | ||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
Actions
Create Project
Create a new project inside your Tableau site | key: createProject
| Input | Default | Notes | Example |
|---|---|---|---|
Content Permissions string contentPermissions | This value controls user permissions in a project. However, if the project is nested within a project, it will inherit those permissions and these settings will have no effect. | ||
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Description string description | Provide a string value for the description of the project. | This is an example description | |
Parent Project Id string parentProjectId | Provide a string value for the id of the parent project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Project Name string / Required projectName | Provide a string value for the name of the project. | MyProject | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
Create User
Create a new user in your tableau site | key: createUser
| Input | Default | Notes | Example |
|---|---|---|---|
Auth Setting string authSetting | Provide a string value for the username of the user. | ||
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Site Role string siteRole | Provide a value for the role of the user. | ||
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Username string username | Provide a string value for the username of the user. For Tableau Online, this value is an email address. | someone@example.com |
Create Webhook
Creates a new webhook for a site. | key: createWebhook
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string apiVersion | 3.6 | The version of the Tableau API to use | 3.6 |
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
API Event Name string events | The name of the Tableau event that triggers your webhook | ||
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Webhook Enabled boolean webhookEnabled | true | If true (default), the newly created webhook is enabled. If false then the webhook will be disabled. | |
Webhook Name string webhookName | A name for the webhook. | My Webhook | |
Webhook URL string webhookUrl | The destination URL for the webhook. The webhook destination URL must be https and have a valid certificate. | https://example.com/webhook |
Delete Projects
Delete an existing project by Id | key: deleteProjects
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Project Id string / Required projectId | Provide a string value for the Id of your Tableau Project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
Delete User
Delete an existing user by Id | key: deleteUser
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
UserId string userId | Provide a value for the unique identifier of the user. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Delete Webhook
Deletes the specified webhook. | key: deleteWebhook
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string apiVersion | 3.6 | The version of the Tableau API to use | 3.6 |
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Webhook Id string / Required webhookId | The ID of the webhook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Delete Workbooks
Delete an existing workbook by Id | key: deleteWorkbook
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Workbook Id string / Required workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Get Project
Get an existing project | key: getProject
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Project Name string / Required projectName | Provide a string value for the name of the project. | MyProject | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
Get User
Get an existing user by Id | key: getUser
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
UserId string userId | Provide a value for the unique identifier of the user. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Get Webhook
Returns information about the specified webhook. | key: getWebhook
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string apiVersion | 3.6 | The version of the Tableau API to use | 3.6 |
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Webhook Id string / Required webhookId | The ID of the webhook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Get Workbooks
Get an existing workbook by Id | key: getWorkbook
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Workbook Id string / Required workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
List Connections
Retrieve a list of connections connected to your Tableau site | key: listConnections
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Page Number string pageNumber | Provide an integer value for the page offset for the given object's results. | 3 | |
Page Size string pageSize | Provide an integer value for the maximum amount of results that will be returned. | 20 | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Workbook Id string / Required workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
List Projects
Retrieve a list of projects connected to your Tableau site | key: listProjects
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Page Number string pageNumber | Provide an integer value for the page offset for the given object's results. | 3 | |
Page Size string pageSize | Provide an integer value for the maximum amount of results that will be returned. | 20 | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
List users
Retrieve a list of users connected to your Tableau site | key: listUsers
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Page Number string pageNumber | Provide an integer value for the page offset for the given object's results. | 3 | |
Page Size string pageSize | Provide an integer value for the maximum amount of results that will be returned. | 20 | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
List Webhooks
Returns a list of all the webhooks on the specified site. | key: listWebhooks
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string apiVersion | 3.6 | The version of the Tableau API to use | 3.6 |
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Page Number string pageNumber | Provide an integer value for the page offset for the given object's results. | 3 | |
Page Size string pageSize | Provide an integer value for the maximum amount of results that will be returned. | 20 | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
List Workbooks
Retrieve a list of workbooks connected to your Tableau site | key: listWorkbooks
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Page Number string pageNumber | Provide an integer value for the page offset for the given object's results. | 3 | |
Page Size string pageSize | Provide an integer value for the maximum amount of results that will be returned. | 20 | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
Publish Workbook
Publishes a workbook on the specified site. | key: publishWorkbook
| Input | Default | Notes | Example |
|---|---|---|---|
As Job boolean asJob | false | If false, the workbook publishing process runs as a synchronous process. If a workbook is very large, the process might time out before it finishes. If you set this value to true, the process runs asynchronously, and a job will start to perform the publishing process and return the job ID. | |
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Overwrite boolean overwrite | false | True to overwrite a workbook that has the same name, or false to fail if the specified workbook already exists. | |
Skip Connection Check boolean skipConnectionCheck | false | If true, then the Tableau server will not check if a non-published connection of a workbook is reachable. | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Upload Session Id string uploadSessionId | If you are calling this method to commit a file that was uploaded in parts, this value contains the upload session ID that was generated by a call to Initiate File Upload. | ||
Workbook File Contents data / Required workbookFileContents | The twbx file to upload as binary data. | ||
Workbook Type string workbookType | twb or twbx to indicate whether you have uploaded a workbook file (twb) or a packaged workbook file (twbx). | ||
Workbook XML code / Required workbookXml |
Raw Request
Send raw HTTP request to Tableau | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string apiVersion | 3.6 | The version of the Tableau API to use | 3.6 |
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. Specify 0 for no retries. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | Input the path only (/projects); the base URL is already included (https://{inputHostName}/api/{inputApiVersion}/sites/{siteId}). For example, to connect to https://{inputHostName}/api/{inputApiVersion}/sites/{siteId}/projects, enter only /projects in this field. Note: {inputHostName} is derived from the Host Name input in the connection configuration, {inputApiVersion} is based on the API Version input (default is 3.3), and {siteId} is automatically appended. | /projects | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. |
Search Connections
Search for a specific Connection in a Workbook | key: searchConnections
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Page Number string pageNumber | Provide an integer value for the page offset for the given object's results. | 3 | |
Page Size string pageSize | Provide an integer value for the maximum amount of results that will be returned. | 20 | |
Search Field string / Required searchField | |||
Search string / Required searchString | Provide a string value to search on. | My Project | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Workbook Id string / Required workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Search Projects
Search for a specific project by a string of text | key: searchProjects
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Page Number string pageNumber | Provide an integer value for the page offset for the given object's results. | 3 | |
Page Size string pageSize | Provide an integer value for the maximum amount of results that will be returned. | 20 | |
Search Field string / Required searchField | The field to search. Dates should follow the ISO format: 2016-05-04T21:24:49Z | Name | |
Search string / Required searchString | Provide a string value to search on. | My Project | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
Search Users
Search for a specific User by a string of text | key: searchUsers
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Page Number string pageNumber | Provide an integer value for the page offset for the given object's results. | 3 | |
Page Size string pageSize | Provide an integer value for the maximum amount of results that will be returned. | 20 | |
Search Field string / Required searchField | The field to search. Dates should follow the ISO format: 2016-05-04T21:24:49Z | Name | |
Search string / Required searchString | Provide a string value to search on. | john.doe@test.com | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
Search Workbooks
Search for a specific Workbook by a string of text | key: searchWorkbooks
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Filter Operator string / Required filterOperator | The operator to use in searching | eq | |
Page Number string pageNumber | Provide an integer value for the page offset for the given object's results. | 3 | |
Page Size string pageSize | Provide an integer value for the maximum amount of results that will be returned. | 20 | |
Search Field string / Required searchField | The field to search | Tags | |
Search string / Required searchString | Provide a string value to search on. | Tag 1, Tag 2, My 3rd Tag | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
Test Webhook
Tests the specified webhook. Sends an empty payload to the configured destination URL of the webhook and returns the response from the server. | key: testWebhook
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string apiVersion | 3.6 | The version of the Tableau API to use | 3.6 |
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Webhook Id string / Required webhookId | The ID of the webhook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Update Connection
Update the information and metadata of an existing connection by Id | key: updateConnection
| Input | Default | Notes | Example |
|---|---|---|---|
Connection Id string connectionId | Provide a value for the unique identifier of the connection. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Connection Password string connectionPassword | Provide a value for the password used to authenticate the connection. | mySafePassword | |
Connection Username string connectionUsername | Provide a string value for the username used to authenticate the connection. | myExampleUsername | |
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Embed Password boolean embedPassword | false | Enable this flag to embed the password for the connection. | |
Query Tagging Enabled boolean queryTaggingEnabled | false | Associates a specific server log query event with the Tableau resource that made the query. | |
Server Address string serverAddress | Provide a string value for the address of the server you want to connect. | 192.168.0.1 | |
Server Port string serverPort | Provide a string value for the port of the server you want to connect. | 8080 | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Workbook Id string / Required workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Update Project
Update the contents and metadata of an existing project by Id | key: updateProject
| Input | Default | Notes | Example |
|---|---|---|---|
Content Permissions string contentPermissions | This value controls user permissions in a project. However, if the project is nested within a project, it will inherit those permissions and these settings will have no effect. | ||
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Description string description | Provide a string value for the description of the project. | This is an example description | |
Parent Project Id string parentProjectId | Provide a string value for the id of the parent project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Project Id string / Required projectId | Provide a string value for the Id of your Tableau Project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Project Name string projectName | Provide a string value for the name of the project. | MyProject | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 |
Update User
Update the information and metadata of an existing user | key: updateUser
| Input | Default | Notes | Example |
|---|---|---|---|
Auth Setting string authSetting | Provide a string value for the username of the user. | ||
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Site Role string siteRole | Provide a value for the role of the user. | ||
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
UserId string userId | Provide a value for the unique identifier of the user. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Username string username | Provide a string value for the username of the user. For Tableau Online, this value is an email address. | someone@example.com |
Update Webhook
Modify the properties of an existing webhook. | key: updateWebhook
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string apiVersion | 3.6 | The version of the Tableau API to use | 3.6 |
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
API Event Name string events | The name of the Tableau event that triggers your webhook | ||
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
Webhook Disable Reason string webhookDisableReason | The reason a webhook is disabled. | This webhook is disabled because of a reason. | |
Webhook Enabled boolean webhookEnabled | true | If true (default), the newly created webhook is enabled. If false then the webhook will be disabled. | |
Webhook Id string / Required webhookId | The ID of the webhook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Webhook Name string webhookName | A name for the webhook. | My Webhook | |
Webhook URL string webhookUrl | The destination URL for the webhook. The webhook destination URL must be https and have a valid certificate. | https://example.com/webhook |
Update Workbook
Update the information and metadata of an existing workbook by Id | key: updateWorkbook
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debug | false | This flag will enable debugging and logging of the action's web request. | |
Project Id string / Required projectId | Provide a string value for the Id of your Tableau Project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Show Tabs boolean showTabs | false | Specify true to have the updated workbook show views in tabs. | |
Connection connection / Required tableauConnection | |||
Timeout string timeout | The maximum amount of time the client will await a response. | 3000 | |
UserId string userId | Provide a value for the unique identifier of the user. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Workbook Id string / Required workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Workbook Name string / Required workbookName | Provide a string value for the name of the workbook. | My Workbook |