About the Tableau category

anon99371720 · September 21, 2022, 11:08am

Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Reference-Tableau Server REST API - Tableau

Connector package documentation

1. Setting up the HTTP Client Tableau

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select the Tableau Client as the prototype of the HTTP Client.
Fill in the Base URL, Content URL, Username, and Password.
Save the HTTP Client for use.

2. Subscribing to Entities from Tableau

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select the Tableau Subscriber as the subscriber.
Select the entity you want to subscribe to from Tableau.
Add any request parameters needed to subscribe to the entity. Please refer to an example in the General Concept section.
You can optionally add a transformer to transform the request parameters into something you will request from Tableau.
Select the Tableau HTTP Client to use.
You can also optionally enable pagination to allow Alumio to fetch paginated entities.

2.2 General Concept

We follow Tableau documentation for building this connector, so you can easily use the connector based on Tableau API Reference.

Entity

It’s the entity you want to subscribe to from Tableau. Please refer to the entities from the Tableau API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Tableau API Reference.

Please look at the example below on how to fill the Request Parameters field when subscribing Query Flows for a Site entity. We can see in the documentation there are some parameter values in path URL such as api-version and site-id, our system provides support for tableau api version 3.6 and the site-id is provided by the HTTP Client.

We can set values like the request parameter below:

“Path” is the path parameter of the URL. For example the {id}.
“Query” is a defined set of parameters attached to the end of a URL.
Example: www.url.com?type=true&start=0

Input Transformer

Any transformer’s set here will be executed after the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.

HTTP Client

This is the HTTP Client configuration you will use to access Tableau.

3. Publishing Entity to Tableau

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration, and select Tableau Publisher as the publisher.
Select the method that you want the publisher to perform with the data.
Select the Tableau entity you want the data to be published to.
You can optionally add any path data to the request on the key path.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently we support POST, PUT, and DELETE methods for submitting data to Tableau.

Entity

We support publishing to most Tableau endpoints. Please refer to Tableau API Reference page. Based on the documentation, some endpoints may need one or more path parameters.

For example, we want to Send Create Group.

You can put the payload you want to send to Tableau into a payload key in the data. Find below an example of the required data.

Note: for now we only support JSON payload for this connector and a reference on how to convert XML to JSON can be found at Fundamentals-Tableau Server REST API - Tableau

And, here is example data for the publisher :

“Path” is the path parameter of the URL. For example the {id}.
“Query” is defined set of parameters attached to the end of a URL.
Example: www.url.com?type=true&start=0
“Payload” is the data contained within a request.