Tableau ElasticSearch API Connector

In this article you will learn, how to integrate ElasticSearch data to Tableau without coding in few clicks (Live / Bi-directional connection to ElasticSearch). Read / write ElasticSearch data inside your app; perform many ElasticSearch operations without coding, just use easy to use high performance API Connector for ElasticSearch

Using ElasticSearch API Connector you will be able to connect, read and write data from within Tableau. Let's take a look at the steps below to see how exactly to accomplish that.

Download  Help File  Buy 

Create Data Source in ZappySys Data Gateway based on ZappySys API Driver

  1. Download and install ZappySys ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK.

    ElasticSearchDSN

    ZappySys Data Gateway - Add Data Source

  5. When a window appears, firstly give your data source a name if you haven't done that already, then select "ElasticSearch" from the list of Popular Connectors. If "ElasticSearch" is not present in the list, then click "Search Online" and download it. Then set the path to the one where you downloaded it. Finally, hit Continue >> button to continue configuring DSN:

    ElasticSearchDSN
    ElasticSearch
    ODBC DSN Template Selection

  6. Another window appears and it's time to configure the Connection Manager. Firstly, select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases default one is the right one). More info is available in Authentication section.

    And finally, fill in all the required parameters and set optional parameters if needed.:

    ElasticSearchDSN
    ElasticSearch
    Default [Http]
    http://localhost:9200
    Required Parameters
    Optional Parameters
    UserName Fill in the parameter...
    Password Fill in the parameter...
    ODBC DSN HTTP Connection Configuration

  7. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
    ODBC ZappySys Data Source Preview

  8. Click OK to finish creating the data source

Read data in SQL Server from the ZappySys Data Gateway data source

  1. To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way: SSMS SQL Server Configure Linked Server

  2. Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps: SSMS SQL Server Configure Linked Server User Name

  3. Finally, open a new query and execute a query we saved in one of the previous steps:

    SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');

    SSMS SQL Server Query Data Results
  4. Finally, use this or similar query in a view or stored procedure, which you will be able to use in Tableau. We will create a view to return invoices:

    CREATE VIEW vwApiInvoices AS
     SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Invoices')

Read data in Tableau from SQL Server

Actually, we will be getting data from SQL Server which in turn will be getting data from ZappySys Data Gateway data source. Let's begin and see how to accomplish that:

  1. Open Tableau Desktop and click File > New
  2. To create new Connection click More > Microsoft SQL Server > Enter your credentials to connect to SQL Server (in our example before we used tdsuser): Tableau connect to SQL Server
  3. Once connection is created for SQL Server we can read REST API data 3 different ways:
    1. Query View which contains OPENQUERY to Linked Server for REST API data
    2. Use direct SQL Query using OPENQUERY
    3. Use Stored Procedure (Mostly useful to parameterize calls
  4. See below example to pull data from REST API in Tableau using SQL View approach: Create data source in Tableau
  5. Once your data sources are created you can click on Sheet1 and drag fields to create visualizations for Tableau Dashboard: Create data source in Tableau

Passing Parameters to REST API calls in Tableau (Dynamic SQL)

Now let's look at scenario where you have to pass parameters to build Dynamic Dashboard. You can try to insert Parameters in your Direct SQL when you build Dynamic SQL but we found some issues with that so we are going to suggest Stored Procedure approach. For more information on Known issue on Dynamic Metadata Check this post.
  1. First lets create a stored procedure in SQL Server for Parameter Example. Notice how we added WITH RESULT SETS in the code to describe metadata.
    --DROP PROC dbo.usp_GetInvoicesByCountry
    --GO
    /*
    Purpose: Parameterize REST API call via SQL. Call ZappySys Drivers inside SQL Server.
    */
    CREATE PROC dbo.usp_GetInvoicesByCountry
    	@country varchar(100) 
    AS 
    
    DECLARE @sql varchar(max)
    --//Escape single ticks carefully
    SET @sql =  'SELECT OrderID,CustomerID,Country,Quantity FROM $
    WITH (Src=''https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json@filter=Country eq '+ @country +'''
    	 ,Filter=''$.value[*]''
    	 ,DataFormat=''OData''
    )'
    
    DECLARE @sqlFull varchar(max)
    SET @sqlFull='SELECT * FROM OPENQUERY( LS , ''' + REPLACE( @sql, '''', '''''' ) + ''' )'
    PRINT @sqlFull --//For DEBUG purpose
    
    EXECUTE (@sqlFull) 
    WITH RESULT SETS ( 
     (OrderID int,CustomerID varchar(100),Country varchar(100),Quantity int) --//describe first result. If you don't do this then wont work in Tableau 
    )
    GO
    -- Example call
    EXEC dbo.usp_GetInvoicesByCountry @country='Germany'
  2. Once you create a stored procedure go to Tableau datasource and select Database which contains the stored procedure we just created.
  3. Now find your stored proc and drag it on the datasource pane. You will see parameters UI as below. You can create new parameter - Select New Parameter under Value Column. Parameterize Tableau REST API datasource (Stored Procedure Parameters)
  4. Thats it now you can reuse your parameterized datasource anywhere in Dashboard.
  5. If you have need to select Parameters from predefined values rather than free text then edit your parameter and select List option. Define values you like to select from as below. Allow Tableau Parameter selection from multiple values
  6. When you create Tableau Dashboard you will see Parameter dropdown (If you selected List) elase you may see Textbox to enter custom value. Tableau Dashboard Example - REST API Source with Parameterized Datasource

Firewall settings

So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.

Method-1 (Preferred)

If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.

  1. Search for gateway in start menu and open ZappySys Data Gateway.
  2. Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it). Allow Inbound Traffic - Add Firewall Rule for ZappySys Data Gateway

Method-2 Here is another way to add / edit Inbound Traffic rule in windows firewall. Use below method if you choose to customize your rule (for advanced users).
  1. Search for Windows Firewall Advanced Security in start menu.
  2. Under Inbound Rules > Right click and click [New Rule] >> Click Next
  3. Select Port on Rule Type >> Click Next
  4. Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
  5. Select Profile (i.e. Private, Public) >> Click Next
  6. Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
  7. Click OK to save the rule
SQL Server Firewall Allow Inbound Data Gateway

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Store Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Store Procedure Name

  3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Store Procedure

  4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Store Procedure

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

Conclusion

In this article we discussed how to connect to ElasticSearch in Tableau and integrate data without any coding. Click here to Download ElasticSearch Connector for Tableau and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Documentation 

Actions supported by ElasticSearch Connector

ElasticSearch Connectors support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 List indexes
Lists indexes
 Get index metadata
Gets index metadata
Parameter Description
Index
 Get documents
Gets documents
 Get document by ID
Parameter Description
Index
Enter Document ID
 Search / Query documents
Gets documents (Using JSON Query Language)
 Count documents
Parameter Description
Index Name (choose one --OR-- enter * --OR-- comma seperated names) You can enter index name(s) for which you like to perform document count. Enter * (asterisk) to perform search across all indices or comma seperate list (i.e. myidx1,myidx2) or select one from the populated list.
Enter Query (JSON Format)
Option Value
All Records {&quot;match_all&quot;: { } }
Record where comment or name contains TV word {&quot;query_string&quot;: {&quot;query&quot;: &quot;comment:TV OR name:TV&quot;} }
Record with comment field (attribute exists) {&quot;query_string&quot;: {&quot;query&quot;: &quot;_exists_:comment&quot;} }
 Insert documents
Insert documents
Parameter Description
 Update documents
Update documents
Parameter Description
 Upsert documents
Upserts documents
Parameter Description
Index
 Delete documents
Deletes documents
Parameter Description
Index
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Other App Integration scenarios for ElasticSearch

Other API Connectors for Tableau


Documentation 

  • How to connect ElasticSearch in Tableau?

  • How to get ElasticSearch data in Tableau?

  • How to read ElasticSearch data in Tableau?

  • How to load ElasticSearch data in Tableau?

  • How to import ElasticSearch data in Tableau?

  • How to pull ElasticSearch data in Tableau?

  • How to push data to ElasticSearch in Tableau?

  • How to write data to ElasticSearch in Tableau?

  • How to POST data to ElasticSearch in Tableau?

  • Call ElasticSearch API in Tableau

  • Consume ElasticSearch API in Tableau

  • ElasticSearch Tableau Automate

  • ElasticSearch Tableau Integration

  • Integration ElasticSearch in Tableau

  • Consume real-time ElasticSearch data in Tableau

  • Consume realtime ElasticSearch API data in Tableau

  • ElasticSearch ODBC Driver | ODBC Driver for ElasticSearch | ODBC ElasticSearch Driver | SSIS ElasticSearch Source | SSIS ElasticSearch Destination

  • Connect ElasticSearch in Tableau

  • Load ElasticSearch in Tableau

  • Load ElasticSearch data in Tableau

  • Read ElasticSearch data in Tableau

  • ElasticSearch API Call in Tableau