Query Sage 300 Data in ColdFusion

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

Create a JDBC Data Source for Sage 300 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:sage300: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

     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.

     A typical JDBC URL is below:

     jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;
   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.sage300.Sage300Driver.
   • 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 300 data source in the Actions column. After reporting a status of OK, the Sage 300 data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Sage 300. 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.

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
  "SELECT * FROM OEInvoices WHERE AllowPartialShipments = ?", 
  [
    { value="Yes", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataSage300" }
);

writeDump( var= result );
</cfscript> 

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