Tableau does not provide an out-of-the-box feature to directly connect to and use web-based data sources like TIQK.

To import and analyse / visualise TIQK data using Tableau Desktop, you need to create a Tableau Web Data Connector (WDC).

In this article, we'll show you how to run our sample TIQK WDC for Tableau. Use this as a starting point to build a your own TIQK WDC that integrates live data from your TIQK account directly into the Tableau desktop app.

This article is suitable for more advanced Tableau users, who have experience programming with Node.js / Javascript, git, and working with the command line.

About Tableau Web Data Connectors

A WDC is an HTML file that includes JavaScript code to connect to any web data source (in this case, the TIQK Developer API) and use it in Tableau.

The WDC you create is hosted on a web server running locally on your computer, on a third-party web server, or on Tableau Server.

Getting started

Visit the Tableau Web Data Connector: developer site and follow the instructions in the Get Started section to install and configure the WDC SDK, Simulator, and Examples on your local computer.

Once you've confirmed that the Example connector runs correctly in the Simulator, you're ready to test the sample TIQK WDC.

We have successfully tested the Simulator, Example WDC, and TIQK WDC sample on macOS High Sierra, and Windows 10 (running Ubuntu on the Windows Subsystem for Linux).

CORS and the TIQK Developer API

The Tableau simulator also includes a test proxy server on port 8889 that you can route requests through in order to circumvent Cross Origin Resource Sharing (CORS) restrictions.

To avoid CORS errors when testing your WDC with the TIQK Developer API, you can also install and temporarily activate an extension in your browser (Firefox add-on / Chrome extension). Testing the TIQK WDC in the Tableau desktop app may require a more robust solution to resolve CORS -related connection issues. See this post from Tableau for more information.

Running the sample TIQK WDC

The TIQK WDC sample generates an Auth Token and performs a call to obtain the folders list from the linked TIQK account. It then drills into one of the Team Folders and extracts the file list, metadata, and obtains audit results for any audited files in that folder. 

The data is saved in a Tableau data structure suitable for analysis and visualisation in Tableau Desktop.

Step 1

Clone the TIQK Developer API resources repository at https://github.com/tiqk/Developer-API-resources.git to your computer.

Step 2

Copy the tiqk-wdc.html and tiqk-wdc.js files located in the Tableau Web Data Connector sample folder, into the /Examples/html/ folder inside the Tableau repository that you cloned above in "Getting started".

Step 3

Open the tiqk-wdc.js file for editing, and modify the following items in the script:

  • For variable apiKey, replace the string <your apiKey here> with a valid TIQK API Key generated in your TIQK account in Your organisation > Integrations
  • For variable apiSecret, replace the string  <your apiSecret here> with a valid TIQK API Secret generated in your TIQK account in Your organisation > Integrations
  • For variable subFolderName, replace the string A Team with the name of the subfolder inside the Team folders, that contains one or more files that have already been audited. If you want to reference a subfolder inside the Shared folders on your account instead, change the variable folderType from Teams to Global as well.

Step 4

In the Web Data Connector Simulator running on your computer, change the Connector URL to: 

../Examples/html/tiqk-wdc.html

You might want to open your browser's Developer Tools > Console window before starting the test. Any execution or connection errors are logged there. (You can safely ignore any React -related console warnings generated by the Tableau SDK).

Don't forget to enable any CORS proxies or extensions in your browser to avoid CORS issues while testing (see above). 

Step 5

Place a check mark in the Automatically fetch data for all tables option, and click the Start Interactive Phase button. A browser window will popup, containing the tiqk-wdc.html file content. 

Click the Authenticate and get TIQK data button on the popup:

Step 6

If the connection is successful, "TIQK data feed" will appear in the Connection Name field (under Web Data Connector Properties), and in a few seconds the table structure mapping from TIQK to Tableau will appear under the Tables section as [[TIQKdata].[Audit results for folder: <your selected folder name>]]

There should be no errors in the web browser console.

Scroll further down, and you will see actual data obtained by the WDC script from your account, for the selected folder. If not, click the Fetch Table Data button:

Step 7

If the TIQK data is shown in the Table Data section, the TIQK WDC sample is working correctly on your computer, and is able to securely access your TIQK organisation account, folders and files, and file audit results.

At this point, you can also test using the TIQK WDC sample into the Tableau desktop app for macOS and Windows.

In the Tableau desktop app, under Connect select More ... and then select Web Data Connector

In the popup, enter the full URL on your local computer to the TIQK WDC sample html file in the URL field e.g.

http://localhost:8888/Examples/html/tiqk-wdc.html

and press ENTER.

You should see the same TIQK WDC web page appear as before. Click the Authenticate and get TIQK data button.

If the connection is successful, the table structure and data will now be available in your Tableau desktop app. Note that CORS issues may prevent table data from loading in the desktop app when running on a local computer - you may need to use a CORS proxy (see above).

You can then work with TIQK data in Tableau in the same way as any other data source:

For more information

The TIQK WDC sample is an example Web Data Connector for Tableau, designed to showcase how you can take advantage of the TIQK Developer API to obtain live data from the TIQK platform and your account, and integrate it with Tableau for advanced audit data analytics and visualisations.

  • You can use the example script in the tiqk-wdc.js file as the basis of your own dedicated TIQK WDC for Tableau, modifying it to meet your specific analytics needs.
  • Take care not to store any sensitive data (e.g. your apiKey and apiSecret) in the script itself if the script could be publicly accessible. These provide full Administrator access to your TIQK account and data.
  • Any new audits run by the script might trigger additional charges to your TIQK account (retrieving results from previously run audits via the API does not attract additional charges, however). To avoid audit charges while testing your WDC, you may consider using our Sandbox environment - contact our Customer Success team for help.
  • TIQK Developer API docs, samples, and responses: https://api-docs.tiqk.com 
  • Tableau Web Data Connector docs: https://tableau.github.io/webdataconnector/# 
  • Tableau Web Data Connector Simulator debugging tips: https://tableau.github.io/webdataconnector/docs/wdc_debugging

Did this answer your question?