Query Sage US Data in MySQL Workbench

Ready to get started?

Learn more:

Sage US Connectivity Solutions

Execute MySQL queries against live Sage US data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for Sage US to query Sage US data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Sage US data in MySQL Workbench.

Connect to Sage US Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

The Application Id and Company Name connection string options are required to connect to Sage as a data source. You can obtain an Application Id by contacting Sage directly to request access to the Sage 50 SDK.

Sage must be installed on the machine. The Sage.Peachtree.API.dll and Sage.Peachtree.API.Resolver.dll assemblies are required. These assemblies are installed with Sage in C:\Program Files\Sage\Peachtree\API\. Additionally, the Sage SDK requires .NET Framework 4.0 and is only compatible with 32-bit applications. To use the Sage SDK in Visual Studio, set the Platform Target property to "x86" in Project -> Properties -> Build.

You must authorize the application to access company data: To authorize your application to access Sage, restart the Sage application, open the company you want to access, and connect with your application. You will then be prompted to set access permissions for the application in the resulting dialog.

While the compiled executable will require authorization only once, during development you may need to follow this process to reauthorize a new build. To avoid restarting the Sage application when developing with Visual Studio, click Build -> Configuration Manager and uncheck "Build" for your project.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Sage US data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Sage US from MySQL Workbench

The steps below outline connecting to the virtual Sage US database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Sage US data.

Connect to Sage US through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Sage US).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Sage US Data

  1. Open the connection you just created (CData SQL Gateway for Sage US).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Sage US data, like SELECT * FROM `CData Sage50US Sys`.Customer;

With access to live Sage US data from MySQL Workbench, you can easily query and update Sage US, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Sage US and the CData SQL Gateway.