Ready to get started?

Learn more about the CData JDBC Driver for SAP SuccessFactors or download a free trial:

Download Now

Query SAP SuccessFactors Data in ColdFusion

Write standard ColdFusion data access code to connect to SAP SuccessFactors data.

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

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

      You can authenticate to SAP Success Factors using Basic authentication or OAuth with SAML assertion.

      Basic Authentication

      You must provide values for the following properties to successfully authenticate to SAP Success Factors. Note that the provider will reuse the session opened by SAP Success Factors using cookies. Which means that your credentials will be used only on the first request to open the session. After that, cookies returned from SAP Success Factors will be used for authentication.

      • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
      • User: set this to the username of your account.
      • Password: set this to the password of your account.
      • CompanyId: set this to the unique identifier of your company.

      OAuth Authentication

      You must provide values for the following properties, which will be used to get the access token.

      • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
      • User: set this to the username of your account.
      • CompanyId: set this to the unique identifier of your company.
      • OAuthClientId: set this to the API Key that was generated in API Center.
      • OAuthClientSecret: the X.509 private key used to sign SAML assertion. The private key can be found in the certificate you downloaded in Registering your OAuth Client Application.
      • InitiateOAuth: set this to GETANDREFRESH.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.sapsuccessfactors.jar

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

      A typical JDBC URL is below:

      jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver.
    • 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 SuccessFactors data source in the Actions column. After reporting a status of OK, the SAP SuccessFactors data source is ready for use.

Execute Queries

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

<cfquery name="SAPSuccessFactorsQuery" dataSource="CDataSAPSuccessFactors"> SELECT * FROM ExtAddressInfo WHERE city = <cfqueryparam value="#city#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#SAPSuccessFactorsQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM ExtAddressInfo WHERE city = ?", 
  [
    { value="Springfield", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataSAPSuccessFactors" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?city=Springfield