Load Acumatica Data to a Database Using Embulk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Acumatica JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Acumatica account data including Accounts, Bills, Customers, Leads, and more!



Use CData JDBC Driver for Acumatica with the open source ETL/ELT tool Embulk to load Acumatica data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Acumatica, Embulk easily loads data from Acumatica to any supported destination. In this article, we explain how to use the CData JDBC Driver for Acumatica in Embulk to load Acumatica data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Acumatica data. When you issue complex SQL queries to Acumatica, the driver pushes supported SQL operations, like filters and aggregations, directly to Acumatica and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to Acumatica Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Acumatica\lib).

Embulk supports JDBC connectivity, so you can easily connect to Acumatica and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Acumatica.

Set the following connection properties to connect to Acumatica:

  • User: Set this to your username.
  • Password: Set this to your password.
  • Company: Set this to your company.
  • Url: Set this to your Acumatica URL, in the format http://{Acumatica ERP instance URL}/entity/{Endpoint name}/{Endpoint version}/.
    For example: https://acumatica.com/entity/Default/17.200.001/

See the Getting Started guide in the CData driver documentation for more information.

Built-in Connection String Designer

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

java -jar cdata.jdbc.acumatica.jar

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

Below is a typical JDBC connection string for Acumatica:

jdbc:acumatica:Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/;User=user;Password=password;Company=CompanyName;

Load Acumatica Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load Acumatica data into MySQL using Embulk.

Create a Job to Load Acumatica Data

Start by creating a config file in Embulk, using a name like acumatica-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for Acumatica, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.acumatica.AcumaticaDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (acumatica-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Acumatica 20xx\lib\cdata.jdbc.acumatica.jar driver_class: cdata.jdbc.acumatica.AcumaticaDriver url: jdbc:acumatica:Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/;User=user;Password=password;Company=CompanyName; table: "Events" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Events" mode: insert

After creating the file, run the Embulk job.

embulk run acumatica-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Acumatica Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Acumatica 20xx\lib\cdata.jdbc.acumatica.jar driver_class: cdata.jdbc.acumatica.AcumaticaDriver url: jdbc:acumatica:Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/;User=user;Password=password;Company=CompanyName; query: "SELECT Id, location_displayname FROM Events WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Events" mode: insert

More Information & Free Trial

By using CData JDBC Driver for Acumatica as a connector, Embulk can integrate Acumatica data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.