ElasticSearch Connector for UiPath Read / write ElasticSearch data inside your app; perform many ElasticSearch operations without coding, just use easy to use high performance API Connector for ElasticSearch In this article you will learn how to quickly and efficiently integrate ElasticSearch data in UiPath without coding. We will use high-performance ElasticSearch Connector to easily connect to ElasticSearch and then access the data inside UiPath. Let's follow the steps below to see how we can accomplish that! Download Documentation ElasticSearch Connector for UiPath is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.

Connect to ElasticSearch in other apps Connect to ElasticSearch in SSIS Connect to ElasticSearch in SQL Server Connect to ElasticSearch in Power BI Connect to ElasticSearch in SSRS Connect to ElasticSearch in Informatica Connect to ElasticSearch in MS Access Connect to ElasticSearch in MS Excel Connect to ElasticSearch in SSAS Connect to ElasticSearch in C# Connect to ElasticSearch in Python Connect to ElasticSearch in JAVA Connect to ElasticSearch in Tableau Connect to ElasticSearch in SAP Crystal Reports Connect to ElasticSearch in Azure Data Factory (Pipeline) Connect to ElasticSearch in Azure Data Factory (SSIS) Connect to ElasticSearch in Talend Studio Connect to ElasticSearch in PowerShell Connect to ElasticSearch in ODBC

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

Step-by-step instructions

To get data from ElasticSearch using UiPath we first need to create a DSN (Data Source) which will access data from ElasticSearch. We will later be able to read data using UiPath. Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. Create a User data source (User DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
   • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.

4. When the Configuration window appears 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 location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   ElasticsearchDSN

   ElasticSearch

   

5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Basic Authentication (UserId/Password) [Http]

   Steps how to get and use ElasticSearch credentials
   

   For Local / Hosted Instance by you

   1. Get your userid / password and enter on the connection UI

   For Managed Instance (By Bonsai search)

   If your instance is hosted by bonsai then perform these steps to get your credentials for API call

   1. Go to https://app.bonsai.io/clusters/{your-instance-id}/tokens
   2. Copy Access Key and Access Secret and enter on the connection UI. Click Test connection.
   3. If your Cluster has no data you can generate sample data by visiting this URL and click Add Sample Data https://{your-cluster-id}.apps.bonsaisearch.net/app/home#/tutorial_directory

   Fill in all required parameters and set optional parameters if needed:

   ElasticsearchDSN

   ElasticSearch

   Basic Authentication (UserId/Password) [Http]

   http://localhost:9200

   Optional Parameters
   User Name (or Access Key)
   Password (or Access Secret)
   Ignore certificate related errors

   

    Windows Authentication (No Password) [Http]

   Fill in all required parameters and set optional parameters if needed:

   ElasticsearchDSN

   ElasticSearch

   Windows Authentication (No Password) [Http]

   http://localhost:9200

   Optional Parameters
   Ignore certificate related errors

   

6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   ZappySys API Driver - 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

   ElasticsearchDSN

   

7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in UiPath to retrieve data from ElasticSearch. Hit OK button to use this query in the next step.

   SELECT * FROM Indexes

   
   Some parameters configured in this window will be passed to the ElasticSearch API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in UiPath:

   

   ZappySys API Driver - 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

   ElasticsearchDSN

   SELECT * FROM Indexes

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the ElasticSearch API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in ElasticSearch servers).

9. Click OK to finish creating the data source.

Video Tutorial

Read ElasticSearch data in UiPath Studio (workstation)

Here we will be reading ElasticSearch data on your workstation. To accomplish that we will create and run UiPath process package locally. Later on, we'll explore how to publish the package to Orchestrator and run it remotely. For now, let's focus on working locally and get started!

1. Open UiPath Studio.
2. Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).
3. In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings: Simply select UiPath Studio option:
4. Start by creating a new project based on UiPath Process template:
5. Add Run Query activity in Main Sequence box:
6. Click Configure Connection... button to create an ODBC connection:
7. Continue by clicking Connection Wizard:
8. When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:
   ElasticsearchDSN

   ElasticsearchDSN

   
   You can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration.
9. Once you do that, it's time to configure a SQL query:
   Make sure, you enclose the query in double quotes!
10. Proceed by adding a Write CSV activity after Run Query:
    In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel.
11. Once you do that, configure the added Write CSV, this will write ElasticSearch data to a CSV file:
12. It's time for fun! Which means it's time for debugging! Just run the package locally to debug:
13. Finally, ensure there are no execution errors!

Run UiPath package using Orchestrator (via robot)

UiPath also offers the ability to execute packages remotely using Orchestrator and a robot. This is achieved by publishing the package to UiPath Orchestrator, installing UiPath Assistant on the remote machine, connecting it to Orchestrator, enabling us to run the package remotely. It may sound complicated at first glance, but further steps will clear things out. Let's not waste our precious time and delve into the details!

Publish process package from UiPath Studio

1. First of all, open the UiPath process package we created in the previous step
2. Set the option that our process package Starts in Background:
3. We are ready to Publish it:
4. Make sure, you publish it to the Shared folder in UiPath Orchestrator Tenant workspace:
5. Finally, success! We are ready for the next step - creating UiPath robot - so we can automate the job:

Create robot in UiPath Orchestrator

1. First of all, let's open UiPath Orchestrator from UiPath Automation Cloud console:
2. It's time to create a robot, which will run unattended packages:
3. But first we have to create a runtime. Choose to host our robot on-premise, not in UiPath infrastructure:
4. Let's move along and Create new machine template, this will create a machine in UiPath Orchestrator:
5. Configure the machine to run in Production environment:
6. We are ready to Create new robot account in the new machine:
7. Let's make our robot to work only on background automations:
8. Continue by selecting newly created robot:
9. Select Shared folder, so that everyone in the team can benefit from it:
   This is the folder where we published our UiPath process package "MyProcess"
10. We are almost done! We are given machine Client ID and Client secret which we will use to connect UiPath Assistant to our created machine in Orchestrator. Let's leave this open for a while and see how we can do it in the next step.

Connect UiPath Assistant to Orchestrator

We are ready to connect UiPath Assistant to the machine we created in Orchestrator. UiPath Assistant will run our package in a remote machine. Let's connect it and give it some work!

1. Connect to a remote machine (where your UiPath process package will be running).
2. Install UiPath Studio there.
3. Then configure ODBC data source:

   If you chose Use user or system data source option in connection configuration, when creating UiPath process package, then create an identical ODBC data source on the same remote machine. Use the same configuration as the one created in your workstation in the first step.

   Use Copy Settings and Load Settings buttons to make your life easier. They will help you to transfer settings between different ODBC data sources.

   If you chose Use connection string option, then you don't have to do anything. However, you still have to install ODBC PowerPack on the remote machine.

4. Continue by opening UiPath Assistant and going to Preferences:
5. Find Orchestrator Settings menu item and click it:
6. And here even bigger fun begins! But fear not, all you have to do is open your web browser window with Client ID & Client secret we obtained in the previous step and simply copy and paste those values into UiPath Assistant. Also, don't forget to configure Orchestrator URL:
7. Finally, we get rewarded for the hard work with the Connected as Unattended status:

Create and run UiPath process in Orchestrator

We are at the finish line! Let's create and run UiPath process. This will execute the package on your remote machine using the UiPath Assistant configured earlier.

1. First of all, open UiPath Orchestrator from UiPath Automation Cloud console.
2. Then proceed by going to Process in Shared folder:
3. Continue by simply clicking on Add process button:
4. Select the process package we created in UiPath Studio:
5. Rest a while, and just hit Next, unless your package has requirements:
6. Then simply hit Create button:
7. But let's not stop here and Start the process by creating a job right away:
8. Use the same Production runtime we created before and hit Start:
9. We've reached the final step! In the CSV destination file or destination of your choice you should see ElasticSearch data:

Actions supported by ElasticSearch Connector

Learn how to perform common ElasticSearch actions directly in UiPath with these how-to guides:

• Count documents
• Create Index
• Delete documents
• Delete Index
• Get document by ID from Index or Alias
• Get documents from Index or Alias
• Get Index or Alias metadata
• Insert documents
• List aliases
• List indexes
• Search / Query documents
• Update documents
• Upsert documents
• Generic Request
• Generic Request (Bulk Write)

Conclusion

In this article we showed you how to connect to ElasticSearch in UiPath and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to ElasticSearch, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download ElasticSearch Connector for UiPath and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download ElasticSearch Connector for UiPath Documentation

More integrations

Other connectors for UiPath

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

DropBox

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for ElasticSearch

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

PowerShell

ODBC

Common Searches: