Connect to Odoo Data in DigitalSuite Studio through RunMyProcess DSEC



Use Arkobi Digital's low-code cloud native platform RunMyProcess's DigitalSuite EnterpriseConnect (DSEC) to connect to Odoo.

The CData JDBC Driver for Odoo implements JDBC Standards and enables a applications ranging from BI to IDE to connect with Odoo. In this article, we describe how to connect to Odoo data from Arkobi Digital RunMyProcess's DSEC and connect to Odoo in RunMyProcess.

About Odoo Data Integration

Accessing and integrating live data from Odoo has never been easier with CData. Customers rely on CData connectivity to:

  • Access live data from both Odoo API 8.0+ and Odoo.sh Cloud ERP.
  • Extend the native Odoo features with intelligent handling of many-to-one, one-to-many, and many-to-many data properties. CData's connectivity solutions also intelligently handle complex data properties within Odoo. In addition to columns with simple values like text and dates, there are also columns that contain multiple values on each row. The driver decodes these kinds of values differently, depending upon the type of column the value comes from:
    • Many-to-one columns are references to a single row within another model. Within CData solutions, many-to-one columns are represented as integers, whose value is the ID to which they refer in the other model.
    • Many-to-many columns are references to many rows within another model. Within CData solutions, many-to-many columns are represented as text containing a comma-separated list of integers. Each value in that list is the ID of a row that is being referenced.
    • One-to-many columns are references to many rows within another model - they are similar to many-to-many columns (comma-separated lists of integers), except that each row in the referenced model must belong to only one in the main model.
  • Use SQL stored procedures to call server-side RFCs within Odoo.

Users frequently integrate Odoo with analytics tools such as Power BI and Qlik Sense, and leverage our tools to replicate Odoo data to databases or data warehouses.


Getting Started


Setting up EnterpriseConnect Agent

Configure the EnterpriseConnect Agent following the EnterpriseConnect page in the RunMyProcess documentation.

Setting up JDBC Adapter

The JDBC Adapter section describes the steps to connect to RDBMS through JDBC. Follow the steps and open the JDBC.config file.

  1. Create a JSON entry for the CData JDBC Driver for Odoo, e.g. Odoo = { "sqlDriver" : "...", "sqlSource" : "...", "sqlDriverPath" : "..." }
  2. Set the "sqlDriver" field to the Class name for the CData JDBC Driver, e.g.
    cdata.jdbc.odoo.OdooDriver
  3. Set the "sqlSource" field to a JDBC URL for connecting to Odoo, e.g.
    jdbc:odoo:User=MyUser;Password=MyPassword;URL=http://MyOdooSite/;Database=MyDatabase;

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Odoo JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.odoo.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    To connect, set the Url to a valid Odoo site, User and Password to the connection details of the user you are connecting with, and Database to the Odoo database.

  4. Set the "sqlDriverPath" field to the name of the CData JDBC Driver JAR file, e.g.
    cdata.jdbc.odoo.jar

Sample JDBC.config File

#DBAgent Configuration Odoo = {"sqlDriver" : "cdata.jdbc.odoo.OdooDriver", "sqlSource" = "jdbc:odoo:User=MyUser;Password=MyPassword;URL=http://MyOdooSite/;Database=MyDatabase;","sqlDriverPath" = "cdata.jdbc.odoo.jar" }

Put the JDBC driver JAR file (cdata.jdbc.odoo.jar) into the same directory as unified-adapter-[version].jar.

Note: Make sure to put the CData license file (cdata.jdbc.odoo.lic) into the same directory. Since the license is generated based on the unique identifier of the machine where the product in installed, you will need an offline activation if you want to put the file on another machine.

Starting DigitalSuite EnterpriseConnect Agent

In Windows, start RunMyProcess DigitalSuite EnterpriseConnect Agent in Windows services. To start the application through command line, see Starting the EnterpriseConnect Agent in the RunMyProcess documents.

Starting the JDBC Adapter

Start the JDBC Adapter from runAdapter.bat. Once the Adapter is running, you can access the application through the agent address (e.g. 127.0.0.1:8080). Below is an example executing the command in Windows.

... > java -Djava.util.logging.config.file=./log.properties -cp lib/* org.runmyprocess.sec2.AdapterHandler : 2021-06-09 14:37:58|INFO|correlationId=|Searching for config file... 2021-06-09 14:37:58|INFO|correlationId=|Adapter Handler started with [JDBC] configuration 2021-06-09 14:37:59|INFO|correlationId=|agent address: 127.0.0.1:8080 2021-06-09 14:38:00.251:INFO::ConnectionThread: Logging initialized @1820ms to org.eclipse.jetty.util.log.StdErrLog 2021-06-09 14:38:00|INFO|correlationId=|onConnect() websocket connection between Agent and Adapter established

Once the DigitalSuite EnterpriseConnect Agent and JDBC Adapter are running, access http://localhost:(specified-port-number)/ through your browser to open the page shown below.

Check the availability of the JDBC Adapter using tools such as Postman or cURL. Here, we use Postman to send the HTTP POST request.

Configure the RequestHeader as follows:

Content-Type application/json

Configure the RequestBody as follows:

{ "protocol":"JDBC", "data":{ "DBType":"Odoo", "sqlUsername":"", "sqlPassword":"", "sqlStatement":"SELECT * FROM res_users" } }

If the JDBC.config file contains credential information, sqlUsername and sqlPassword can be left empty. If you are not sure of the table name, you can retrieve the list of tables using the request SELECT * FROM sys_tables

The request is successful if the Status is 200 and the Body contains Odoo data in JSON format.

Connect to Odoo through DSEC Agent in DigitalSuite Studio

Create a DigitalSuite Studio project and then create a Provider in the project.

  • URL: The URL for accessing JDBC Agent (e.g. http:localhost:8080/)
  • Authentication Scheme: Login/password
  • Login: The value from agent.user in the application.properties file
  • Password: agent.password in the application.properties file
  • Secured: Checked
  • Use DigitalSuite EnterpriseConnect: Checked
  • With domain: The value from agent.domain in application.properties file

Next, create a Connector in the Provider.

  • Connector URL: Leave this empty
  • Architecture: REST/XML-RPC
  • Method: POST
  • Result format: JSON
  • Accept media type: application/json
  • Character set: Automatic
  • Content: Same as the Request body used in the JDBC Adapter
  • Content type: application/json

The JSON data we used as the Request body in JDBC Adapter:

{ "protocol":"JDBC", "data":{ "DBType":"Odoo", "sqlUsername":"", "sqlPassword":"", "sqlStatement":"SELECT * FROM res_users" } }

Open Launch Test to perform the test. The test is successful if Odoo data is shown in Result on the right pane.

Now you can use Odoo data in RunMyProcess DigitalSuite Studio through DSEC.

For the detailed information on supported SQL commands, refer to the SQL Compliance section in our help documentation. For information on tables, refer to the Data Model section.

Ready to get started?

Download a free trial of the Odoo Driver to get started:

 Download Now

Learn more:

Odoo Icon Odoo JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Odoo ERP data, including Sales Orders, Purchase Orders, Accounts, and more!