MS Excel ElasticSearch API Connector

In this article you will learn, how to integrate ElasticSearch data to MS Excel 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 MS Excel. Let's take a look at the steps below to see how exactly to accomplish that.

Download  Help File  Buy 

Create ODBC Data Source (DSN) based on ZappySys API Driver

To get data from ElasticSearch using MS Excel we first need to create a DSN - Data Source - which will access data from ElasticSearch, which later will be able to get using MS Excel. Perform these steps:

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys API Driver:

    Create new API Connection for ElasticSearch

    You should create System DSN if client application is launched under Windows System Account, e.g. as a Windows Service.
    Launch ODBC Data Sources 32-bit version in case your client application is a 32-bit (x86) application (required only for System DSN).
  4. 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

  5. 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

  6. 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

  7. Click OK to finish creating the data source

Read data in Excel from the DSN

  1. In Excel click Data, then select Get Data, proceed with From Other Sources and choose From ODBC item. This will get data from ODBC data source we created:
    Create ODBC data source in Excel

  2. A small window opens, then simply select the data source you created in previous steps:

    ElasticSearchDSN
    Select DSN data source in Excel

  3. Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:

    ElasticSearchDSN
    Excel DSN Authentication

  4. Finally, you will be asked to select a table or view to get data from. Select one and load the data!
    Excel DSN Authentication

  5. Finally, use data extracted from ElasticSearch API in an Excel worksheet:
    Excel Select DSN Table

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 MS Excel and integrate data without any coding. Click here to Download ElasticSearch Connector for MS Excel 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 MS Excel


Documentation 

  • How to connect ElasticSearch in MS Excel?

  • How to get ElasticSearch data in MS Excel?

  • How to read ElasticSearch data in MS Excel?

  • How to load ElasticSearch data in MS Excel?

  • How to import ElasticSearch data in MS Excel?

  • How to pull ElasticSearch data in MS Excel?

  • How to push data to ElasticSearch in MS Excel?

  • How to write data to ElasticSearch in MS Excel?

  • How to POST data to ElasticSearch in MS Excel?

  • Call ElasticSearch API in MS Excel

  • Consume ElasticSearch API in MS Excel

  • ElasticSearch MS Excel Automate

  • ElasticSearch MS Excel Integration

  • Integration ElasticSearch in MS Excel

  • Consume real-time ElasticSearch data in MS Excel

  • Consume realtime ElasticSearch API data in MS Excel

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

  • Connect ElasticSearch in MS Excel

  • Load ElasticSearch in MS Excel

  • Load ElasticSearch data in MS Excel

  • Read ElasticSearch data in MS Excel

  • ElasticSearch API Call in MS Excel