Ready to get started?

Learn more about Sage US Connectivity Solutions

Learn More

Build Sage US-Connected Web Apps in Servoy

Use Servoy Developer to easily connect to Sage US data and build web apps with connectivity to live Sage US data.

Servoy is a rapid application development and deployment platform. When paired with the CData JDBC Driver for Sage US, users can build Sage US-connected apps that work with live Sage US data. This article describes how to connect to Sage US from Servoy and build a simple web app to display and search Sage US data.

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

Connect to Sage US in Servoy Developer

To build Sage US-connected apps, you need to first create a data provider in Servoy Developer using the CData JDBC Driver for Sage US.

  1. Install the JDBC Driver.
  2. Copy the JDBC Driver JAR file. (cdata.jdbc.sage50us.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
  3. Open Servoy Developer.
  4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
    1. Name the server.
    2. Click to show the advanced server settings.
      • Set the URL, for example: jdbc:sage50us:ApplicationId=8dfafu4V4ODmh1fM0xx;CompanyName=Bellwether Garden Supply - Premium;

        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.

        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.

      • Select the Driver class you just copied, for example, cdata.jdbc.sage50us.Sage50USDriver

Build a Sage US-Connected Web App

Once you have configured the connection to Sage US in the Servoy Developer resources, you are ready to build apps with access to live Sage US data.

Create a New Solution

  1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
  2. Name the solution.
  3. Select the checkbox to include the "search" module.
  4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

  1. Name the form.
  2. Select a Datasource.
  3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

  1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.
  2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the Sage US "table" (e.g., Name from the Customer table).

    Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

  1. Drag a Text Field component onto the Form.
  2. Right-click the Form and select "Open in Script Editor."
  3. Create a new variable (JavaScript) to hold the search value:
    var searchText = '';
    
  4. Back on the Form, in the Text Field properties:
    1. Set the "dataprovider" property to the Form variable you just created.
    2. Double-click to add a method for the onAction event.
    3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
    4. Click "OK & Show."
  5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:
    var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
    search.setSearchAllColumns();
    search.loadRecords(foundset);
    

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData JDBC Driver for Sage US and start building Sage US-connected apps with Servoy. Reach out to our Support Team if you have any questions.