# mulesoft Tableau Connector - Full Documentation
---
product: Tableau Connector
version: 1.1
is-latest-version: true
---
# Tableau Connector 1.1
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Connector for Tableau (Tableau Connector) enables you to integrate and transform data from
applications to build visualizations. This connector exposes operations provided by the Tableau API.
For information about compatibility and fixed issues, refer to the Tableau Connector Release Notes.
## Before You Begin
To use this connector, you must be familiar with:
- The Tableau Connector’s API
- Anypoint Connectors
- Mule runtime engine (Mule)
- Elements and global elements in a Mule flow
- How to create a Mule app using Anypoint Studio
Before creating an app, you must have:
- Credentials to access the Tableau target resource
- Anypoint Platform
- Anypoint Studio or Anypoint Code Builder
## Common Use Cases for the Connector
Some common use cases for Tableau Connector include:
- Visualizing data from a Zendesk or Salesforce endpoint.
- Cleaning, preparing, and curating data to power flows.
- Analyzing product sales trends based on a region using a Tableau mapping.
- Importing data as a Tableau Data Extract (TDE) file to create interactive dashboards that work in
real time.
## Connection Types
Tableau connections use the following authentication types:
- Hyper Configuration
- Hyper Connection
- Rest Configuration
- Basic Authentication
- PAT Authentication
> [!NOTE] Hyper Configuration requires you to provide a path to the hyperd executable file. It is
> not possible to use Hyper Configuration and its operations in CloudHub because CloudHub does not
> allow executing external code due to security reasons.
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)
- [Tableau Connector Reference](https://docs.mulesoft.com/tableau-specialist-connector/latest/tableau-specialist-connector-reference)
- [Salesforce Help](https://help.salesforce.com)
---
product: Tableau Connector
version: 1.1
is-latest-version: true
---
# Tableau Connector 1.1 Examples
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The following examples show how to perform Hyper and Rest configuration operations with Tableau
Connector:
- Hyper configuration operations include:
- [Create Hyper File - Hyper Configuration](#create-hyper-file)
- [Insert Data to Hyper File from CSV - Hyper Configuration](#insert-data-to-hyper-file-from-csv)
- [Insert Data to Hyper File - Hyper Configuration](#insert-data-to-hyper-file)
- [Query Data from Hyper File - Hyper Configuration](#query-data-from-hyper-file)
- [Update Data from Hyper File - Hyper Configuration](#update-data-from-hyper-file)
- Rest configuration operations include:
- [Append to File Upload - Rest Configuration](#append-to-file-upload)
- [Create Project - Rest Configuration](#create-project)
- [Delete Project - Rest Configuration](#delete-project)
- [Initiate File Upload - Rest Configuration](#initiate-file-upload)
- [Publish Datasource - Rest Configuration](#publish-datasource)
- [Publish Workbook - Rest Configuration](#publish-workbook)
- [Query Projects - Rest Configuration](#query-projects)
- [Update Project - Rest Configuration](#update-project)
## Create Hyper File - Hyper Configuration
This Mule flow creates a hyper file with specified table properties.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Create hyper file**
Creates an empty hyper file based on the column definition provided by the user
- **Transform Message**
Outputs the results of the **Create hyper file** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/create-hyper-file-from-csv](http://localhost:8081/create-hyper-file-from-csv)`.
## Insert Data to Hyper File from CSV - Hyper Configuration
This Mule flow creates a hyper table and populates the table with data from a CSV file. To use this
flow, run the [Create Hyper File](#create-hyper-file) flow to create the hyper table and then use
the `src/main/resources/customers.csv` file to populate the table.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Insert data to hyper file from csv**
Populates a hyper file from an existing CSV document
- **Transform Message**
Outputs the results of the **Insert data to hyper file from csv** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081//create-hyper-file](http://localhost:8081//create-hyper-file)`.
## Insert Data to Hyper File - Hyper Configuration
This Mule flow inserts data into a table that belongs to a hyper file. To use this flow, run the
[Create Hyper File](#create-hyper-file) flow to create the hyper table and then use the SQL provided
to insert the data.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Insert data to hyper file**
Inserts data into a table that belongs to a hyper file
- **Transform Message**
Outputs the results of the **Insert data to hyper file** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/insert-data-to-hyper-file](http://localhost:8081/insert-data-to-hyper-file)`.
## Query Data from Hyper File - Hyper Configuration
This Mule flow queries data from tables belonging to a hyper file. To use this flow, run the
[Create Hyper File](#create-hyper-file) flow to populate the table with data. This flow returns all
of the data in the specified hyper table.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Query data from hyper file**
Queries data from tables belonging to a hyper file
- **Transform Message**
Outputs the results of the **Query data from hyper file** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/query-data-from-hyper-file](http://localhost:8081/query-data-from-hyper-file)`.
## Update Data from Hyper File - Hyper Configuration
This Mule flow updates data from tables into a .hyper file by sending SQL queries. To use this flow,
run the [Create Hyper File](#create-hyper-file) flow and
[Insert Data to Hyper File](#insert-data-to-hyper-file) flow to create the hyper table and insert
the data into the table. The flow updates the data that was previously inserted into the table.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Update data from hyper file**
Updates data from tables into a .hyper file by sending SQL queries
- **Transform Message**
Outputs the results of the **Update data from hyper file** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/update-data-from-hyper-file](http://localhost:8081/update-data-from-hyper-file)`.
## Append to File Upload - Rest Configuration
This Mule flow uploads a block of data and appends it to the data that is already uploaded. To get
an **Upload Session Id**, run the **Initiate file upload** operation.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Read**
Reads a file
- **Transform Message**
Transforms the HTTP input
- **Append to file upload**
Uploads a block of data and appends it to the data that is already uploaded
- **Transform Message**
Outputs the results of the **Append to file upload** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/append-to-file-upload](http://localhost:8081/append-to-file-upload)`.
## Create Project - Rest Configuration
This Mule flow creates a project on the specified site.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Create project**
Creates a project on the site
- **Transform Message**
Outputs the results of the **Create project** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/create-project](http://localhost:8081/create-project)`.
## Delete Project - Rest Configuration
This Mule flow deletes a project from the specified site. When a project is deleted, all of its
assets are also deleted, such as its associated workbooks, data sources, project view options, and
rights. Use this operation with caution.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Delete project**
Deletes a project from the site
- **Transform Message**
Outputs the results of the **Delete project** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/delete-project](http://localhost:8081/delete-project)`.
## Initiate File Upload - Rest Configuration
This Mule flow initiates the upload process for a file.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Initiate file upload**
Initiates the upload process for a file
- **Transform Message**
Outputs the results of the **Initiate file upload** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/initiate-file-upload](http://localhost:8081/initiate-file-upload)`.
## Publish Datasource - Rest Configuration
This Mule flow publishes a data source on the specified site, or appends data to an existing data
source. You can use **customers.hyper** as an example of a datasource to upload.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Read**
Reads a file
- **Transform Message**
Transforms the HTTP input
- **Transform Message**
Transforms the datasource into Java format
- **Publish datasource**
Publishes a data source on the site, or appends data to an existing data source
- **Transform Message**
Outputs the results of the **Publish datasource** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/publish-datasource](http://localhost:8081/publish-datasource)`.
## Publish Workbook - Rest Configuration
This Mule flow publishes a workbook on the specified site.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Read**
Reads a file
- **Transform Message**
Transforms the HTTP input
- **Transform Message**
Transforms the datasource into Java format
- **Publish workbook**
Publishes a workbook on the site
- **Transform Message**
Outputs the results of the **Publish workbook** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/publish-workbook](http://localhost:8081/publish-workbook)`.
## Query Projects - Rest Configuration
This Mule flow returns a list of projects from the specified site. It uses optional parameters to
page large results.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Query projects**
Returns a list of projects from the site
- **Transform Message**
Outputs the results of the **Query projects** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/query-projects](http://localhost:8081/query-projects)`.
## Update Project - Rest Configuration
This Mule flow updates a project on the specified site.
This example uses the following operations:
- **HTTP Listener**
Accepts data from HTTP requests
- **Update project**
Updates a project on the site
- **Transform Message**
Outputs the results of the **Update project** operation in JSON format

### XML for This Example
Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:
```xml
```
### Steps for Running This Example
1. Verify that your connector is configured.
2. Save the project.
3. From a web browser, test the application by entering
`[http://localhost:8081/update-project](http://localhost:8081/update-project)`.
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: Tableau Connector
version: 1.1
is-latest-version: true
---
# Tableau Connector 1.1 Reference
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
## Configurations
---
### Hyper configuration
This configuration provides users access to the HyperAPI Java library developed by Tableau. Users
can create, update, and delete hyper files locally.
> [!NOTE] Hyper Configuration requires you to provide a path to the hyperd executable file. It is
> not possible to use Hyper Configuration and its operations in CloudHub because CloudHub does not
> allow executing external code due to security reasons.
#### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | | x |
Connection | | Connection types for this configuration. | | x |
Name | | ID used to reference this configuration. | | x |
Expiration Policy | | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | | |
#### Connection Types
##### Hyper Connection
###### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Working Directory | | Directory that is considered the root of every relative path used with this connector. If not provided, the value defaults to the value of the user.home system property. If that system property is not set, then the connector fails to initialize. | | |
Hyperd Directory | | Directory that makes the hyperd executable. | | |
Telemetry | | HyperProcess is instructed to send telemetry on the Hyper API usage to Tableau. | | |
Reconnection | | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | | |
#### Supported Operations
- [Create hyper file](#CreateHyperFile)
- [Insert data to hyper file from csv](#InsertDataToHyperFileFromCsv)
- [Insert data to hyper file](#InsertDataToHyperFile)
- [Query Data From Hyper File](#QueryDataFromHyperFile)
- [Update data from hyper file](#UpdateDataFromHyperFile)
> [!NOTE] Currently, you can’t use these Hyper operations of the Tableau Connector in Mule apps
> deployed in a FIPS environment. However, you can use all other Tableau Connector operations
> successfully in a FIPS environment.
---
### Server Rest Configuration
This configuration provides users access to the Rest API exposed by Tableau. All of the operations
executed over the Rest API are bound to this configuration.
#### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | | x |
Connection | | Connection types for this configuration. | | x |
Read Timeout | | Defines the default amount of time to wait for a response when executing an operation. | 30 | |
Time unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| Time unit for the Read Timeout value. | SECONDS | |
Name | | ID used to reference this configuration. | | x |
Expiration Policy | | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | | |
#### Connection Types
##### Tableau Server Basic Username Password Authentication
###### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Server URL | | URL of the Tableau server. | | x |
API version | | API version to use. | | x |
Content URL | | Content URL (subpath) of the site you sign into. | | x |
Connection Timeout | | How long the connector waits before timing out when establishing a connection to the remote service. Values that are less than one millisecond are converted to 0. | -1 | |
Connection Timeout unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| Time unit for the Connection Timeout field. | SECONDS | |
Proxy configuration | | Configures a proxy for outbound connections. | | |
Username | | Username used to initialize the session. | | x |
Password | | Password used to authenticate the user. | | x |
TLS configuration | | Configures TLS. If using the HTTPS protocol, you must configure TLS. | | |
Reconnection | | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | | |
##### Tableau Server Personal Access Tokens Authentication
Personal access tokens enable Tableau Server users to create long-lived authentication tokens. After
obtaining the authentication token, send the token with each subsequent request to the
X-Tableau-Auth header.
###### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Server URL | | URL of the Tableau server. | | x |
API version | | API version to use. | | x |
Content URL | | Content URL (subpath) of the site you sign into. | | x |
Connection Timeout | | How long the connector waits before timing out when establishing a connection to the remote service. Values that are less than one millisecond are converted to 0. | -1 | |
Connection Timeout unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| Time unit for the Connection Timeout field. | SECONDS | |
Proxy configuration | | Configures a proxy for outbound connections. | | |
Personal Access Token Name | | Personal access token name defined in the Tableau server UI. The personal access token name and personal access token secret are mutually exclusive with the Username and Password fields. | | x |
Personal Access Token Secret | | Personal access token secret defined in the Tableau UI. The personal access token name and personal access token secret are mutually exclusive with the Username and Password fields. | | x |
TLS configuration | | Configures TLS. If using the HTTPS protocol, you must configure TLS. | | |
Reconnection | | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | | |
#### Supported Operations
- [Append to file upload](#AppendToFileUpload)
- [Create project](#CreateProject)
- [Create site](#CreateSite)
- [Delete project](#DeleteProject)
- [Delete site](#DeleteSite)
- [Initiate file upload](#InitiateFileUpload)
- [Publish datasource](#PublishDatasource)
- [Publish workbook](#PublishWorkbook)
- [Query projects](#QueryProjects)
- [Query site](#QuerySite)
- [Query sites](#QuerySites)
- [Update project](#UpdateProject)
- [Update site](#UpdateSite)
#### Supported Sources
- [On New Or Modified Data Source](#NewOrModifiedDatasourceListener)
---
### Online Rest Configuration
This configuration provides users access to the Rest API exposed by Tableau. All of the operations
executed over the Rest API are bound to this configuration.
#### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | | x |
Connection | | Connection types for this configuration. | | x |
Read Timeout | | Defines the default amount of time to wait for a response when executing an operation. | 30 | |
Time unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| Time unit for the Read Timeout value. | SECONDS | |
Name | | ID used to reference this configuration. | | x |
Expiration Policy | | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | | |
#### Connection Types
##### Tableau Online Basic Username Password Authentication
###### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Server URL | | URL of the Tableau server. | | x |
API version | | API version to use. | | x |
Content URL | | Content URL (subpath) of the site you sign into. | | x |
Connection Timeout | | How long the connector waits before timing out when establishing a connection to the remote service. Values that are less than one millisecond are converted to 0. | -1 | |
Connection Timeout unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| Time unit for the Connection Timeout field. | SECONDS | |
Proxy configuration | | Configures a proxy for outbound connections. | | |
Username | | Username used to initialize the session. | | x |
Password | | Password used to authenticate the user. | | x |
TLS configuration | | Configures TLS. If using the HTTPS protocol, you must configure TLS. | | |
Reconnection | | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | | |
##### Tableau Online Personal Access Tokens Authentication
Personal access tokens enable Tableau Server users to create long-lived authentication tokens. After
obtaining the authentication token, send the token with each subsequent request to the
X-Tableau-Auth header.
###### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Server URL | | URL of the Tableau server. | | x |
API version | | API version to use. | | x |
Content URL | | Content URL (subpath) of the site you sign into. | | x |
Connection Timeout | | How long the connector waits before timing out when establishing a connection to the remote service. Values that are less than one millisecond are converted to 0. | -1 | |
Connection Timeout unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| Time unit for the Connection Timeout field. | SECONDS | |
Proxy configuration | | Configures a proxy for outbound connections. | | |
Personal Access Token Name | | Personal access token name defined in the Tableau server UI. The personal access token name and personal access token secret are mutually exclusive with the Username and Password fields. | | x |
Personal Access Token Secret | | Personal access token secret defined in the Tableau UI. The personal access token name and personal access token secret are mutually exclusive with the Username and Password fields. | | x |
TLS configuration | | Configures TLS. If using the HTTPS protocol, you must configure TLS. | | |
Reconnection | | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | | |
#### Supported Operations
- [Append to file upload](#AppendToFileUpload)
- [Create project](#CreateProject)
- [Delete project](#DeleteProject)
- [Initiate file upload](#InitiateFileUpload)
- [Publish datasource](#PublishDatasource)
- [Publish workbook](#PublishWorkbook)
- [Query projects](#QueryProjects)
- [Update project](#UpdateProject)
#### Supported Sources
- [On New Or Modified Data Source](#NewOrModifiedDatasourceListener)
## Create hyper file
``
Creates an empty hyper file based on the column definition provided by the user.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Output Hyper file name | | Name of the hyper file to create. | | x |
Schema name | | Name of the schema that creates the table. | | |
Table name | | Name of the table. | | x |
Columns | | List of columns defined in the table. | | x |
Config Ref | | Name of the configuration used to execute this component. | | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### For Configurations
- [Hyper configuration](#TableauHyperConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FILE\_DOESNT\_EXIST
- TABLEAU-SPECIALIST:FILE\_IS\_NOT\_DIRECTORY
- TABLEAU-SPECIALIST:HYPER\_EXCEPTION
- TABLEAU-SPECIALIST:ILLEGAL\_PATH
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:UNKNOWN
## Insert data to hyper file from csv
``
Populates a hyper file from an existing CSV document.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Hyper file name | | Name of the hyper file. | | x |
Schema name | | Name of the schema. | | |
Table name | | Name of the table. | | x |
Columns | | List of columns defined in the table. | | x |
CSV file path | | Path to the CSV file. | | x |
CSV NULL column | | Defines what the CSV file uses to represent null values. | | x |
CSV delimiter | | Defines what the CSV file uses as a delimiter. | | x |
CSV header | | Specifies whether the CSV file contains a header. | false | |
Config Ref | | Name of the configuration used to execute this component. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Hyper configuration](#TableauHyperConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FILE\_DOESNT\_EXIST
- TABLEAU-SPECIALIST:FILE\_IS\_NOT\_DIRECTORY
- TABLEAU-SPECIALIST:HYPER\_EXCEPTION
- TABLEAU-SPECIALIST:ILLEGAL\_PATH
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:UNKNOWN
## Insert data to hyper file
``
Inserts data into a table belonging to a hyper file.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Hyper file name | | Name of the hyper file that contains the inserted data. | | x |
SQL query | | SQL command used to insert the data into the table from the hyper file. | | x |
Config Ref | | Name of the configuration used to execute this component. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Hyper configuration](#TableauHyperConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FILE\_DOESNT\_EXIST
- TABLEAU-SPECIALIST:FILE\_IS\_NOT\_DIRECTORY
- TABLEAU-SPECIALIST:HYPER\_EXCEPTION
- TABLEAU-SPECIALIST:ILLEGAL\_PATH
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:UNKNOWN
## Query Data From Hyper File
``
Queries data from tables belonging to a hyper file.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Config Ref | | Name of the configuration used to execute this component. | | |
Hyper file name | | Name of the hyper file that contains the queried data. | | x |
SQL query | | SQL query that selects data from the hyper file. | | x |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Hyper configuration](#TableauHyperConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FILE\_DOESNT\_EXIST
- TABLEAU-SPECIALIST:FILE\_IS\_NOT\_DIRECTORY
- TABLEAU-SPECIALIST:HYPER\_EXCEPTION
- TABLEAU-SPECIALIST:ILLEGAL\_PATH
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:UNKNOWN
## Update data from hyper file
``
Updates data from tables into a .hyper file by sending SQL queries.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Hyper file path | | Name of the hyper file that is updated. | | x |
SQL query | | SQL command used to update the data in the table from the hyper file. | | x |
Config Ref | | Name of the configuration used to execute this component. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Hyper configuration](#TableauHyperConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FILE\_DOESNT\_EXIST
- TABLEAU-SPECIALIST:FILE\_IS\_NOT\_DIRECTORY
- TABLEAU-SPECIALIST:HYPER\_EXCEPTION
- TABLEAU-SPECIALIST:ILLEGAL\_PATH
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:UNKNOWN
## Append to file upload
``
Uploads a block of data and appends it to the data that is already uploaded.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
File Content | | Content of the file to upload is included in a MIME multipart message. | #[payload] | |
Upload Session Id | | ID of the upload session. You get this value when you start an upload session using the Initiate file upload operation. | | x |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Online Rest Configuration](#TableauSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FILE\_SIZE\_TOO\_LARGE
- TABLEAU-SPECIALIST:FILE\_UPLOAD\_NOT\_FOUND
- TABLEAU-SPECIALIST:FORBIDDEN
- TABLEAU-SPECIALIST:INSUFFICIENT\_SITE\_STORAGE\_REMAINING
- TABLEAU-SPECIALIST:MALFORMED\_REQUEST\_BODY
- TABLEAU-SPECIALIST:MISSING\_FILE\_DATA
- TABLEAU-SPECIALIST:NOT\_A\_PUBLISHER
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNKNOWN
- TABLEAU-SPECIALIST:UPLOAD\_FAILURE
## Create project
``
Creates a project on the site. You can also create project hierarchies by creating a project under
the specified parent project on the site.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Publish value | | Specifies whether to publish the sample workbooks provided by Tableau to the project. | false | |
Content | | InputStream containing specific attributes for this operation. | #[payload] | |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Online Rest Configuration](#TableauSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:BAD\_REQUEST
- TABLEAU-SPECIALIST:BAD\_REQUEST\_PERMISSION
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FORBIDDEN
- TABLEAU-SPECIALIST:INSUFFICIENT\_SITE\_STORAGE\_REMAINING
- TABLEAU-SPECIALIST:INVALID\_REQUEST\_METHOD
- TABLEAU-SPECIALIST:PROJECT\_NAME\_CONFLICT
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:SITE\_NOT\_FOUND
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNKNOWN
## Create site
``
Creates a site on a Tableau server.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Content | | InputStream containing specific attributes for this operation. | #[payload] | |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Server Rest Configuration](#TableauServerSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:BAD\_REQUEST
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:CREATE\_SITE\_INVALID\_ADMINISTRATOR\_MODE
- TABLEAU-SPECIALIST:FORBIDDEN
- TABLEAU-SPECIALIST:INVALID\_REQUEST\_METHOD
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:SITE\_NAME\_CONFLICT
- TABLEAU-SPECIALIST:SITE\_URL\_CONFLICT
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNKNOWN
- TABLEAU-SPECIALIST:USER\_QUOTA\_OR\_ADMIN\_MODE\_CONFLICT
## Delete project
``
Deletes the specified project from the site. When a project is deleted, all of its assets are also
deleted, such as its associated workbooks, data sources, project view options, and rights. Use this
operation with caution.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Project ID | | ID of the project to delete. | | x |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Online Rest Configuration](#TableauSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:DELETION\_FORBIDDEN
- TABLEAU-SPECIALIST:FORBIDDEN
- TABLEAU-SPECIALIST:INSUFFICIENT\_SITE\_STORAGE\_REMAINING
- TABLEAU-SPECIALIST:PROJECT\_NOT\_FOUND
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNKNOWN
## Delete site
``
Deletes the site the user is logged into.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Server Rest Configuration](#TableauServerSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:DELETION\_NOT\_ALLOWED
- TABLEAU-SPECIALIST:INVALID\_REQUEST\_METHOD
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:SITE\_NOT\_FOUND
- TABLEAU-SPECIALIST:SITE\_OPERATIONS\_FORBIDDEN
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNAUTHORIZED\_ACCESS
- TABLEAU-SPECIALIST:UNKNOWN
## Initiate file upload
``
Initiates the upload process for a file.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Online Rest Configuration](#TableauSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:ACCESS\_TO\_FAVORITES\_FORBIDDEN
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FORBIDDEN
- TABLEAU-SPECIALIST:INSUFFICIENT\_SITE\_STORAGE\_REMAINING
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNKNOWN
## Publish datasource
``
Publishes a data source to the site, or appends data to an existing data source. To make other
changes to a published data source, call **Update Data Source** or **Update Data Source
Connection**.
Use this operation in the following ways:
- Publish a data source in a single request. You must include the content of the data source file in
the body of the request. The maximum size of a file that can be published in a single request is
64 MB. To avoid timing out the publishing process, use the **asJob** parameter to make data source
publication asynchronous.
- Publish a data source in multiple requests. You must initiate a file upload by calling **Initiate
File Upload**, sending portions of the file to the server using **Append to File Upload**, and
then committing the upload by calling **Publish Data Source**. In this case, **Publish Data
Source** does not contain the file to publish.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Overwrite flag | | Set to true to overwrite a data source that has the same name. Set to false to ensure failure if the specified data source already exists. | false | |
As job value | | Specifies whether to publish data sources asynchronously. | false | |
Append flag | | Set to true to append the data that is published to an existing data source with the same name. If set to true but the data source doesn’t already exist, the operation will fail. | false | |
Datasource Request Options | | Datasource object. | | x |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Online Rest Configuration](#TableauSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:DATA\_SOURCE\_NOT\_FOUND
- TABLEAU-SPECIALIST:FORBIDDEN
- TABLEAU-SPECIALIST:INCOMPATIBLE\_OVERWRITE\_AND\_APPEND\_VALUES
- TABLEAU-SPECIALIST:INSUFFICIENT\_PRIVILEGES
- TABLEAU-SPECIALIST:INSUFFICIENT\_SITE\_STORAGE\_REMAINING
- TABLEAU-SPECIALIST:INVALID\_ASK\_DATA\_ENABLEMENT
- TABLEAU-SPECIALIST:INVALID\_FILE\_NAME\_FILE\_TYPE
- TABLEAU-SPECIALIST:PUBLISHING\_ERROR
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNKNOWN
## Publish workbook
``
Publishes a workbook onto the site. To make changes to a published workbook, call **Update
Workbook** or **Update Workbook Connection**.
Use this operation in the following ways:
- Publish a workbook in a single request. You must include the content of the workbook file in the
body of the request. The maximum size of a file that can be published in a single request is 64
MB. To avoid timing out the publishing process, use the **asJob** parameter to make workbook
publication asynchronous.
- Publish a workbook in multiple requests. You must initiate a file upload by calling **Initiate
File Upload**, sending portions of the file to the server using **Append to File Upload**, and
then committing the upload by calling **Publish Workbook**. In this case, **Publish Workbook**
does not contain the file to publish.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Overwrite flag | | Set to true to overwrite a data source that has the same name. Set to false to ensure failure if the specified data source already exists. | false | |
As job value | | Specifies whether to publish data sources asynchronously. | false | |
Skip connection | | If set to true, the Tableau server does not check if a non-published connection of a workbook is reachable. Publishing will succeed but unchecked connection issues may result in a non-functioning workbook. | false | |
Workbook Request Options | | Workbook object. | | x |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Online Rest Configuration](#TableauSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:CONCURRENT\_UPDATE
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FAILED\_CONNECTION\_CHECK
- TABLEAU-SPECIALIST:FORBIDDEN
- TABLEAU-SPECIALIST:INSUFFICIENT\_SITE\_STORAGE\_REMAINING
- TABLEAU-SPECIALIST:MISSING\_OR\_INVALID\_FILE\_TYPE
- TABLEAU-SPECIALIST:PUBLISHING\_OVERWRITE
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNKNOWN
- TABLEAU-SPECIALIST:WORKBOOK\_NOT\_FOUND
## Query projects
``
Returns a list of projects on the specified site, with optional parameters for specifying the paging
of large results.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Page Size | | Number of items to return in one response. The minimum is 1 and the maximum is 1000. | 100 | |
Filter Expression | | Expression that specifies a subset of data sources to return. | | |
Sort Expression | | Expression that specifies the order in which to return user information. | | |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Online Rest Configuration](#TableauSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FORBIDDEN
- TABLEAU-SPECIALIST:INSUFFICIENT\_SITE\_STORAGE\_REMAINING
- TABLEAU-SPECIALIST:INVALID\_PAGE\_NUMBER
- TABLEAU-SPECIALIST:INVALID\_PAGE\_SIZE
- TABLEAU-SPECIALIST:PAGE\_SIZE\_LIMIT\_EXCEEDED
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNKNOWN
## Query site
``
Returns information about the site the user is logged into.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Include Usage | | Indicates whether to include usage in the response. | false | |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Server Rest Configuration](#TableauServerSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:BAD\_REQUEST
- TABLEAU-SPECIALIST:BAD\_REQUEST\_PERMISSION
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:INVALID\_ADMINISTRATOR\_MODE
- TABLEAU-SPECIALIST:INVALID\_REQUEST\_METHOD
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:SITE\_NAME\_CONFLICT
- TABLEAU-SPECIALIST:SITE\_NOT\_FOUND
- TABLEAU-SPECIALIST:SITE\_OPERATIONS\_FORBIDDEN
- TABLEAU-SPECIALIST:SITE\_URL\_CONFLICT
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNAUTHORIZED\_ACCESS
- TABLEAU-SPECIALIST:UNKNOWN
- TABLEAU-SPECIALIST:USER\_QUOTA\_OR\_ADMIN\_MODE\_CONFLICT
## Query sites
``
Returns a list of the sites on the server that the caller of this method has access to.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Page Size | | Number of items to return in one response. The minimum is 1 and the maximum is 1000. | 100 | |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Server Rest Configuration](#TableauServerSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:INVALID\_PAGE\_NUMBER
- TABLEAU-SPECIALIST:INVALID\_PAGE\_SIZE
- TABLEAU-SPECIALIST:INVALID\_REQUEST\_METHOD
- TABLEAU-SPECIALIST:PAGE\_SIZE\_LIMIT\_EXCEEDED
- TABLEAU-SPECIALIST:SITE\_OPERATIONS\_FORBIDDEN
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNAUTHORIZED\_ACCESS
- TABLEAU-SPECIALIST:UNKNOWN
## Update project
``
Updates a project on the specified site.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Project ID | | ID of the project to update. | | x |
Publish value | | Specifies whether to publish the sample workbooks provided by Tableau to the project. | false | |
Content | | InputStream containing specific attributes for this operation. | #[payload] | |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
Type | Binary |
Attributes Type | |
### For Configurations
- [Online Rest Configuration](#TableauSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:FORBIDDEN
- TABLEAU-SPECIALIST:INSUFFICIENT\_SITE\_STORAGE\_REMAINING
- TABLEAU-SPECIALIST:PROJECT\_ID\_MISMATCH
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNKNOWN
- TABLEAU-SPECIALIST:UPDATE\_FORBIDDEN
- TABLEAU-SPECIALIST:UPDATE\_FORBIDDEN\_PERMISSION
## Update site
``
Modifies settings for the site the user is logged into.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Content | | InputStream containing specific attributes for this operation. | #[payload] | |
Config Ref | | Name of the configuration used to execute this component. | | x |
Streaming Strategy | | Configures how Mule processes streams. The default is to use repeatable streams. | | |
Target Variable | | Name of the variable that stores the operation’s output. | | |
Target Value | | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. | #[payload] | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
### For Configurations
- [Server Rest Configuration](#TableauServerSpecialistConfig)
### Throws
- TABLEAU-SPECIALIST:BAD\_REQUEST
- TABLEAU-SPECIALIST:BAD\_REQUEST\_PERMISSION
- TABLEAU-SPECIALIST:CONNECTIVITY
- TABLEAU-SPECIALIST:INVALID\_ADMINISTRATOR\_MODE
- TABLEAU-SPECIALIST:INVALID\_REQUEST\_METHOD
- TABLEAU-SPECIALIST:RETRY\_EXHAUSTED
- TABLEAU-SPECIALIST:SITE\_NAME\_CONFLICT
- TABLEAU-SPECIALIST:SITE\_NOT\_FOUND
- TABLEAU-SPECIALIST:SITE\_OPERATIONS\_FORBIDDEN
- TABLEAU-SPECIALIST:SITE\_URL\_CONFLICT
- TABLEAU-SPECIALIST:TIMEOUT
- TABLEAU-SPECIALIST:UNAUTHORIZED\_ACCESS
- TABLEAU-SPECIALIST:UNKNOWN
- TABLEAU-SPECIALIST:USER\_QUOTA\_OR\_ADMIN\_MODE\_CONFLICT
## On New Or Modified Data Source
``
Initiates a flow when a data source is created or updated.
### Parameters
| Name | Type | Description | Default Value | Required |
|---|
Configuration | String | Name of the configuration to use. | | x |
Since | | Date in the yyyy-MM-dd’T’HH:mm:ss’Z' format, for example, 2014-01-01T00:00:00Z. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started. | | |
Config Ref | | Name of the configuration used to execute this component. | | x |
Primary Node Only | | Determines whether to execute this source on only the primary node when running Mule instances in a cluster. | | |
Scheduling Strategy | | Configures the scheduler that triggers the polling. | | x |
Redelivery Policy | | Defines a policy for processing the redelivery of the same message. | | |
Reconnection Strategy | | Retry strategy in case of connectivity errors. | | |
### Output
Type | Object |
Attributes Type | |
### For Configurations
- [Online Rest Configuration](#TableauSpecialistConfig)
## Types
### Reconnection
Configures a reconnection strategy for an operation.
| Field | Type | Description | Default Value | Required |
|---|
Fails Deployment | | What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy: true
Allow the deployment to fail. false
Ignore the results of the connectivity test.
| | |
Reconnection Strategy | | Reconnection strategy to use. | | |
### Reconnect
Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.
| Field | Type | Description | Default Value | Required |
|---|
Frequency | | How often to attempt to reconnect, in milliseconds. | | |
Blocking | | If false, the reconnection strategy will run in a separate, non-blocking thread. | | |
Count | | How many reconnection attempts the Mule app can make. | | |
### Reconnect Forever
Configures a forever reconnection strategy by which the connector source or operation attempts to
reconnect at a specified frequency for as long as the Mule app runs.
| Field | Type | Description | Default Value | Required |
|---|
Frequency | | How often to attempt to reconnect, in milliseconds. | | |
Blocking | | If false, the reconnection strategy will run in a separate, non-blocking thread. | | |
### Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|
Max Idle Time | | Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | | |
Time Unit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS
| Time unit for the Max Idle Time field. | | |
### Column Definition
| Field | Type | Description | Default Value | Required |
|---|
Column Name | | | | |
Column Type | UNSUPPORTED BOOL BIG_INT SMALL_INT INT NUMERIC DOUBLE OID BYTES TEXT VARCHAR CHAR JSON DATE INTERVAL TIME TIMESTAMP TIMESTAMP_TZ GEOGRAPHY
| | | |
Column Nullability | | | | |
Column Collation | | | | |
Numeric Scale | | Numeric scale of the column. | | |
Numeric Precision | | Numeric precision of the column. | | |
Length | | | | |
### Proxy Configuration
Configures the settings used to connect through a proxy.
| Field | Type | Description | Default Value | Required |
|---|
Host | | Hostname or IP address of the proxy server. | | |
Port | | Port of the proxy server. | | |
Username | | Username to authenticate against the proxy server. | | |
Password | | Password to authenticate against the proxy server. | | |
### TLS
Configures TLS to provide secure communications for the Mule app.
| Field | Type | Description | Default Value | Required |
|---|
Enabled Protocols | | Comma-separated list of protocols enabled for this context. | | |
Enabled Cipher Suites | | Comma-separated list of cipher suites enabled for this context. | | |
Trust Store | | Configures the TLS truststore. | | |
Key Store | | Configures the TLS keystore. | | |
Revocation Check | | Configures a revocation checking mechanism. | | |
### Truststore
Configures the truststore for TLS.
| Field | Type | Description | Default Value | Required |
|---|
Path | | Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible. | | |
Password | | Password used to protect the truststore. | | |
Type | | | | |
Algorithm | | Encryption algorithm that the truststore uses. | | |
Insecure | | If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks. | | |
### Keystore
Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a
public certificate.
| Field | Type | Description | Default Value | Required |
|---|
Path | | Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible. | | |
Type | | | | |
Alias | | Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. | | |
Key Password | | Password used to protect the private key. | | |
Password | | Password used to protect the keystore. | | |
Algorithm | | Encryption algorithm that the keystore uses. | | |
### Standard Revocation Check
Configures standard revocation checks for TLS certificates.
| Field | Type | Description | Default Value | Required |
|---|
Only End Entities | | Which elements to verify in the certificate chain: true
Verify only the last element in the certificate chain. false
Verify all elements in the certificate chain.
| | |
Prefer Crls | | How to check certificate validity: true
Check the Certification Revocation List (CRL) for certificate validity. false
Use the Online Certificate Status Protocol (OCSP) to check certificate validity.
| | |
No Fallback | | Whether to use the secondary method to check certificate validity: true
Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity. false
Do not use the secondary method to check certificate validity.
| | |
Soft Fail | | What to do if the revocation server can’t be reached or is busy: true
Avoid verification failure. false
Allow the verification to fail.
| | |
### Custom OCSP Responder
Configures a custom OCSP responder for certification revocation checks.
| Field | Type | Description | Default Value | Required |
|---|
Url | | URL of the OCSP responder. | | |
Cert Alias | | Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. | | |
### CRL File
Specifies the location of the certification revocation list (CRL) file.
| Field | Type | Description | Default Value | Required |
|---|
Path | | | | |
### Redelivery Policy
Configures the redelivery policy for executing requests that generate errors. You can add a
redelivery policy to any source in a flow.
| Field | Type | Description | Default Value | Required |
|---|
Max Redelivery Count | | Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error. | | |
Message Digest Algorithm | | Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned. | | |
Message Identifier | | Defines which strategy is used to identify the messages. | | |
Object Store | | Configures the object store that stores the redelivery counter for each message. | | |
### Redelivery Policy Message Identifier
Configures how to identify a redelivered message and how to find out when the message was
redelivered.
| Field | Type | Description | Default Value | Required |
|---|
Use Secure Hash | | If true, Mule uses a secure hash algorithm to identify a redelivered message. | | |
Id Expression | | One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false. | | |
### Repeatable In Memory Stream
Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX
buffer size. Always run performance tests to find the optimal buffer size for your specific use
case.
| Field | Type | Description | Default Value | Required |
|---|
Initial Buffer Size | | Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. | | |
Buffer Size Increment | | Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand. | | |
Max Buffer Size | | Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit. | | |
Buffer Unit | | Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. | | |
### Repeatable File Store Stream
Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream
content in memory. If the stream content is larger than the configured buffer size, Mule backs up
the buffer’s content to disk and then clears the memory.
| Field | Type | Description | Default Value | Required |
|---|
In Memory Size | | Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance: Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory. Configure a smaller buffer size to decrease memory load at the expense of response time.
| | |
Buffer Unit | | Unit for the In Memory Size field. | | |
### Filter Expression
| Field | Type | Description | Default Value | Required |
|---|
Field Name | | | | |
Operator | | | | |
Value | | | | |
### Sort Expression
| Field | Type | Description | Default Value | Required |
|---|
Field Name | | | | |
Direction | | | | |
### Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|
Initial Buffer Size | | Number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment field, with an upper limit of Max In Memory Size. | | |
Buffer Size Increment | | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. | | |
Max Buffer Size | | Maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | | |
### Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|
In Memory Objects | | Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. | | |
Buffer Unit | | Unit for the In Memory Objects field. | | |
### Publish Workbook Request Body
| Field | Type | Description | Default Value | Required |
|---|
Workbook File Content | | File content of the workbook. | | |
Workbook Attributes | | Attributes of the workbook. | | |
Workbook File Name | | File name of the workbook. | | |
### Publish Workbook Request Session Id
| Field | Type | Description | Default Value | Required |
|---|
Upload Session Id | | Upload session ID for Publish workbook. | | |
Workbook Attributes | | Attributes of the workbook. | | |
Workbook File Type | | File type of the workbook. | | |
### Publish Datasource Request Body
| Field | Type | Description | Default Value | Required |
|---|
Datasource File Content | | File content of the datasource. | | |
Datasource Attributes | | Attributes of the datasource. | | |
Datasource File Name | | File name of the datasource. | | |
### Publish Datasource Request Session Id
| Field | Type | Description | Default Value | Required |
|---|
Upload Session Id | | Upload session ID for Publish datasource. | | |
Datasource Attributes | | Attributes of the datasource. | | |
Datasource File Type | | File type of the datasource. | | |
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: Tableau Connector
version: 1.1
is-latest-version: true
---
# Tableau Connector 1.1 XML and Maven Support
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:
- If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can access the connector from your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.
- If you add the connector in Studio, Studio automatically populates the XML code with the
connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file.
## Add a Namespace for the Connector
Paste the following code inside the `` tag of the header of your configuration XML:
```xml
http://www.mulesoft.org/schema/mule/tableau-specialist
http://www.mulesoft.org/schema/mule/tableau-specialist/current/mule-tableau-specialist.xsd
```
This example shows how the namespace statements are placed in the XML block:
```xml
```
## Add a POM File Dependency
The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access
to this connector:
```xml
com.mulesoft.connectors
mule4-tableau-specialist-connector
x.x.x
mule-plugin
```
Replace `x.x.x` with the version that corresponds to the connector you are using.
To obtain the most up-to-date `pom.xml` file information:
1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).
2. In Exchange, click **Login** and supply your Anypoint Platform username and password.
3. In Exchange, search for `tableau specialist`.
4. Select the connector.
5. Click **Dependency Snippets** near the upper right of the screen.
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Salesforce Help](https://help.salesforce.com)
---
product: Tableau Connector
version: 1.1
is-latest-version: true
---
# Using Anypoint Studio to Configure Tableau Connector 1.1
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.
To add and configure a connector in Studio:
1. [Create a Mule project](#create-mule-project).
2. [Add the connector to your Mule project](#add-connector-to-project).
3. [Configure a source for the connector’s flow](#configure-input-source).
4. [Add a connector operation to the flow](#add-connector-operation).
5. [Configure a global element for the connector](#configure-global-element).
6. [Configure the other connector fields](#configure-other-fields).
When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).
If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, refer to
the [Tableau Connector Reference](https://docs.mulesoft.com/tableau-specialist-connector/latest/tableau-specialist-connector-reference).
## Create a Mule Project
In Studio, create a new Mule project in which to add and configure the connector:
1. In Studio, select **File > New > Mule Project**.
2. Enter a name for your Mule project and click **Finish**.
## Add the Connector to Your Mule Project
Add Anypoint Connector for Tableau (Tableau Connector) to your Mule project to automatically
populate the XML code with the connector’s namespace and schema location and add the required
dependencies to the project’s `pom.xml` file:
1. In the **Mule Palette** view, click **(X) Search in Exchange**.
2. In the **Add Dependencies to Project** window, type `tableau specialist` in the search field.
3. Click **Tableau Specialist Connector** in **Available modules**.
4. Click **Add**.
5. Click **Finish**.
Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.
## Configure a Source
A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Tableau Connector:
- HTTP Listener
Initiates a flow each time it receives a request on the configured host and port
- Scheduler
Initiates a flow when a time-based condition is met
For example, to configure an HTTP Listener source, follow these steps:
1. In the **Mule Palette** view, select **HTTP > Listener**.
2. Drag **Listener** to the Studio canvas.
3. On the **Listener** configuration screen, optionally change the value of the **Display Name**
field.
4. Specify a value for the **Path** field.
5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
element that can be used by all instances of the HTTP Listener source in the app.
6. On the **General** tab, specify the connection information for the connector.
7. On the **TLS** tab, optionally specify the TLS information for the connector.
8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection
strategy.
9. Click **Test Connection** to confirm that Mule can connect with the specified server.
10. Click **OK**.
## Add a Connector Operation to the Flow
When you add a connector operation to your flow, you are specifying an action for that connector to
perform.
To add an operation for Tableau Connector, follow these steps:
1. In the **Mule Palette** view, select **Tableau Specialist** and then select the desired
operation.
2. Drag the operation onto the Studio canvas to the right of the source.
## Configure a Global Element for the Connector
When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication credentials
that the connector requires to access the target Tableau system. Tableau Connector supports Hyper
connection for the Hyper configuration, and Basic authentication and PAT authentication for the Rest
configuration.
To configure the global element for Tableau Connector, follow these steps:
1. Select the operation in the Studio canvas.
2. In the configuration screen for the operation, click the plus sign (**+**) next to the
**Connector configuration** field to access the global element configuration fields.
3. On the **General** tab, in **Connection**, select the authentication method to configure:
- Hyper Configuration
- [Hyper Connection](#hyper-connection)
- Rest Configuration
- [Basic Authentication](#basic-authentication)
- [PAT Authentication](#pat-authentication)
You can reference a configuration file that contains ANT-style property placeholders
(recommended), or you can enter your authorization credentials in the global configuration
properties. For information about the benefits of using property placeholders and how to
configure them, refer to
[Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).
4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection
strategy.
5. Click **Test Connection** to confirm that Mule can connect with the specified server.
6. Click **OK**.
### Hyper Connection
Enter the following information on the **General** tab of the **Global Element Properties** screen
to configure Hyper Connection:
| Field | User Action |
|---|
Name | Enter the configuration name. |
Working Directory | Directory that is considered the root of every relative path used with this connector. If not provided, the value defaults to the value of the user.home system property. If that system property is not set, then the connector fails to initialize. |
Hyperd Directory | Directory that makes the hyperd executable. |
Telemetry | |
### Basic Authentication
Enter the following information on the **General** tab of the **Global Element Properties** screen
to configure Basic Authentication:
| Field | User Action |
|---|
Name | Enter the configuration name. |
Server URL | URL of the Tableau server. |
API version | |
Content URL | Content URL (subpath) of the site you sign into. |
Username | Username used to initialize the session. |
Password | Password used to authenticate the user. |
### PAT Authentication
Enter the following information on the **General** tab of the **Global Element Properties** screen
to configure PAT Authentication:
| Field | User Action |
|---|
Name | Enter the configuration name. |
Server URL | URL of the Tableau server. |
API version | |
Content URL | Content URL (subpath) of the site you sign into. |
Personal Access Token Name | Personal access token name defined in the Tableau server UI. The personal access token name and personal access token secret are mutually exclusive with the Username and Password fields. |
Personal Access Token Secret | Personal access token secret defined in the Tableau UI. The personal access token name and personal access token secret are mutually exclusive with the Username and Password fields. |
## Configure Additional Connector Fields
After you configure a global element for Tableau Connector, configure the other required fields for
the connector. The required fields vary depending on which connector operation you use.
## View the App Log
To check for problems, you can view the app log as follows:
- If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint
Studio console window.
- If you’re running the app using Mule from the command line, the app log output is visible in your
OS console.
Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/.log`.
## See Also
- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)
- [Tableau Connector Reference](https://docs.mulesoft.com/tableau-specialist-connector/latest/tableau-specialist-connector-reference)
- [Salesforce Help](https://help.salesforce.com)