Ready to get started?

Learn more about Sage US Connectivity Solutions

Learn More

Connect to Sage US Data in DBVisualizer

Integrate Sage US data with visual data analysis tools and data connection wizards in DBVisualizer

The CData JDBC Driver for Sage US implements JDBC standards to provide connectivity to Sage US data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Sage US data in DBVisualizer and use the table editor to edit and save Sage US data.

Create a New JDBC Data Source for Sage US Data

Follow the steps below to use the Driver Manager to provide connectivity to Sage US data from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
  2. Enter a name for the data source.
  3. Enter the following in the URL Format box: jdbc:sage50us:
    The DBVisualizer Driver Manager.
  4. In the User Specified tab, click the Open File button and select the cdata.jdbc.sage50us.jar file, located in the lib subfolder of the installation directory.
  5. In the Driver Class menu, select the Sage50USDriver class, cdata.jdbc.sage50us.Sage50USDriver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

  1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.
  2. In the Connection section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:sage50us: followed by the connection properties in a semicolon-separated list of name-value pairs.

      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.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.sage50us.jar

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

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:sage50us:ApplicationId=8dfafu4V4ODmh1fM0xx;CompanyName=Bellwether Garden Supply - Premium;
    • Database UserId: The username to use to authenticate to Sage US.
    • Database Password: The password to use to authenticate to Sage US.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the Sage US JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.