Load Samanage Data to a Database Using Embulk

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

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

Configure a JDBC Connection to Samanage 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 API Driver for JDBC\lib).

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

Start by setting the Profile connection property to the location of the Samanage Profile on disk (e.g. C:\profiles\Samanage.apip). Next, set the ProfileSettings connection property to the connection string for Samanage (see below).

Samanage API Profile Settings

Navigate to Setup > Users in Samanage, click your username, and select Generate JSON Web Token from the Action dropdown.

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

Below is a typical JDBC connection string for Samanage:

jdbc:api:Profile=C:\profiles\Samanage.apip;ProfileSettings='APIKey=your_api_key';

Load Samanage 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

embulk gem install embulk-input-jdbc

2. 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 Samanage data into MySQL using Embulk.

Create a Job to Load Samanage Data

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

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

Sample Config File (api-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.api.jar
	driver_class: cdata.jdbc.api.APIDriver
	url: jdbc:api:Profile=C:\profiles\Samanage.apip;ProfileSettings='APIKey=your_api_key';
	table: "Audits"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Audits"
	mode: insert

After creating the file, run the Embulk job.

embulk run api-mysql.yml

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

Load Filtered Samanage 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[product_name] 20xx\lib\cdata.jdbc.api.jar
	driver_class: cdata.jdbc.api.APIDriver
	url: jdbc:api:Profile=C:\profiles\Samanage.apip;ProfileSettings='APIKey=your_api_key';
	query: "SELECT Id, Messages FROM Audits WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Audits"
	mode: insert

More Information & Free Trial

By using CData API Driver for JDBC as a connector, Embulk can integrate Samanage 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.