Writing your first Web Data Connector

Size: px

Start display at page:

Download "Writing your first Web Data Connector"

Egbert Johns
5 years ago
Views:

2 Welcome

3 # T C 1 8 Writing your first Web Data Connector Brett Taylor Staff Software Engineer Tableau Ashwin Sekar Software Engineer Tableau

4 Enabling Integrations for Developers Embedded Analytics Integrations Extensions Data Connectivity Data Science Automation Tableau Platform

5 Agenda What is a Web Data Connector How to use a Web Data Connector Live demonstration of building a Web Data Connector

6 What is Web Data Connector?

7 Web Data Connector Your HTML & JavaScript

8 Why use a WDC? Data Accessibility Automation

9 Using Web Data Connectors

10 Building Web Data Connectors

11 It all starts here

12 WDC Phase Model Phase 1: Interactive Phase The UI that a user sees The purpose is to collect input: Filters Authentication Phase 2: Gather Data Phase Runs after the interactive phase Used to retrieve schema & data

13 Functions WDCs Implement init(initcallback) Initializes WDC and specifies advanced options [optional] getschema(schemacallback) Returns schema information getdata(table, donecallback) Returns data for requested table

17 Creating a Web Data Connector Pre-req #1: Know your Web API API Overview API Documentation Response format (JSON? XML?) API parameters Sample requests (e.g. JSON lint)

18 Creating a Web Data Connector Pre-req #2: Web Data Connector tools Download the WDC SDK git clone Download and Install a good text editor Brackets, Atom, Sublime Text Have a web server ready to host your WDC Python (SimpleHTTPServer), IIS, Node and npm, Tomcat, WAMP

19 Functions WDCs Implement init(initcallback) Initializes WDC and specifies advanced options [optional] getschema(schemacallback) Returns schema information getdata(table, donecallback) Returns data for requested table

20 Creating a Web Data Connector Let s party in Desktop! Load connector in Tableau Desktop Check for any error messages Have fun and start visualizing in Tableau Desktop!

21 What Else Is Possible?

22 What Else Is Possible?

23 WDC Tips Watch out for differences in browser behavior WDC uses a browser called Qt WebKit which behaves differently than Chrome and Firefox. This can lead to it worked in the Simulator but not Tableau.

24 WDC Tips Watch out for differences in browser behavior WDC uses a browser called Qt WebKit which behaves differently than Chrome and Firefox. This can lead to it worked in the Simulator but not Tableau. We are actively working to move WDC to use Chromium!

25 WDC Tips Don t expect state to be preserved WDCs are launched multiple times and state is not preserved. Global variables won t be preserved. Use tableau.connectiondata property.

26 WDC Tips Refresh WDCs on Tableau Server requires extra work Admins must whitelist WDCs in order to refresh on Tableau Server. We recommend the Sync Client with Tableau Online. More suggestions are in our WDC FAQ.

27 Advanced Topics User inputs in HTML Publishing your WDC Authentication Multiple tables

28 Final Takeaways Read the tutorials Don t start from scratch! Find an existing WDC you can re-use. Use the WDC Simulator Debugging JavaScript is a lot easier from the simulator.

29 #DataDev Resources TC18 Developer Track Content Tableau Developer Program Free environment for development Early access to info and APIs Tableau on GitHub

30 D ATA C O N N E C T I V I T Y R E L AT E D S E S S I O N S Data and Back Again Lessons from Shipping WDCs Oct-24 10:15 11:15 Oct-24 12:00 13:00 Write Your First Web Data Connector (WDC) Oct-23 14:15 15:15 Oct-24 15:30 16:30 Leveraging the Extract API to Build Data Models Oct-23 10:45 11:45 Oct-24 10:15 11:15

31 Please complete the session survey from the Session Details screen in your TC18 app

32 #TC18 Thank you! Brett Ashwin

Extract API: Build sophisticated data models with the Extract API

Welcome # T C 1 8 Extract API: Build sophisticated data models with the Extract API Justin Craycraft Senior Sales Consultant Tableau / Customer Consulting My Office Photo Used with permission Agenda 1)