Ready to get started?

Download a free trial of the Sage 300 Driver to get started:

 Download Now

Learn more:

Sage 300 Icon Sage 300 JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Sage 300.

Load Sage 300 Data to a Database Using Embulk



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

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

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

Configure a JDBC Connection to Sage 300 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 Sage 300\lib).

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

Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

  • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
  • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
  • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

Authenticate to Sage 300 using Basic authentication.

Connect Using Basic Authentication

You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.

  • Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sage300.jar

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

Below is a typical JDBC connection string for Sage 300:

jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;

Load Sage 300 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 Sage 300 data into MySQL using Embulk.

Create a Job to Load Sage 300 Data

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

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

Sample Config File (sage300-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Sage 300 20xx\lib\cdata.jdbc.sage300.jar driver_class: cdata.jdbc.sage300.Sage300Driver url: jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC; table: "OEInvoices" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "OEInvoices" mode: insert

After creating the file, run the Embulk job.

embulk run sage300-mysql.yml

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

Load Filtered Sage 300 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 Sage 300 20xx\lib\cdata.jdbc.sage300.jar driver_class: cdata.jdbc.sage300.Sage300Driver url: jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC; query: "SELECT InvoiceUniquifier, ApprovedLimit FROM OEInvoices WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "OEInvoices" mode: insert

More Information & Free Trial

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