ODBC: Change Tableau connector version (#622)

* changing version of Tableau connector * change driver version * add tableau doc * doc update * doc update * update user docs * nit
opendistro-for-elasticsearch · Jul 28, 2020 · e370ce9 · e370ce9
1 parent 9dac0ac
commit e370ce9
Show file tree

Hide file tree

Showing 17 changed files with 79 additions and 11 deletions.
diff --git a/sql-odbc/docs/user/img/tableau_columns_list.png b/sql-odbc/docs/user/img/tableau_columns_list.png
diff --git a/sql-odbc/docs/user/img/tableau_data_preview.png b/sql-odbc/docs/user/img/tableau_data_preview.png
diff --git a/sql-odbc/docs/user/img/tableau_dialog.png b/sql-odbc/docs/user/img/tableau_dialog.png
diff --git a/sql-odbc/docs/user/img/tableau_download_taco.png b/sql-odbc/docs/user/img/tableau_download_taco.png
diff --git a/sql-odbc/docs/user/img/tableau_graph.png b/sql-odbc/docs/user/img/tableau_graph.png
diff --git a/sql-odbc/docs/user/img/tableau_select_connector.png b/sql-odbc/docs/user/img/tableau_select_connector.png
diff --git a/sql-odbc/docs/user/img/tableau_select_table.png b/sql-odbc/docs/user/img/tableau_select_table.png
diff --git a/sql-odbc/docs/user/img/tableau_table_list.png b/sql-odbc/docs/user/img/tableau_table_list.png
diff --git a/sql-odbc/docs/user/microsoft_excel_support.md b/sql-odbc/docs/user/microsoft_excel_support.md
@@ -1,4 +1,4 @@
-# Microsoft Excel
+#  Connecting Open Distro For ElasticSearch to Microsoft Excel on Windows
 
 ## Prerequisites
 

diff --git a/sql-odbc/docs/user/microsoft_excel_support_mac.md b/sql-odbc/docs/user/microsoft_excel_support_mac.md
@@ -1,4 +1,4 @@
-# Micosoft Excel on Mac OS
+#  Connecting Open Distro For ElasticSearch to Micosoft Excel on Mac OS
 
 ## Prerequisites
 

diff --git a/sql-odbc/docs/user/power_bi_support.md b/sql-odbc/docs/user/power_bi_support.md
@@ -1,4 +1,4 @@
-# Microsoft Power BI Desktop
+#  Connecting Open Distro For ElasticSearch to Microsoft Power BI Desktop
 
 **NOTE**: **The connector is under development. All connection options are not available yet. There could be issues while loading data**
 

diff --git a/sql-odbc/docs/user/tableau_support.md b/sql-odbc/docs/user/tableau_support.md
@@ -0,0 +1,68 @@
+# Connecting Open Distro For ElasticSearch to Tableau Desktop via the Tableau Connector
+
+## Overview
+
+Connect an Open Distro For ElasticSearch data source to Tableau Desktop via the Tableau Connector to create a basic graph.
+
+## Prerequisites
+
+* Download and Install [Tableau Desktop](https://www.tableau.com/products/desktop/download) 2020 and higher
+* Install and Configure [Open Distro for Elasticsearch](https://opendistro.github.io/for-elasticsearch-docs/docs/install/)
+* Download and Install [Open Distro for Elasticsearch SQL ODBC driver](../../README.md)
+* Download Tableau Connector for `SQL by Open Distro for ES` ([odfe_sql_odbc.taco](../../src/TableauConnector/odfe_sql_odbc/odfe_sql_odbc.taco)).
+Click on **Download** option for downloading `odfe_sql_odbc.taco` file.
+<img src="img/tableau_download_taco.png" >
+
+## Prepare data 
+
+* Copy `odfe_sql_odbc.taco` file to My Tableau Repository.
+
+  * On windows: **%User%/Documents/My Tableau Repository/Connectors/**.
+  * On Mac: **~/Documents/My Tableau Repository/Connectors/**.
+
+* Open Tableau using following command
+
+```
+<full-Tableau-path>\bin\tableau.exe -DDisableVerifyConnectorPluginSignature=true
+```
+
+* Click on **Connect** > **More** > **SQL by Open Distro for ES**.
+
+<img src="img/tableau_select_connector.png" width=600>
+
+* Enter **Server** & **Port** value. 
+* Select required authentication option. For **AWS_SIGV4** authentication, select **Integrated Authentication** and enter value for **Region**.
+* Use **Additional Options** section for specifying options like **FetchSize**, **ResponseTimeout**. Use `;` to separate values. For example,
+
+```
+FetchSize=2000;ResponseTimeout=20;
+```
+
+<img src="img/tableau_dialog.png" width=400>
+
+* Click on **Sign In**.
+* You will get a list of tables when the connection is successful.
+
+<img src="img/tableau_table_list.png">
+
+## Analyze Data
+
+To generate a graph,
+
+* Double click on any required table from the list and click on **Update Now** to load data preview.
+
+<img src="img/tableau_select_table.png">
+
+* Data preview will be loaded.
+
+<img src="img/tableau_data_preview.png">
+
+* Click on **Sheet 1**. You can see a list of attributes under section **Data**.
+
+<img src="img/tableau_columns_list.png">
+
+* Double click on any required attributes to generate a simple graph. 
+
+<img src="img/tableau_graph.png">
+
+* You can change visualizations by selecting any active visualization from **Show Me**.
diff --git a/sql-odbc/src/CMakeLists.txt b/sql-odbc/src/CMakeLists.txt
@@ -78,8 +78,8 @@ set(INSTALL_SRC "${CMAKE_CURRENT_SOURCE_DIR}/installer")
 set(DSN_INSTALLER_SRC "${CMAKE_CURRENT_SOURCE_DIR}/DSNInstaller")
 
 # ODBC Driver version 
-set(DRIVER_PACKAGE_VERSION "1.9.0.0")
-set(DRIVER_PACKAGE_VERSION_COMMA_SEPARATED "1,9,0,0")
+set(DRIVER_PACKAGE_VERSION "1.9.0.1")
+set(DRIVER_PACKAGE_VERSION_COMMA_SEPARATED "1,9,0,1")
 add_compile_definitions( ES_ODBC_VERSION="${DRIVER_PACKAGE_VERSION}"
                          # Comma separated version is required for odbc administrator's driver file.
                          ES_ODBC_DRVFILE_VERSION=${DRIVER_PACKAGE_VERSION_COMMA_SEPARATED} )

diff --git a/sql-odbc/src/TableauConnector/odfe_sql_odbc/manifest.xml b/sql-odbc/src/TableauConnector/odfe_sql_odbc/manifest.xml
@@ -1,10 +1,10 @@
 <?xml version='1.0' encoding='utf-8' ?>
 
-<connector-plugin class='odfe_sql_odbc' superclass='odbc' plugin-version='1.8.0.0' name='SQL' version='18.1' min-version-tableau='2020.1'>
+<connector-plugin class='odfe_sql_odbc' superclass='odbc' plugin-version='1.9.0.1' name='SQL' version='18.1' min-version-tableau='2020.1'>
   <vendor-information>
       <company name="Open Distro for ES"/>
-      <support-link url="https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc"/>
-      <driver-download-link url="https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc"/>
+      <support-link url="https://github.com/opendistro-for-elasticsearch/sql"/>
+      <driver-download-link url="https://github.com/opendistro-for-elasticsearch/sql"/>
   </vendor-information>
   <connection-customization class="odfe_sql_odbc" enabled="true" version="10.0">
     <vendor name="Open Distro for ES"/>

diff --git a/sql-odbc/src/TableauConnector/odfe_sql_odbc/odfe_sql_odbc.taco b/sql-odbc/src/TableauConnector/odfe_sql_odbc/odfe_sql_odbc.taco
diff --git a/sql-odbc/src/TableauConnector/odfe_sql_odbc_dev/manifest.xml b/sql-odbc/src/TableauConnector/odfe_sql_odbc_dev/manifest.xml
@@ -1,10 +1,10 @@
 <?xml version='1.0' encoding='utf-8' ?>
 
-<connector-plugin class='odfe_sql_odbc_dev' superclass='odbc' plugin-version='0.2.0' name='Open Distro for Elasticsearch SQL ODBC DEV' version='18.1' min-version-tableau='2020.1'>
+<connector-plugin class='odfe_sql_odbc_dev' superclass='odbc' plugin-version='1.9.0.1' name='Open Distro for Elasticsearch SQL ODBC DEV' version='18.1' min-version-tableau='2020.1'>
   <vendor-information>
       <company name="Open Distro for Elasticsearch"/>
-      <support-link url="https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc"/>
-      <driver-download-link url="https://github.com/opendistro-for-elasticsearch/sql/tree/master/sql-odbc"/>
+      <support-link url="https://github.com/opendistro-for-elasticsearch/sql"/>
+      <driver-download-link url="https://github.com/opendistro-for-elasticsearch/sql"/>
   </vendor-information>
   <connection-customization class="odfe_sql_odbc_dev" enabled="true" version="10.0">
     <vendor name="Open Distro for Elasticsearch"/>

diff --git a/sql-odbc/src/TableauConnector/odfe_sql_odbc_dev/odfe_sql_odbc_dev.taco b/sql-odbc/src/TableauConnector/odfe_sql_odbc_dev/odfe_sql_odbc_dev.taco