Ready to get started?

Learn more about the CData JDBC Driver for Acumatica or download a free trial:

Download Now

Analyze Acumatica Data in R

Use standard R functions and the development environment of your choice to analyze Acumatica data with the CData JDBC Driver for Acumatica.

Access Acumatica data with pure R script and standard SQL on any machine where R and Java can be installed. You can use the CData JDBC Driver for Acumatica and the RJDBC package to work with remote Acumatica data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Acumatica and visualize Acumatica data by calling standard R functions.

Install R

You can match the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running open R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open 3.2.3, which is preconfigured to install packages from the Jan. 1, 2016 snapshot of the CRAN repository. This snapshot ensures reproducibility.

Load the RJDBC Package

To use the driver, download the RJDBC package. After installing the RJDBC package, the following line loads the package:

library(RJDBC)

Connect to Acumatica as a JDBC Data Source

You will need the following information to connect to Acumatica as a JDBC data source:

  • Driver Class: Set this to cdata.jdbc.acumatica.AcumaticaDriver
  • Classpath: Set this to the location of the driver JAR. By default this is the lib subfolder of the installation folder.

The DBI functions, such as dbConnect and dbSendQuery, provide a unified interface for writing data access code in R. Use the following line to initialize a DBI driver that can make JDBC requests to the CData JDBC Driver for Acumatica:

driver <- JDBC(driverClass = "cdata.jdbc.acumatica.AcumaticaDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.acumatica.jar", identifier.quote = "'")

You can now use DBI functions to connect to Acumatica and execute SQL queries. Initialize the JDBC connection with the dbConnect function.

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 sample dbConnect call, including a typical JDBC connection string:

conn <- dbConnect(driver,"jdbc:acumatica:Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/;User=user;Password=password;Company=CompanyName;")

Schema Discovery

The driver models Acumatica APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

dbListTables(conn)

Execute SQL Queries

You can use the dbGetQuery function to execute any SQL query supported by the Acumatica API:

events <- dbGetQuery(conn,"SELECT Id, location_displayname FROM Events")

You can view the results in a data viewer window with the following command:

View(events)

Plot Acumatica Data

You can now analyze Acumatica data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2)) barplot(events$location_displayname, main="Acumatica Events", names.arg = events$Id, horiz=TRUE)