Query SAP ByDesign Data in ColdFusion

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

Create a JDBC Data Source for SAP ByDesign 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.

   👁 Adding a JDBC data source to ColdFusion. (Salesforce is shown.)
   

3. Populate the driver properties:

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

     Set the following connection properties to connect to SAP ByDesign.

     • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
     • User: Set this to the username of your account.
     • Password: Set this to the password of your account.
     • CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
       If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.sapbydesign.jar
     

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

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is below:

     jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;

   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.sapbydesign.SAPByDesignDriver.
   • 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 SAP ByDesign data source in the Actions column. After reporting a status of OK, the SAP ByDesign data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to SAP ByDesign. 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="SAPByDesignQuery" dataSource="CDataSAPByDesign">
 SELECT * FROM [Inventory Balance] WHERE ProductCategoryID = <cfqueryparam value="#ProductCategoryID#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#SAPByDesignQuery#">

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
 "SELECT * FROM [Inventory Balance] WHERE ProductCategoryID = ?", 
 [
 { value="1234567", cfsqltype="cf_sql_varchar" }
 ],
 { datasource="CDataSAPByDesign" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?ProductCategoryID=1234567