DataBind Charts to SAP SuccessFactors LMS Data

DataBinding facilitates two-way interaction with data through UI controls. Using the CData ADO.NET Provider for SAP SuccessFactors LMS streamlines the process of binding SAP SuccessFactors LMS data to Windows Forms and Web controls within Visual Studio. In this article, we will demonstrate using wizards to establish a binding between SAP SuccessFactors LMS data and a chart that dynamically updates. Additionally, the code walk-through section will guide you through the creation of a chart using just 10 lines of code.

Binding Data to a Chart

DataBinding to a Chart consists of three steps: Instantiate the control, configure the data source, and databind.

Configure the Connection and Select Database Objects

To create a chart control and establish a connection to SAP SuccessFactors LMS, follow the steps outlined below using the Data Source Configuration Wizard. Within the wizard, you'll have the option to choose the specific SAP SuccessFactors LMS entities you wish to bind to.

1. In a Windows Forms project, drag and drop a Chart control from the toolbox to the form. In the Data section of the Chart properties, select DataSource and then select Add Project Data Source from the menu.
2. In the Data Source Configuration Wizard that appears, select Database -> Dataset.
3. In the Choose Your Data Connection step, click New Connection.

4. In the Add Connection dialog, click Change to select the CData SAP SuccessFactors LMS Data Source.

   Below is a typical connection string:

   User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;

   SAP SuccessFactors LMS uses OAuth authentication. Before connecting, you must configure an OAuth application tied to your SAP SuccessFactors LMS account.

   To establish a connection, set the following properties:

   • User: Your SAP SuccessFactors LMS username.
   • CompanyId: Your SAP SuccessFactors company identifier.
   • Url: The SAP SuccessFactors API URL (e.g., https://api4.successfactors.com).
   • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
   • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

   See the Getting Started chapter of the help documentation for a guide to creating a custom OAuth app and using OAuth.

   When you configure the connection, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   
5. Choose the database objects you want to work with. This example uses the Items table.

DataBind

After adding the data source and selecting database objects, you can bind the objects to the chart. This example assigns the x-axis to ItemID and the y-axis to ItemTitle.

1. In the Chart properties, click the button in the Series property to open the Series Collection Editor.
2. In the Series properties, select the columns you want for the x- and y-axes: Select columns from the menu in the XValueMember and YValueMember properties.

The chart is now databound to the SAP SuccessFactors LMS data. Run the chart to display the current data.

Code Walk-through

DataBinding to SAP SuccessFactors LMS data requires only a few lines of code and can be completed in three easy steps.

1. Connect to SAP SuccessFactors LMS.
2. Create the SAPSuccessFactorsLMSDataAdapter to execute the query and create a DataSet to be filled with its results.
3. DataBind the result set to the chart.

Below is the complete code:

SAPSuccessFactorsLMSConnection conn = new SAPSuccessFactorsLMSConnection("User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;");
SAPSuccessFactorsLMSCommand comm = new SAPSuccessFactorsLMSCommand("SELECT ItemID, ItemTitle FROM [Admin].[Search_Service].[Items] WHERE Active = true", conn);
SAPSuccessFactorsLMSDataAdapter da = new SAPSuccessFactorsLMSDataAdapter(comm);
DataSet dataset = new DataSet();
da.Fill(dataset);

chart1.DataSource = dataset;  
chart1.Series[0].XValueMember = "ItemID";
chart1.Series[0].YValueMembers = "ItemTitle";
// Insert code for additional chart formatting here.
chart1.DataBind();