Tableau Connection Troubleshooting

When setting up Curator's connection to Tableau, or dealing with unexpected networking or feature related issues, it's beneficial to understand how to get details on the issues you're facing to help narrow down root-causes. Whether you're managing a Curator site need to understand how to enable Debug Mode to view the data returned from Tableau, or you're a developer or system administrator working with Tableau Server and need to understand how to use Postman to make API calls to ensure your Curator and Tableau Server can communicate with one another, you'll find all you need below.

Tableau API Debugging

Sometimes there are issues that are hard to diagnose without seeing exactly which API calls Curator is making to Tableau and what responses Curator is getting back from Tableau. To log all of those API calls, Curator provides a Debug Mode for Tableau Server.

Side Effects

A word of warning though, when this debug mode is enabled, the amount of logging that takes place is drastically increased and may fill up your server if left on for long periods. Be sure to turn it back off once you've logged enough to diagnose the issue.

How to Enable Debug Mode

To turn on Curator's Debug Mode for Tableau Server:

1. Navigate to Backend > Settings > Tableau > Tableau Server Settings > Advanced tab.
2. Toggle on the switch labeled Debug Mode for Tableau Server.
3. Save the settings by using the button in the upper right.

Using Debug Mode to Troubleshoot

Once Curator's Debug Mode for Tableau Server is enabled, you'll want to recreate the scenario that led to the troublesome behavior and then view the debug logs by navigating to Backend > Settings > Logs > Event log.

If you don't see the applicable API calls in the logs, you may need to clear Curator's cache by using the Clear Cache button in the upper right portion of the Backend, and then repeat the steps to recreate the troublesome scenario.

Using Postman to Test Connection

Sometimes, it's difficult to establish a connection to Tableau and the reason why isn't clear. One method to help rule out bugs in Curator is to use the Postman application to directly make the API call. This document will guide you through using Postman to authenticate to Tableau's REST API like Curator does behind the scenes.

Install Postman

The first step is to download and install Postman. You can get it from: https://www.postman.com/downloads/

Make API Call

Follow these steps to configure a new API call against Tableau's REST API.

1. Open Postman and start a new tab.

2. Enter your Tableau Server/Cloud URL into the URL bar. Append /api/3.4/auth/signin. Update the API version if needed based on this page.

3. Change the request type from GET to POST.

4. Click on the Body tab.

5. Select raw.

6. In the text box, copy and paste the following XML based on which type of credentials you'll be using:

   Username and Password:

   <?xml version="1.0" encoding="utf-8"?><tsRequest><credentials name="" password=""><site contentUrl=""/></credentials></tsRequest>
   

   Personal Access Token:

   <?xml version="1.0" encoding="utf-8"?><tsRequest><credentials personalAccessTokenName="" personalAccessTokenSecret=""><site contentUrl=""/></credentials></tsRequest>
   

7. Fill in the username, password, and site content URL details within the above XML. If using Personal Access Tokens (PAT), the username will be the PAT name and the password will be the PAT token.

8. Click the Send button.

You should get back XML with an authentication token and the site and user IDs.