Bring the data you care about into Tableau
Home Page: https://tableau.github.io/webdataconnector
License: MIT License
Use the Tableau Web Data Connector (WDC) to connect to web data sources from Tableau. This is the repository for the Tableau WDC SDK, which includes developer samples and a simulator to help you create your connectors.
Visit the project website and documentation here.
Want to contribute to the WDC? See our contribution guidelines.
Two items here:
Hello,
I want to use additional npm pckage "mssql" but when I add statement var sql = require('mssql');, it gives me error that require is unknown.
May I know if I can add this package at the start of npm or in wdc-simulator.js somewhere?
The information under the properties area of the simulator (Connection Name, Connection Data, etc) are not reset when you use a new connector. For instance, if you use the Earthquake Multitable connector followed by a connector that does not set either the Connection Name or Connection Data, the values from the previously simulated WDC still appear.
Finally digging into the v2 API and ran into my first issue with the SDK.
Currently at line 160, we have this method:
_tableau.Table = function(tableInfo, incrementValue) {
_tableau.validateTableInfoObj(tableInfo);
this.tableInfo = tableInfo;
this.incrementValue = incrementValue || "";
this.appendRows = function(data) {
// Call back with the rows for this table
_tableau._tableDataCallback(this.tableInfo.id, data);
}
};Unfortunately, if I pass around table.appendRows as a callback within my own code, I can get an error stating that I can't read property id of undefined as my getData callback is invoked.
Pretty straightforward fix:
_tableau.Table = function(tableInfo, incrementValue) {
_tableau.validateTableInfoObj(tableInfo);
this.tableInfo = tableInfo;
this.incrementValue = incrementValue || "";
this.appendRows = function(data) {
// Call back with the rows for this table
_tableau._tableDataCallback(tableInfo.id, data); // <-- Right there.
}
};I had created a google spreadsheet and published it to web so that it becomes public.
Pulled the data into tableau using web data connector. Published the workbook. Now when I am trying to refresh the workbook, it gives me an error that it is out of date.
i found it seems can not parse a xml document with xmlconnector, there are some data will be lost,for example,the data---_SENTIMENT (MIXED,NEGATIVE,NEUTRAL,POSITIVE) in the document as bellow is missing,i don't know how to modify the code, what should i do,kindly please give some advice.thanks very much.
What happened to the src query parameter in the simulator auto-populating the URL? Looks like it was documented in #82, but then got removed somewhere along the way.
It'd be super handy to bring back, I'm trying to standardize a few things in the Web Data Connector Generator like so:
# Runs npm start on WDC, npm start on Simulator, opens simulator + WDC in default browser
npm run simulate
# Same, but instead of npm start on the WDC, it runs grunt / grunt watch
npm run simulate:devI am working with Tableau WDC API and testing it on Tableau 10.0.2. This is my situation:
However, I noticed these:
So, the questions are:
Thank you.
I noticed that if I don't specify columnRoles while loading schema, then all variables with float or int data types are automatically classified as measures in Tableau. On the other hand, variables with string data types are classified as dimension in Tableau.
However, when I change my connector to specify the columnRoles and assign dimensions to those variables with number data types while I assign measures to the variables with string data types nothing changes in tableau i.e it looks like the columnRole field is ignored by Tableau.
Is this an intended behaviour? If not, how can one enforce the dimension and measures of variables?
Currently, when abortForAuth is called, we show an error message. To match Tableau, we should automatically launch the WDC in auth mode in this scenario.
Receive the following error when accessing from 9.2:
"The version of Tableau that you are using cannot use the web data connector that you are trying to access. The connector requires at least version '1.1.1' of the web data connector API."
Is there a way to maintain backwards compatibility with the older API?
When I have multiple tables in the simulator and I click "Fetch Table Data" for one of them, I see that it does get the data for just that table. But all the Fetch buttons get a little spinner so it LOOKS like it is fetching all of them even though I selected just one.
When using multiple tables, we do not guarantee a deterministic ordering of the getData calls. It depends on many factors, such as what order the user dragged the tables to the data prep canvas, and what structure the join is.
However, the base table, the left most table in the join structure, will always be called for first.
This could be added to the FAQ potentially.
I'd like to add a resources section to the Reference heading of the main docs page: http://tableau.github.io/webdataconnector/docs/
In this resources section, we can link to some helpful advanced libraries, such as https://www.npmjs.com/package/generator-web-data-connector
While following through the new WDC Tutorial, in the Get the data section, it appears tableData variable is not initialized which throws an error at the tableData.push statement.
Instead of continuing to use the tableauwdc-2.0.0-beta.js file, we should be using one of these files. We shoudl use .latest for our samples, but probably stick with non-minified for readibility sake.
• https://connectors.tableau.com/libs/tableauwdc-2.0.5.js
• https://connectors.tableau.com/libs/tableauwdc-2.0.5.min.js
• https://connectors.tableau.com/libs/tableauwdc-2.0.latest.js
• https://connectors.tableau.com/libs/tableauwdc-2.0.latest.min.js
when i use WEB connector--xmlConnector.html to connet my data,then there are 2 output.
1.when input URL,and the output got wrong
2,when past a XML file in xmlConnector,and get correct.
i don't know why Input URL will go wrong?
I ran into this issue in my local test environment, then verified that it occurs in the hosted examples, too. From this URL: https://tableau.github.io/webdataconnector/Examples/StockQuoteConnector_final.html
Enter a ticket eg. DATA
Click "Get Stock Data"
Observe error in console:
Looks like the WDC is calling a tableau function before tableau.init() has been called.
This is on a Mac, using Chrome (version 49). I tried an incognito window too, same error.
Currently the most recent version is tableauwdc 2.1.1. However, users will only get the latest minor revision 2.0.9. Consider having an additional url to tableauwdc-2.latest.js which will default to the latest major revision.
If this is accepted WDC Version document should be updated.
The example WDC works for retrieving Yahoo Finance data for a single stock, for 1 year back.
Modifying line 44 to start back either -2 or -3 years causes the script to fail, with error "no result found for ticker symbol: xxx".
Any ideas why this is so? The Yahoo finance API appears to support multi-year queries.
Kimono | Kimono | Franz Amador | wdc | KimonoConnector.html
Started going through the Examples in the dev branch (which use https://connectors.tableau.com/libs/tableauwdc-2.1.1.js) with a connector from within Tableau 10.0.2 (10000.16.1004.1720) 64-bit Mac and get the error:
An error occurred while communicating with the data Source. Tableau does not recognize the version of the web data connector API. Show Details: The version of Tableau that you are using cannot use the web data connector that you are trying to access. The connector requires at least version '2.1.1' of the web data connector API.
If I substitute https://connectors.tableau.com/libs/tableauwdc-2.1.1.js in the earthquakeUSGS.html with https://connectors.tableau.com/libs/tableauwdc-2.0.beta.js it works fine using a Web Data Connector from within Tableau.
In short it's erring out while at the same time telling me I need to use 2.1.1 which I am using...
We need to build in links between our docs and our forum so it's easy to find both from the other.
Setting the default aggregation on a column through the tabeau.aggType property is not causing the fields in tableau to have that default aggregation.
This is a known issue and the team is investigating.
The simulator batch file - start_server_windows.bat has hardcoded paths to the Python executable.
I think it should simply require that 'python.exe' is somewhere in the system PATH, and simply invoke it. No need to look for specific directories.
Alternatively, it could require a PYTHON_HOME environment variable be set that gives the location of python.exe.
Finally - there does not seem to be any documentation of running the simulator locally. If this is a supported option, there needs to be some basic instructions on how to use it.
I noticed this error and I wanted to see if you know where it might be coming from.
A bit of background: I have a web api that I hit and returns data, variables and classifications (codes) in a json format. So, my connector expects to load multiple tables. I have implemented a web connector which works correctly on the simulator. When run on tableau desktop (version 10.0.1, trial), I get the following errors:
Either invalid data are present or required fields are empty for class TableInfo. Required fields and respective data types are: { (Name : 'id', Type : QString, IsRequired : true), (Name : 'columns', Type : QVariantList, IsRequired : true), (Name : 'alias', Type : QString, IsRequired : false), (Name : 'description', Type : QString, IsRequired : false), (Name : 'incrementColumnId', Type : QString, IsRequired : false) }.
The error is thrown as "Reporting data source exception. Type='WDCInvalidData' message='...'
This seems to happen only when I am loading more than 2 tables. If I have just one table or 2 I don't get any error and everything works fine. The error I am getting isn't really that descriptive/ helpful. For what I can gather, this error is thrown by Tableau desktop when it's putting the table schemas in place.
Given the fact that my connector works just fine for any number of tables on the simulator and works correctly on Tableau desktop for two tables max, I wonder if this might be a tableau limitation for trial versions.
The earthquake multitable sample fails in Tableau. This is because the ids it uses for it's column does not match the accepted format for ids in Tableau (I believe having underscores was the offender here).
As a side note: Date pickers in the QT WebKit do not function (at least on Mac). You can still manually enter a date though.
There seems to be major differences between tableauwdc-1.1.0.js in master and the version used in the examples. What is the root cause of these differences?
Add debugging tips, including info about:
?src= to maintain the same connector in the simulatorIn Tableau, this is a valid code snippet:
myConnector.init = function(initCallback) {
initCallback();
tableau.submit();
}
This auto submits a connector so no interactive phase is required. In the data gathering phase, this submit call is ignored. However in the simulator this causes the simulator to get into an infinite loop.
Hello,
i try to connect tableau to a google sheet using this procedure: http://onlinehelp.tableau.com/v9.2/pro/online/windows/fr-fr/help.html#examples_web_data_connector.html
But when Tableau tries to load the data i have the following error:
Does somenoe knows what should i do?
thanks for your help,
Cédric
As the docs are in beta until the upcoming release of Tableau 10, the links in the docs will point to the dev branch of the webdataconnector repo.
When we merge dev into master with the release of Tableau 10, we will need to update these links. This is a place holder for that. Only location I am currently aware of this is the Samples section in the docs. But we should do a grep for more locations.
The lifecycle diagram needs two updates:
The 1.1.0 version of the WDC simluator displays messages written with tableau.log in the bottom area of the Simulator UI.
I see that tableau.log is still part of the WDC 1.1.1 API, but none of the message being written are displayed anywhere. Is there something I need to do to display the tableau log?
It would be helpful for new developers if the shim logged a warning message when a WDC page is loaded outside of the simulator. WDC methods are not executed unless ran within the simulator or Tableau, and this can be a confusing experience for new developer.
http://tableau.github.io/webdataconnector/docs/wdc_custom_init_and_shutdown
The custom init and shutdown page suggests calling tableau.initCallback from the connector's init method, which is deprecated.
It should be the same pattern as e.g., getSchema: myConnector.init should take an initCallback parameter, and call that.
Docs bug here, the correct property name is "alias".
I've got a connector that streams data from REST API. It works as expected in the provided simulator . When I load the connector into Tableau 10, I go through the credentials page successfully and then I get stuck at this page:
Clicking cancel results in the following being displayed indefinitely:
I have to kill Tableau to get out of this screen. The connector file is hosted on a remote server (I couldn't find a way to point Tableau to a local file), while Tableau and the data API are running on localhost for dev purposes. The connector code is
(function (){
var myConnector = tableau.makeConnector();
setupConnector = function (){
tableau.connectionData = {server: "http://127.0.0.1:8081", token: "hello"};
tableau.connectionName = server + token.substring(0, 5);
};
myConnector.getSchema = function (schemaCallback){
var params = tableau.connectionData;
var cols = [];
var apiURL = params.server + "/api/component?target=schema&access_token=" + params.token;
$.getJSON(apiURL, function (resp){
cols.push({
'id': 'hello',
'alias': 'alias',
'dataType': tableau.dataTypeEnum.int
});
}).success(function (){
var tableInfo = {
id: "Data Feed",
alias: "Read data from API",
columns: cols
};
schemaCallback([tableInfo]);
});
};
myConnector.getData = function (table, doneCallback){
var params = tableau.connectionData;
var apiURL = params.server + "/api/component?access_token=" + params.token;
var getMoreData = function (){
$.getJSON(apiURL, function (resp){
if (resp == "Come back later"){
doneCallback();
}
else{
if (!resp.length){
console.info("No new data has been fetched.");
}
table.appendRows(resp);
getMoreData();
}
});
}
getMoreData();
};
tableau.registerConnector(myConnector);
$(document).ready(function (){
$("#submitButton").click(function (){
setupConnector();
tableau.submit();
});
});
})();
The abortForAuth API can only be used during the data gathering phase, but we do not mention this in the docs.
To make contributions to the Docs, devs will need to serve the jekyll documentation locally. This can be done through:
web data connector is really a nice feature. But currently it is limited to an extract, so it does not work for large data set.
what is the plan to support live data?
The new simulator seems to require using "http://" at the beginning of connectors being tested. For example, I can't just enter "localhost:8080/index.html". Instead I have to enter "http://localhost:8080/index.html". Would be nice to be able to use both options.
While these are two separate issues, the second only appears when trying to make a work around for the first. In developing a WDC for Tableau, I noticed two issues with the Tableau internal browser's javascript engine (while running in Public and Desktop).
Array.prototype.includesFor example. Try the following code (after adding in the includes polyfill above):
(function (){
var arr = ["a","b","c"]
for (var x in arr) {
console.log(x.toString() + ": " + arr[x]);
}
})();
The console will output:
"0: a"
"1: b"
"2: c"
"includes: function (searchElement) {........"
Using this same code on a modern browser does not have this effect. (It does not iterate over the key "includes")
Because of this, I can not use my libraries (which depend on both includes and for..in to be correctly implemented) and thus can not complete my WDC.
Seems like a know issue with the --all flag in, nyc our coverage provider. Currently the flag raises an error and stops all tests, but once their issue is fixed we should add it to the unit:coverage and unit:coveralls npm commands to have our PRs more accurately display our code coverage stats.
If you enter a URL (into chrome, not simulator), such as this: http://localhost:8888/Simulator/?src=../Examples/JSONMultiTableConnector.html
Then the JSONMultiTableConnector will always be by default loaded into the simulator URL bar when you refresh. You don’t have to retype the example name.
Here are some things we can try:
npm install has these errors:
npm WARN deprecated [email protected]: this package has been reintegrated into npm and is now out of date with respect to npm
npm WARN deprecated [email protected]: to-iso-string has been deprecated, use @segment/to-iso-string instead.
npm WARN deprecated [email protected]: Jade has been renamed to pug, please install the latest version of pug instead of jade
npm WARN deprecated [email protected]: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue
And npm start does not run. The node_modeles/ directory is empty.
With the V2.0 API, we have added support to read locale information from Tableau. In Tableau, the user can set the locale of the product by going to Help -> Choose Language.
We now pass this information to the WDC through the tableau.locale property. This allows the WDC to serve up localized content.
We need to add this to the API reference.
This is correct in the API, just a small docs typo.
In the new version of WDC with Tableau 10, you can now open URLs from your web data connector pages in an external browser. In your WDC HTML page, for any url that you wish to be opened in an external browser, add the target="_blank" property to the anchor element. For example:
<a href="http://tabsoft.co/wdc" target="_blank">Hello Docs?</a>
This link would open in the user's default browser (chrome, firefox, etc.), instead of redirecting the in Tableau browser.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.