Query Sage 200 Data in ColdFusion



Write standard ColdFusion data access code to connect to Sage 200 data.

The CData JDBC driver for Sage 200 seamlessly integrates connectivity to Sage 200 data with the rapid development tools in ColdFusion. This article shows how to connect to Sage 200 data in ColdFusion and query Sage 200 tables.

Create a JDBC Data Source for Sage 200 in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:sage200: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      • Schema: Determines which Sage 200 edition you are connecting to. Specify either StandardUK or ProfessionalUK.
      • Subscription Key: Provides access to the APIs that are used to establish a connection. You will first need to log into the Sage 200 API website and subscribe to the API edition that matches your account. You can do so here: https://developer.columbus.sage.com/docs/services/api/uk. Afterwards, the subscription key may be found in your profile after logging into Sage 200.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.sage200.jar

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

      A typical JDBC URL is below:

      jdbc:sage200:SubscriptionKey=12345;Schema=StandardUK;InitiateOAuth=GETANDREFRESH
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.sage200.Sage200Driver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Sage 200 data source in the Actions column. After reporting a status of OK, the Sage 200 data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Sage 200. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="Sage200Query" dataSource="CDataSage200"> SELECT * FROM Banks WHERE Code = <cfqueryparam value="#Code#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#Sage200Query#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Banks WHERE Code = ?", 
  [
    { value="12345", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataSage200" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?Code=12345

Ready to get started?

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

 Download Now

Learn more:

Sage 200 Icon Sage 200 JDBC Driver

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