Ready to get started?

Learn more about the CData JDBC Driver for Epicor ERP or download a free trial:

Download Now

Query Epicor ERP Data in ColdFusion

Write standard ColdFusion data access code to connect to Epicor ERP data.

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

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

      To successfully connect to your ERP instance, you must specify the following connection properties:

      • Url:the URL of the server hosting your ERP instance. For example, https://myserver.EpicorSaaS.com
      • ERPInstance: the name of your ERP instance.
      • User: the username of your account.
      • Password: the password of your account.
      • Service: the service you want to retrieve data from. For example, BaqSvc.

      In addition, you may also set the optional connection properties:

      • ApiKey: An optional key that may be required for connection to some services depending on your account configuration.
      • ApiVersion: Defaults to v1. May be set to v2 to use the newer Epicor API.
      • Company: Required if you set the ApiVersion to v2.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.epicorerp.jar

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

      A typical JDBC URL is below:

      jdbc:epicorerp:ervice=Erp.BO.CustomerSvc;ERPInstance=MyInstance;URL=https://myaccount.epicorsaas.com;User=username;Password=password;InitiateOAuth=GETANDREFRESH
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.epicorerp.EpicorERPDriver.
    • 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 Epicor ERP data source in the Actions column. After reporting a status of OK, the Epicor ERP data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Epicor ERP, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="EpicorERPQuery" dataSource="CDataEpicorERP"> SELECT * FROM Customers WHERE CompanyName = <cfqueryparam value="#CompanyName#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#EpicorERPQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Customers WHERE CompanyName = ?", 
  [
    { value="CompanyName", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataEpicorERP" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?CompanyName=CompanyName