Tableau Component

Manage projects and workbooks in your Tableau site
Component key: tableau#
DescriptionTableau 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.
#
Tableau Connections#
Tableau Token ConnectionThis 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.com
portion as your Host Name, andMarketingTeam
as 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 |
---|---|---|
Input Host Name string / Required hostName | Notes Provide a string value for the host name of the Tableau server, without the https:// | Example 10ay.online.tableau.com |
Input Site ID string / Required siteId | Notes The ID of your Tableau site (MarketingTeam part of https://10ay.online.tableau.com/#/site/MarketingTeam/workbooks) | Example MarketingTeam |
Input Token Secret string / Required token | Notes Provide a string value for the Tableau Token. This value can be created from your Tableau account. | Example xxxxxxxxxxxxxxxxxxxxxx==:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Input Token Name string / Required tokenName | Notes Provide a string value for the name of the Tableau Token. | Example My Token |
#
Actions#
Create ProjectCreate a new project inside your Tableau site | key: createProject
Input | Default | Notes | Example |
---|---|---|---|
Input Content Permissions string contentPermissions | Default | Notes 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. | Example |
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Description string description | Default | Notes Provide a string value for the description of the project. | Example This is an example description |
Input Parent Project Id string parentProjectId | Default | Notes Provide a string value for the id of the parent project. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Input Project Name string / Required projectName | Default | Notes Provide a string value for the name of the project. | Example MyProject |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
Create UserCreate a new user in your tableau site | key: createUser
Input | Default | Notes | Example |
---|---|---|---|
Input Auth Setting string authSetting | Default | Notes Provide a string value for the username of the user. | Example |
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Site Role string siteRole | Default | Notes Provide a value for the role of the user. | Example |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input Username string username | Default | Notes Provide a string value for the username of the user. For Tableau Online, this value is an email address. | Example someone@example.com |
#
Delete ProjectsDelete an existing project by Id | key: deleteProjects
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Project Id string / Required projectId | Default | Notes Provide a string value for the Id of your Tableau Project. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
Delete UserDelete an existing user by Id | key: deleteUser
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input UserId string userId | Default | Notes Provide a value for the unique identifier of the user. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
#
Delete WorkbooksDelete an existing workbook by Id | key: deleteWorkbook
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input Workbook Id string / Required workbookId | Default | Notes Provide a string value for the unique identifier of the workbook. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
#
Get ProjectGet an existing project | key: getProject
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Project Name string / Required projectName | Default | Notes Provide a string value for the name of the project. | Example MyProject |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
Get UserGet an existing user by Id | key: getUser
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input UserId string userId | Default | Notes Provide a value for the unique identifier of the user. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
#
Get WorkbooksGet an existing workbook by Id | key: getWorkbook
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input Workbook Id string / Required workbookId | Default | Notes Provide a string value for the unique identifier of the workbook. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
#
List ConnectionsRetrieve a list of connections connected to your Tableau site | key: listConnections
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Page Number string pageNumber | Default | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Page Size string pageSize | Default | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 20 |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input Workbook Id string / Required workbookId | Default | Notes Provide a string value for the unique identifier of the workbook. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
#
List ProjectsRetrieve a list of projects connected to your Tableau site | key: listProjects
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Page Number string pageNumber | Default | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Page Size string pageSize | Default | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 20 |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
List usersRetrieve a list of users connected to your Tableau site | key: listUsers
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Page Number string pageNumber | Default | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Page Size string pageSize | Default | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 20 |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
List WorkbooksRetrieve a list of workbooks connected to your Tableau site | key: listWorkbooks
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Page Number string pageNumber | Default | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Page Size string pageSize | Default | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 20 |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
Raw RequestSend Raw Request to Tableau | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required connection | Default | Notes | Example |
Input Data string data | Default | Notes The HTTP body payload to send to the URL. | Example {"exampleKey": "Example Data"} |
Input Debug Request boolean debugRequest | Default false | Notes Enabling this flag will log out the current request. | Example |
Input File Data string Key Value List fileData | Default | Notes File Data to be sent as a multipart form upload. | Example [{key: "example.txt", value: "My File Contents"}] |
Input File Data File Names string Key Value List fileDataFileNames | Default | Notes File names to apply to the file data inputs. Keys must match the file data keys above. | Example |
Input Form Data string Key Value List formData | Default | Notes The Form Data to be sent as a multipart form upload. | Example [{"key": "Example Key", "value": new Buffer("Hello World")}] |
Input Header string Key Value List headers | Default | Notes A list of headers to send with the request. | Example User-Agent: curl/7.64.1 |
Input Max Retry Count string maxRetries | Default 0 | Notes The maximum number of retries to attempt. | Example |
Input Method string / Required method | Default | Notes The HTTP method to use. | Example |
Input Query Parameter string Key Value List queryParams | Default | Notes 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. | Example |
Input Response Type string / Required responseType | Default json | Notes The type of data you expect in the response. You can request json, text, or binary data. | Example |
Input Retry On All Errors boolean retryAllErrors | Default false | Notes If true, retries on all erroneous responses regardless of type. | Example |
Input Retry Delay (ms) string retryDelayMS | Default 0 | Notes The delay in milliseconds between retries. | Example |
Input Timeout string timeout | Default | Notes The maximum time that a client will await a response to its request | Example 2000 |
Input URL string / Required url | Default | Notes This is the URL to call. | Example /3.3/sites/adc5fce1-d129-4da9-872c-b16ed0d394fa/projects |
Input Use Exponential Backoff boolean useExponentialBackoff | Default false | Notes Specifies whether to use a pre-defined exponential backoff strategy for retries. | Example |
#
Search ConnectionsSearch for a specific Connection in a Workbook | key: searchConnections
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Page Number string pageNumber | Default | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Page Size string pageSize | Default | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 20 |
Input Search Field string / Required searchField | Default | Notes | Example |
Input Search string / Required searchString | Default | Notes Provide a string value to search on. | Example My Project |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input Workbook Id string / Required workbookId | Default | Notes Provide a string value for the unique identifier of the workbook. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
#
Search ProjectsSearch for a specific project by a string of text | key: searchProjects
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Page Number string pageNumber | Default | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Page Size string pageSize | Default | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 20 |
Input Search Field string / Required searchField | Default | Notes The field to search. Dates should follow the ISO format: 2016-05-04T21:24:49Z | Example Name |
Input Search string / Required searchString | Default | Notes Provide a string value to search on. | Example My Project |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
Search UsersSearch for a specific User by a string of text | key: searchUsers
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Page Number string pageNumber | Default | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Page Size string pageSize | Default | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 20 |
Input Search Field string / Required searchField | Default | Notes The field to search. Dates should follow the ISO format: 2016-05-04T21:24:49Z | Example Name |
Input Search string / Required searchString | Default | Notes Provide a string value to search on. | Example john.doe@test.com |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
Search WorkbooksSearch for a specific Workbook by a string of text | key: searchWorkbooks
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Filter Operator string / Required filterOperator | Default | Notes The operator to use in searching | Example eq |
Input Page Number string pageNumber | Default | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Page Size string pageSize | Default | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 20 |
Input Search Field string / Required searchField | Default | Notes The field to search | Example Tags |
Input Search string / Required searchString | Default | Notes Provide a string value to search on. | Example Tag 1, Tag 2, My 3rd Tag |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
Update ConnectionUpdate the information and metadata of an existing connection by Id | key: updateConnection
Input | Default | Notes | Example |
---|---|---|---|
Input Connection Id string connectionId | Default | Notes Provide a value for the unique identifier of the connection. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Input Connection Password string connectionPassword | Default | Notes Provide a value for the password used to authenticate the connection. | Example mySafePassword |
Input Connection Username string connectionUsername | Default | Notes Provide a string value for the username used to authenticate the connection. | Example myExampleUsername |
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Embed Password boolean embedPassword | Default false | Notes Enable this flag to embed the password for the connection. | Example |
Input Query Tagging Enabled boolean queryTaggingEnabled | Default false | Notes Associates a specific server log query event with the Tableau resource that made the query. | Example |
Input Server Address string serverAddress | Default | Notes Provide a string value for the address of the server you want to connect. | Example 192.168.0.1 |
Input Server Port string serverPort | Default | Notes Provide a string value for the port of the server you want to connect. | Example 8080 |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input Workbook Id string / Required workbookId | Default | Notes Provide a string value for the unique identifier of the workbook. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
#
Update ProjectUpdate the contents and metadata of an existing project by Id | key: updateProject
Input | Default | Notes | Example |
---|---|---|---|
Input Content Permissions string contentPermissions | Default | Notes 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. | Example |
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Description string description | Default | Notes Provide a string value for the description of the project. | Example This is an example description |
Input Parent Project Id string parentProjectId | Default | Notes Provide a string value for the id of the parent project. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Input Project Id string / Required projectId | Default | Notes Provide a string value for the Id of your Tableau Project. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Input Project Name string projectName | Default | Notes Provide a string value for the name of the project. | Example MyProject |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
#
Update UserUpdate the information and metadata of an existing user | key: updateUser
Input | Default | Notes | Example |
---|---|---|---|
Input Auth Setting string authSetting | Default | Notes Provide a string value for the username of the user. | Example |
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Site Role string siteRole | Default | Notes Provide a value for the role of the user. | Example |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input UserId string userId | Default | Notes Provide a value for the unique identifier of the user. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Input Username string username | Default | Notes Provide a string value for the username of the user. For Tableau Online, this value is an email address. | Example someone@example.com |
#
Update WorkbookUpdate the information and metadata of an existing workbook by Id | key: updateWorkbook
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean debug | Default false | Notes This flag will enable debugging and logging of the action's web request. | Example |
Input Project Id string / Required projectId | Default | Notes Provide a string value for the Id of your Tableau Project. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Input Show Tabs boolean showTabs | Default false | Notes Specify true to have the updated workbook show views in tabs. | Example |
Input Connection connection / Required tableauConnection | Default | Notes | Example |
Input timeout string timeout | Default | Notes The maximum amount of time the client will await a response. | Example 3000 |
Input UserId string userId | Default | Notes Provide a value for the unique identifier of the user. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Input Workbook Id string / Required workbookId | Default | Notes Provide a string value for the unique identifier of the workbook. | Example f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Input Workbook Name string / Required workbookName | Default | Notes Provide a string value for the name of the workbook. | Example My Workbook |