Query SAP Ariba Source Data in ColdFusion

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

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

     In order to connect with SAP Ariba Source, set the following:

     • API: Specify which API you would like the provider to retrieve SAP Ariba data from. Select the Supplier, Sourcing Project Management, or Contract API based on your business role (possible values are SupplierDataAPIWithPaginationV4, SourcingProjectManagementAPIV2, or ContractAPIV1).
     • DataCenter: The data center where your account's data is hosted.
     • Realm: The name of the site you want to access.
     • Environment: Indicate whether you are connecting to a test or production environment (possible values are TEST or PRODUCTION).

     If you are connecting to the Supplier Data API or the Contract API, additionally set the following:

     • User: Id of the user on whose behalf API calls are invoked.
     • PasswordAdapter: The password associated with the authenticating User.

     If you're connecting to the Supplier API, set ProjectId to the Id of the sourcing project you want to retrieve data from.

     Authenticating with OAuth

     After setting connection properties, you need to configure OAuth connectivity to authenticate.

     • Set AuthScheme to OAuthClient.
     • Register an application with the service to obtain the APIKey, OAuthClientId and OAuthClientSecret.

       For more information on creating an OAuth application, refer to the Help documentation.

     Automatic OAuth

     After setting the following, you are ready to connect:

     APIKey: The Application key in your app settings. OAuthClientId: The OAuth Client Id in your app settings. OAuthClientSecret: The OAuth Secret in your app settings.

     When you connect, the provider automatically completes the OAuth process:

     1. The provider obtains an access token from SAP Ariba and uses it to request data.
     2. The provider refreshes the access token automatically when it expires.
     3. The OAuth values are saved in memory relative to the location specified in OAuthSettingsLocation.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.saparibasource.jar

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

     A typical JDBC URL is below:

     jdbc:saparibasource:API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH
   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.saparibasource.SAPAribaSourceDriver.
   • 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 Ariba Source data source in the Actions column. After reporting a status of OK, the SAP Ariba Source data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to SAP Ariba Source, including INSERT, UPDATE, and DELETE.. 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 Vendors WHERE Region = ?", 
  [
    { value="USA", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataSAPAribaSource" }
);

writeDump( var= result );
</cfscript> 

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