Analyze SAP ByDesign Data in R via JDBC

Access SAP ByDesign 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 SAP ByDesign and the RJDBC package to work with remote SAP ByDesign 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 SAP ByDesign and visualize SAP ByDesign 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 SAP ByDesign as a JDBC Data Source

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

• Driver Class: Set this to cdata.jdbc.sapbydesign.SAPByDesignDriver
• 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 SAP ByDesign:

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

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

Set the following connection properties to connect to SAP ByDesign.

• Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
• User: Set this to the username of your account.
• Password: Set this to the password of your account.
• CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
  If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sapbydesign.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:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;")

Schema Discovery

The driver models SAP ByDesign 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 SAP ByDesign API:

[inventory balance] <- dbGetQuery(conn,"SELECT ID, ProductCategoryID FROM [Inventory Balance] WHERE ProductCategoryID = '1234567'")

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

View([inventory balance])

Plot SAP ByDesign Data

You can now analyze SAP ByDesign 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([inventory balance]$ProductCategoryID, main="SAP ByDesign [Inventory Balance]", names.arg = [inventory balance]$ID, horiz=TRUE)