How to integrate Neo4j with UiPath

Learn how to quickly and efficiently connect Neo4j with UiPath for smooth data access.

Read and write Neo4j data effortlessly. Query, integrate, and manage nodes, relationships, and graph data — almost no coding required. You can do it all using the high-performance Neo4j ODBC Driver for UiPath (often referred to as the Neo4j Connector). We'll walk you through the entire setup.

Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.

Prerequisites

Before we begin, make sure you meet the following prerequisite: Java Runtime Environment (JRE) or Java Development Kit (JDK) must be installed on your system.

• Minimum required version: Java 17
  • Amazon Corretto 17
  • Oracle JRE 17
• Recommended Java version: Java 21
  • Amazon Corretto 21
  • Oracle JRE 21

If your JDBC Driver targets a different Java version (e.g., 11 / 17 / 21), install the corresponding or newer Java version.

Download Neo4j JDBC driver

To connect to Neo4j in , you will have to download JDBC driver for it, which we will use in later steps. Let's perform these little steps right away:

1. Visit MVN Repository.
2. Download the JDBC driver, and save it locally, e.g. to E:\Drivers\JDBC\neo4j-jdbc-full-bundle.jar.
3. Done! That was easy, wasn't it? Let's proceed to the next step.

Create data source using Neo4j ODBC Driver

Step-by-step instructions

To get data from Neo4j using UiPath, we first need to create an ODBC data source. We will later read this data in UiPath. Perform these steps:

1. Download and install ODBC PowerPack (if you haven't already).

2. Search for odbc and open the ODBC Data Sources (64-bit):

   

3. Create a User data source (User DSN) based on the ZappySys JDBC Bridge Driver driver:

   ZappySys JDBC Bridge Driver

   
   • Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
   • Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this

4. Now, we need to configure the JDBC connection in the new ODBC data source. Simply enter the Connection string, credentials, configure other settings, and then click Test Connection button to test the connection:

   Neo4jDSN

   jdbc:neo4j://neo4j-instance-host-name:7687?enableSQLTranslation=true

   E:\Drivers\JDBC\neo4j-jdbc-full-bundle.jar

   neo4j

   ***************

   []

   

   For Non-SSL Connection (SQL queries), use these values when setting parameters:

   • Connection string: jdbc:neo4j://neo4j-instance-host-name:7687?enableSQLTranslation=true
   • JDBC driver file(s): E:\Drivers\JDBC\neo4j-jdbc-full-bundle.jar
   • User name: neo4j
   • User password: ***************
   • Connection parameters: []

     Use enableSQLTranslation=true attribute in the connection string to query Neo4j database using SQL queries, e.g.:

     SELECT * FROM Movie

   For Non-SSL Connection (Cypher queries), use these values when setting parameters:

   • Connection string: jdbc:neo4j://neo4j-instance-host-name:7687

     Excluding enableSQLTranslation=true from the connection allows you to query Neo4j database using Cypher queries, e.g.:

     MATCH (m:Movie) RETURN m.title AS Movie

   For SSL Connection (SQL queries), use these values when setting parameters:

   • Connection string: jdbc:neo4j+s://neo4j-instance-host-name:7687?enableSQLTranslation=true

   For SSL Connection (Cypher queries), use these values when setting parameters:

   • Connection string: jdbc:neo4j+s://neo4j-instance-host-name:7687

   For Neo4j AuraDB Connection (SQL queries), use these values when setting parameters:

   • Connection string: jdbc:neo4j+s://1234abcd.databases.neo4j.io?enableSQLTranslation=true

   For Neo4j Aura Connection (Cypher queries), use these values when setting parameters:

   • Connection string: jdbc:neo4j+s://1234abcd.databases.neo4j.io

5. You should see a message saying that connection test is successful:

   

   Otherwise, if you are getting an error, check out our Community for troubleshooting tips.

6. We are at the point where we can preview a SQL query. For more SQL query examples visit JDBC Bridge documentation:

   Neo4jDSN

   SELECT * FROM Movie

   

   SELECT * FROM Movie

   You can also click on the <Select Table> dropdown and select a table from the list.

   The ZappySys JDBC Bridge Driver acts as a transparent intermediary, passing SQL queries directly to the JDBC driver, which then handles the query execution. This means the Bridge Driver simply relays the SQL query without altering it.

   Some JDBC drivers don't support INSERT/UPDATE/DELETE statements, so you may get an error saying "action is not supported" or a similar one. Please, be aware, this is not the limitation of ZappySys JDBC Bridge Driver, but is a limitation of the specific JDBC driver you are using.

7. Click OK to finish creating the data source.

Video Tutorial

Read Neo4j data in UiPath Studio (workstation)

Here we will be reading Neo4j 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:

   Neo4jDSN

   Neo4jDSN

   
   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 Neo4j 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 Neo4j data:

Optional: Centralized data access via ZappySys Data Gateway

In some situations, you may need to provide Neo4j data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

• Centralized data access
  The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
• Centralized access control
  Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in UiPath (client-side) to connect to it.

Let's not wait and get going!

Create Neo4j data source in the gateway

In this section we will create a data source for Neo4j in the Data Gateway. Let's follow these steps to accomplish that:

1. Search for gateway in the Windows Start Menu and open ZappySys Data Gateway Configuration:

   

2. Go to the Users tab and follow these steps to add a Data Gateway user:

   • Click the Add button
   • In the Login field enter a username, e.g., john
   • Then enter a Password
   • Check the Is Administrator checkbox
   • Click OK to save
   

3. Now we are ready to add a data source:

   • Click the Add button
   • Give the Data source a name (have it handy for later)
   • Then select Native - ZappySys JDBC Bridge Driver
   • Finally, click OK
   Neo4jDSN

   ZappySys JDBC Bridge Driver

   

4. When the ZappySys JDBC Bridge Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the Neo4j ODBC data source created and configured, and follow these steps on how to Import data source configuration into the Gateway:

   • Open ODBC data source configuration and click Copy settings:
     

     ZappySys JDBC Bridge Driver - Configuration [Version: 2.0.1.10418]

     ZappySys JDBC Bridge Driver - Neo4j

     Read and write Neo4j data effortlessly. Query, integrate, and manage nodes, relationships, and graph data — almost no coding required.

     Neo4jDSN

     
   • The window opens, telling us the connection string was successfully copied to the clipboard:

   • Then go to Data Gateway configuration and in data source configuration window click Load settings:

     Neo4jDSN

     

     ZappySys JDBC Bridge Driver - Configuration [Version: 2.0.1.10418]

     ZappySys JDBC Bridge Driver - Neo4j

     Read and write Neo4j data effortlessly. Query, integrate, and manage nodes, relationships, and graph data — almost no coding required.

     Neo4jDSN

     
   • Once a window opens, just paste the settings by pressing CTRL+V or by clicking right mouse button and then Paste option.

5. Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:

   
   • This will initially allow all inbound traffic.
   • Click Edit IP filters to restrict access to specific IP addresses or ranges.

6. Crucial Step: After creating or modifying the data source, you must:

   • Click the Save button to persist your changes.
   • Hit Yes when prompted to restart the Data Gateway service.

   This ensures all changes are properly applied:

   
   Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.

Create ODBC data source to connect to the gateway

In this part we will create an ODBC data source to connect to the ZappySys Data Gateway from UiPath. To achieve that, let's perform these steps:

1. Search for odbc and open the ODBC Data Sources (64-bit):

   

2. Create a User data source (User DSN) based on the ODBC Driver 17 for SQL Server driver:

   ODBC Driver 17 for SQL Server

   
   If you don't see the ODBC Driver 17 for SQL Server driver in the list, choose a similar version.

3. Then set a Name for the data source (e.g. Gateway) and the address of the Data Gateway:

   ZappySysGatewayDSN

   localhost,5000

   
   Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

4. Proceed with the authentication part:

   • Select SQL Server authentication
   • In the Login ID field enter the user name you created in the Data Gateway, e.g., john
   • Set Password to the one you configured in the Data Gateway
   

5. Then set the default database property to Neo4jDSN (the one we used in the Data Gateway):

   Neo4jDSN

   Neo4jDSN

   
   Make sure to type the data source name manually or copy/paste it directly into the field. Using the dropdown might fail because the Trust server certificate option is not enabled yet (next step).

6. Continue by checking the Trust server certificate option:

   

7. Once you do that, test the connection:

   

8. If the connection is successful, everything is good:

   

9. Done!

We are ready to move to the final step. Let's do it!

Access data in UiPath via the gateway

Finally, we are ready to read data from Neo4j in UiPath via the Data Gateway. Follow these final steps:

1. Go back to UiPath.

2. Add Run Query activity in Main Sequence box:

   

3. Click Configure Connection... button to create an ODBC connection:

   

4. Continue by clicking Connection Wizard:

   

5. When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:

   ZappySysGatewayDSN

   ZappySysGatewayDSN

   
   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.

6. Read the data the same way we discussed at the beginning of this article.

7. That's it!

Now you can connect to Neo4j data in UiPath via the Data Gateway.

Troubleshooters & resources (JDBC Bridge Driver)

Below are some useful community articles to help you troubleshoot and configure the ZappySys JDBC Bridge Driver:

• How to combine multiple JAR files
  Learn how to merge multiple .jar dependencies when your JDBC driver requires more than one file.
• How to fix JBR error: “Data lake is not available / Unable to verify trust for server certificate chain”
  Resolve SSL or certificate validation issues encountered during JDBC connections.
• System Exception: “Java is not installed or not accessible”
  Fix Java path or environment issues that prevent the JDBC Bridge from launching Java.
• JDBC Bridge Driver disconnect from Java host error
  Troubleshoot unexpected disconnection problems between SSIS and the Java process.
• Error: Could not open jvm.cfg while using JDBC Bridge Driver
  Resolve JVM configuration path errors during driver initialization.
• How to enable JDBC Bridge Driver logging
  Enable detailed driver logging for better visibility during troubleshooting.
• How to pass JDBC connection parameters (not by URL)
  Learn how to specify connection properties programmatically instead of embedding them in the JDBC URL.
• How to fix JDBC Bridge error: “No connection could be made because the target machine actively refused it”
  Troubleshoot firewall or local port binding issues preventing communication with the Java host.
• How to use JDBC Bridge options (System Property for Java command line, e.g., classpath, proxy)
  Configure custom Java options like classpath and proxy using JDBC Bridge system properties.

Conclusion

In this article we showed you how to connect to Neo4j in UiPath and integrate data without writing complex code — all of this was powered by Neo4j ODBC Driver. It's worth noting that ZappySys JDBC Bridge Driver allows you to connect not only to Neo4j, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

Download ODBC PowerPack now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

Explore UiPath connectors

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

Dropbox

DuckDB (Parquet)

ElasticSearch

FastSpring

Gmail

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Search Console

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManageEngine ServiceDesk Plus (Zoho)

MariaDB

MySQL

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

More Neo4j integrations

SSIS

SQL Server

Microsoft Fabric

Power BI

SSRS

Informatica PowerCenter

MS Access

Excel

SSAS

C#

Python

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

PowerShell

Alteryx

ODBC