浏览代码

SQL: Update documentation on Tableau integration (#60890)

* Update docs on Tableau Desktop integration

Update the docs on how to integrate with Tableau Desktop, now using the
dedicated connector in conjunction with the JDBC driver.

* Add docs for connecting with Tableau Server

Add the steps required to connecto to Elasticsearch for Tableau Server.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Bogdan Pintea 5 年之前
父节点
当前提交
fb6baa85aa

二进制
docs/reference/images/sql/client-apps/apps_tableau_desktop_connect.png


二进制
docs/reference/images/sql/client-apps/apps_tableau_desktop_from_connector.png


二进制
docs/reference/images/sql/client-apps/apps_tableau_desktop_prepare.png


二进制
docs/reference/images/sql/client-apps/apps_tableau_desktop_report.png


二进制
docs/reference/images/sql/client-apps/apps_tableau_server_connect.png


二进制
docs/reference/images/sql/client-apps/apps_tableau_server_from_connector.png


二进制
docs/reference/images/sql/client-apps/apps_tableau_server_prepare.png


二进制
docs/reference/images/sql/client-apps/apps_tableau_server_report.png


二进制
docs/reference/images/sql/odbc/apps_tableau_connd.png


二进制
docs/reference/images/sql/odbc/apps_tableau_fromodbc.png


二进制
docs/reference/images/sql/odbc/apps_tableau_loaded.png


+ 5 - 0
docs/reference/redirects.asciidoc

@@ -981,6 +981,11 @@ See <<eql-syntax-limitations>>.
 
 See <<eql-required-fields>>.
 
+[role="exclude",id="sql-client-apps-tableau"]
+=== Tableau Desktop
+
+See <<sql-client-apps-tableau-desktop>> and <<sql-client-apps-tableau-server>>.
+
 [role="exclude",id="search-request-body"]
 === Request body search
 

+ 4 - 2
docs/reference/sql/endpoints/client-apps/index.asciidoc

@@ -16,7 +16,8 @@ as long as the app can use the {es-sql} driver, it can use {es-sql}.
 * <<sql-client-apps-qlik, Qlik Sense Desktop>>
 * <<sql-client-apps-squirrel, SQuirreL SQL>>
 * <<sql-client-apps-workbench, SQL Workbench>>
-* <<sql-client-apps-tableau, Tableau Desktop>>
+* <<sql-client-apps-tableau-desktop, Tableau Desktop>>
+* <<sql-client-apps-tableau-server, Tableau Server>>
 
 IMPORTANT: Elastic does not endorse, promote or provide support for any of the applications listed. For native Elasticsearch integration in these products, please reach out to their respective vendor.
 
@@ -34,4 +35,5 @@ include::microstrat.asciidoc[]
 include::qlik.asciidoc[]
 include::squirrel.asciidoc[]
 include::workbench.asciidoc[]
-include::tableau.asciidoc[]
+include::tableau-desktop.asciidoc[]
+include::tableau-server.asciidoc[]

+ 53 - 0
docs/reference/sql/endpoints/client-apps/tableau-desktop.asciidoc

@@ -0,0 +1,53 @@
+[role="xpack"]
+[testenv="platinum"]
+[[sql-client-apps-tableau-desktop]]
+=== Tableau Desktop
+
+Use the {es} JDBC driver and dedicated {es} Tableau Connector to access {es} data from Tableau Desktop.
+
+IMPORTANT: Elastic does not endorse, promote or provide support for this application; for native Elasticsearch integration in this
+product, please reach out to its vendor.
+
+[[sql-client-apps-tableau-desktop-prereqs]]
+==== Prerequisites
+
+* https://www.tableau.com/products/desktop[Tableau Desktop] 2019.4 or later
+* {es-sql} <<sql-jdbc, JDBC driver>>
+* https://www.elastic.co/downloads/tableau-connector[{es} Connector for Tableau]
+
+[[sql-client-apps-tableau-desktop-load-data]]
+==== Load data
+
+First, move or download the JDBC driver to the Tableau Desktop drivers directory:
+
+* Windows: `C:\Program Files\Tableau\Drivers`
+* Mac: `/Users/[user]/Library/Tableau/Drivers`
+
+Move the {es} Connector for Tableau to the Tableau Desktop connectors directory:
+
+* Windows: `C:\Users\[Windows User]\Documents\My Tableau Repository\Connectors`
+* Mac: `/Users/[user]/Documents/My Tableau Repository/Connectors`
+
+Launch Tableau Desktop. In the menu, click **More...** and select **Elasticsearch by Elastic** as the data source.
+
+[[apps_tableau_desktop_from_connector]]
+[role="screenshot"]
+image:images/sql/client-apps/apps_tableau_desktop_from_connector.png[Select Elasticsearch by Elastic as the data source]
+
+In the **New connection** modal, enter the information for your {es} instance, and click **Sign In**.
+
+[[apps_tableau_connect]]
+[role="screenshot"]
+image:images/sql/client-apps/apps_tableau_desktop_connect.png[Sign in]
+
+In the main window, select your {es} instance as the **Database**. Then select a table to load.
+
+[[apps_tableau_prepare]]
+[role="screenshot"]
+image:images/sql/client-apps/apps_tableau_desktop_prepare.png[Select a table to load]
+
+Finally, generate a report.
+
+[[apps_tableau_report]]
+[role="screenshot"]
+image:images/sql/client-apps/apps_tableau_desktop_report.png[Generate a report]

+ 54 - 0
docs/reference/sql/endpoints/client-apps/tableau-server.asciidoc

@@ -0,0 +1,54 @@
+[role="xpack"]
+[testenv="platinum"]
+[[sql-client-apps-tableau-server]]
+=== Tableau Server
+
+Use the {es} JDBC driver and dedicated {es} Tableau Connector to access {es} data from Tableau Server.
+
+IMPORTANT: Elastic does not endorse, promote or provide support for this application; for native Elasticsearch integration in this
+product, please reach out to its vendor.
+
+[[sql-client-apps-tableau-server-prereqs]]
+==== Prerequisites
+
+* https://www.tableau.com/products/server[Tableau Server] 2019.4 or later
+* {es-sql} <<sql-jdbc, JDBC driver>>
+* https://www.elastic.co/downloads/tableau-connector[{es} Connector for Tableau]
+
+[[sql-client-apps-tableau-server-load-data]]
+==== Load data
+
+First, move or download the JDBC driver to the Tableau Server drivers directory:
+
+* Windows: `C:\Program Files\Tableau\Drivers`
+* Mac: `/Users/[user]/Library/Tableau/Drivers`
+
+Move the {es} Connector for Tableau to the Tableau Server connectors
+directory. To find the location of this directory, refer to Tableau Server
+documentation or use the TSM command line interface.
+
+Restart Tableau Server.
+
+To load data into a workbook, add a **New Data Source** from the **Data** menu or using the icon. In the **Connectors** tab of the **Connect to Data** modal, select **Elasticsearch by Elastic**.
+
+[[apps_tableau_server_from_connector]]
+[role="screenshot"]
+image:images/sql/client-apps/apps_tableau_server_from_connector.png[Select Elasticsearch as the data source]
+
+Enter the information for your {es} instance, and click **Sign In**.
+
+[[apps_tableau_server_connect]]
+[role="screenshot"]
+image:images/sql/client-apps/apps_tableau_server_connect.png[Sign in]
+
+In the main window, select your {es} instance as the **Database**. Then select a table to load.
+
+[[apps_tableau_server_prepare]]
+[role="screenshot"]
+image:images/sql/client-apps/apps_tableau_server_prepare.png[Select a table to load]
+
+Finally, generate a report.
+
+[[apps_tableau_server_report]]
+[role="screenshot"]
+image:images/sql/client-apps/apps_tableau_server_report.png[Generate a report]

+ 0 - 45
docs/reference/sql/endpoints/client-apps/tableau.asciidoc

@@ -1,45 +0,0 @@
-[role="xpack"]
-[testenv="platinum"]
-[[sql-client-apps-tableau]]
-=== Tableau Desktop
-
-You can use the {es} ODBC driver to access {es} data from Tableau Desktop.
-
-IMPORTANT: Elastic does not endorse, promote or provide support for this application; for native Elasticsearch integration in this product, please reach out to its vendor.
-
-==== Prerequisites
-
-* https://www.tableau.com/products/desktop[Tableau Desktop] 2018 or higher
-* {es-sql} <<sql-odbc, ODBC driver>>
-* A preconfigured User or System DSN (see <<dsn-configuration,Configuration>> section on how to configure a DSN).
-
-==== Data loading
-
-First, you'll need to choose ODBC as the source to load data from. Once launched, click on the _More..._ menu item and in the expanded
-list of connectors, choose _Other Databases (ODBC)_:
-
-[[apps_tableau_fromodbc]]
-.ODBC as data source
-image:images/sql/odbc/apps_tableau_fromodbc.png[]
-
-In the new connection window that appears, select the previously configured DSN that will connect to the desired {es} instance. Press the
-_Connect_ button. In case credentials are needed, a new windows - driver's DSN editor - will be launched and you'll need to provide the
-_Username_ and _Password_ in the respective fields. (Note that these will not be stored as part of the DSN, but only remembered for the
-duration of the session).
-If the connection is successful, the _Connection Attributes_ section of the connection window is populated with the respective details;
-press the _Sign In_ button next:
-
-[[apps_tableau_connd]]
-.Authenticate and sign in
-image:images/sql/odbc/apps_tableau_connd.png[]
-
-In Tableau Desktop's main window then choose the name of {es} instance as the _Database_, select one table that you'd like to load from
-the list (click on the magnifying glass icon to have them all shown), drag the table over the work area, then click the _Update Now_
-button to load a preview of the table:
-
-[[apps_tableau_loaded]]
-.Data loaded
-image:images/sql/odbc/apps_tableau_loaded.png[]
-
-
-// vim: set noet fenc=utf-8 ff=dos sts=0 sw=4 ts=4 tw=138 columns=140