Skip to content
This repository has been archived by the owner on Mar 15, 2024. It is now read-only.
/ tableau-wdc Public archive

Web Data Connector for integration your logged data into Tableau

License

Notifications You must be signed in to change notification settings

ixoncloud/tableau-wdc

Repository files navigation

IXON Tableau-WDC

CircleCI

Tableau-WDC is a Web Data Connector webapp for Tableau, which uses the IXlsi API to fetch data from the IXPlatform and exports it to Tableau.

Getting Started

Prerequisites

In order to use IXON Tableau-WDC you will need a copy of Tableau.

The webapp has been tested with Tableau Desktop and Tableau Public.

To get a copy of Tableau Public for free, visit the site: https://public.tableau.com/

IXON hosted instance

IXON is hosting the latest stable release of the webapp, in case you are not looking into hosting Tableau-WDC yourself.

Simply paste the following URL in Tableau after selecting the data source "Web Data Connector":

https://cdn.ixon.cloud/tableau/latest/

Development

Prerequisites

In order to develop, test & build Tableau-WDC you'll need the following installed:

  • Nodejs 8.9+

You will also need an IXON Application ID in order to be able to let the webapp communicate with the IXPlatform.

Running

  • Run npm install or yarn to install all dependencies.

  • Setup your development environment file:

  • Run npm run start or yarn start to start the angular-cli development server.

Building for Production

  • Run npm install --production or yarn --production to install all production dependencies.

  • Setup your production environment file:

  • Run npm run build:prod or yarn build:prod to build the webapp for production.

    • In case you are hosting the site in a subdirectory (Not on /), please use npm run build:prod --base-href <path> or yarn build:prod --base-href <path>
  • You will find the final html, css & javascript files in dist/

Unit-tests

Run npm run test or yarn test to run the unit-tests with Karma & Headless Chrome (Google Chrome has to be installed).

Code Documentation

Run npm run docs or yarn docs to generate the compodocs documentation based on JSDoc comments in the code.


Frequently Asked Questions

The page is blank when I load the site in my webbrowser, why is it not working?
Tableau-WDC is built to run in the browser built-in to Tableau. Because the webapp expects to be loaded in that exact browser, it will not do anything when loaded via a normal browser.

Web Data Connector

To import data from the web, Tableau has a feature called Web Data Connectors. These WDCs are websites which include a special javascript library, allowing javascript on the site to communicate with the Tableau builtin browser.

The communication between the site and Tableau is divided into two phases:

Interactive Phase

The Tableau builtin browser is visible and Tableau-WDC shows the login screen. Once logged in, Tableau-WDC shows a configuration tool which can be used to choose which Agents and Tags have to be exported from the IxPlatform. This page also allows further configuration of for instance the limit and post aggregator. After configuration is done, the user can start the importing process, closing the window and starting the second phase:

Gather Data phase

In the Gather Data phase, Tableau will open Tableau-WDC in the background to fetch the data. Tableau-WDC will detect that it's running in the second phase and used the saved credentials & settings from the Interactive Phase to fetch the requested data from the IxLsi API. Once this is done the webapp will parse the data and hand it over to Tableau.


License

IXON Tableau-WDC is licensed under the MIT License.