How to publish and share REST Data dashboards with Tableau Server

Integrate connectivity to REST data into your enterprise reporting capabilities. The CData ODBC Driver for REST enables you to access live REST data in business intelligence tools like Tableau Server. Connectivity to REST APIs enables you to monitor changes to your data in real time. Other members of your organization can access your dashboards from a Web browser and get updates from their mobile phone.

This article explains how to configure a DSN on the client and server machines, publish a data source for REST to Tableau Server, and publish an entire Workbook to Tableau Server (including the data source). If you publish a data source, you will be able to create new, refreshable workbooks in Tableau Server.

Connect to REST as an ODBC Data Source

To create a data source or workbook in Tableau Desktop and publish the data source or workbook to Tableau server, you will need to configure a DSN on each machine (Desktop and Server), specifying connection properties and creating DSNs using the same name on each machine. Information for connecting to REST follows, along with different instructions for configuring a DSN in Windows and Linux environments.

See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

After setting the and providing any authentication values, set to "XML" or "JSON" and set to more closely match the data representation to the structure of your data.

The property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

• Document (default): Model a top-level, document view of your REST data. The data provider returns nested elements as aggregates of data.
• FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
• Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling REST Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Windows

If you are installing the CData ODBC Driver for REST on Windows, DSN configuration is the last step of the driver installation. If you already have the driver installed, or you wish to configure new DSNs, you can use the Microsoft ODBC Data Source Administrator.

Linux

If you are installing the CData ODBC Driver for REST in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData REST Source]
Driver = CData ODBC Driver for REST
Description = My Description
DataModel = Relational
URI = C:/people.xml
Format = XML

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Publish the REST Data Source to Tableau Server

With the connections to REST data configured, you are ready to publish a REST data source on Tableau, ready to be leveraged by users in your organization to create workbooks based on REST data.

Create and Publish a Data Source

1. In the Connect pane, click More -> Other Databases (ODBC). Select CData REST Sys, the system DSN.

   The driver installation automatically creates matching user and system DSNs: The system DSN is needed to connect from Tableau Server.

   👁 The connection to the DSN. (Salesforce is shown.)
   
2. In the Database menu, select CData.
3. In the Table box, enter a table name or click New Custom SQL to enter an SQL query.
4. Drag the table onto the join area. 👁 A connection to a single table. (Salesforce is shown.)
   
5. From the Server menu, click Publish Data Source -> (YOUR DATA SOURCE). 👁 Image
   
6. Enter the URL to the server. For most instances, you will authenticate with the Tableau Server username and password. Other authentication scenarios can be found below:
   • If Tableau is configured to use Kerberos and your computer has valid Active Directory credentials, Tableau connects to the server.
   • If Tableau is configured to use SAML, a login prompt for your external identity provider is displayed.
   • If Tableau is configured to use Active Directory, enter your Windows username and password.
7. In the resulting dialog, set the Project, Data Source, and other properties. If you want to schedule refreshes, select Embedded Password in the Authentication menu. Click Publish.

You and other users in your organization can now create and share workbooks based on the published data source.

👁 Connectivity to your data source from the Web authoring environment in Tableau Server. (Salesforce is shown.)

Refresh Workbooks

With a system DSN configured on the client (Tableau Desktop) machine and server (Tableau Server) machine, you can refresh workbooks connected to the REST data source. From the Web interface for Tableau Sever, click Data -> (YOUR DATA SOURCE) -> Refresh.

👁 Refresh the data extract on demand from Tableau Desktop. (Salesforce is shown.)

Publish a Completed Workbook with REST Data to Tableau Server

If you have a specific Workbook that you wish to share with your organization, you can create the Workbook on Tableau Desktop and publish the Workbook directly to Tableau Server.

1. To connect to REST and select data, follow steps 1-5 above. 👁 A connection to a single table. (Salesforce is shown.)
   
2. Click Server -> Sign in and configure the connection to the server. For most instances, you will authenticate with the Tableau Server username and password. Other authentication scenarios can be found below:
   • If Tableau is configured to use Kerberos and your computer has valid Active Directory credentials, Tableau connects to the server.
   • If Tableau is configured to use SAML, a login prompt for your external identity provider is displayed.
   • If Tableau is configured to use Active Directory, enter your Windows username and password.
3. With the data selected, select dimensions and measures to visualize and select a type of chart or graph to build your visualization(s). 👁 Image
   
4. Once the Workbook is complete, click Server -> Publish Workbook to publish the Workbook to Tableau Server. 👁 Image
   
5. In the resulting dialog, set the Project, Name, Description and other properties. If you want to schedule refreshes, click Edit under Data Sources and change the Authentication option to Embedded Password. Click Publish. 👁 Image
   

You and other users in your organization can now review the published workbook from Tableau Server.

👁 Connectivity to your published Workbook from the Web authoring environment in Tableau Server. (Salesforce is shown.)