SSRS ElasticSearch API Connector
In this article you will learn, how to integrate
Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connection and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.
If you are new with ODBC and ZappySys ODBC PowerPack then check below links to get started.
Video Tutorial - Integrate
ElasticSearch data in SSRS
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
ElasticSearchintegration in SSRS
- How to configure connection for
- Features about
ElasticSearchDriver (Authentication / Query Language / Examples / Driver UI)
ElasticSearchConnection in SSRS
Create Data Source in ZappySys Data Gateway based on ZappySys API Driver
Download and install ZappySys ODBC PowerPack.
Search for gateway in start menu and Open ZappySys Data Gateway:
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:
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
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:ElasticSearchDSNElasticSearch
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.:ElasticSearchDSNDefault [Http]http://localhost:9200
Required Parameters Optional Parameters UserName Fill in the parameter... Password Fill in the parameter...
Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
Click OK to finish creating the data source
Read data in SSRS from ZappySys Data Gateway
- Open Visual Studio and create a new SSRS project
- Then add a new Shared Data Source (you can create a non-shared data source inside report too):
- Continue with creating the Shared Data Source. Select Microsoft SQL Server as Type and hit Build button to proceed further:
Once a window opens, configure it similarly. Configure "ElasticSearchDSN" as database name. Finally, hit Test Connection and OK:
- Another window opens, and it should look similarly to this one below which ends the creation of a Data Source:
- Now it's time to create a Dataset. If you don't have a report created, in one of the wizard's steps it will look like this:
- If you did not follow through report's creation wizard and already had report created, you can simply add a new dataset:
- Finally, once you complete the report, similar results show up:
Passing Parameters to SSRS Report / Filter dataIf you want to parameterized your report then refer to this article
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
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
Enter the desired Procedure name and click on OK:
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>>'
SELECT * FROM Orders where OrderDate >= '<@fromdate>'
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'
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 dont 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.
Go to Custom Objects Tab and Click on Add button and Select Add Table:
Enter the desired Table name and click on OK:
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
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
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"
ConclusionIn this article we discussed how to connect to ElasticSearch in SSRS and integrate data without any coding. Click here to Download ElasticSearch Connector for SSRS 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).
Other App Integration scenarios for ElasticSearch
Other API Connectors for SSRS
How to connect ElasticSearch in SSRS?
How to get ElasticSearch data in SSRS?
How to read ElasticSearch data in SSRS?
How to load ElasticSearch data in SSRS?
How to import ElasticSearch data in SSRS?
How to pull ElasticSearch data in SSRS?
How to push data to ElasticSearch in SSRS?
How to write data to ElasticSearch in SSRS?
How to POST data to ElasticSearch in SSRS?
Call ElasticSearch API in SSRS
Consume ElasticSearch API in SSRS
ElasticSearch SSRS Automate
ElasticSearch SSRS Integration
Integration ElasticSearch in SSRS
Consume real-time ElasticSearch data in SSRS
Consume realtime ElasticSearch API data in SSRS
ElasticSearch ODBC Driver | ODBC Driver for ElasticSearch | ODBC ElasticSearch Driver | SSIS ElasticSearch Source | SSIS ElasticSearch Destination
Connect ElasticSearch in SSRS
Load ElasticSearch in SSRS
Load ElasticSearch data in SSRS
Read ElasticSearch data in SSRS
ElasticSearch API Call in SSRS