DataBind Charts to Anaplan Data
DataBinding facilitates two-way interaction with data through UI controls. Using the CData ADO.NET Provider for Anaplan streamlines the process of binding Anaplan data to Windows Forms and Web controls within Visual Studio. In this article, we will demonstrate using wizards to establish a binding between Anaplan 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 Anaplan, follow the steps outlined below using the Data Source Configuration Wizard. Within the wizard, you'll have the option to choose the specific Anaplan entities you wish to bind to.
- 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.
- In the Data Source Configuration Wizard that appears, select Database -> Dataset.
- In the Choose Your Data Connection step, click New Connection.
In the Add Connection dialog, click Change to select the CData Anaplan Data Source.
Below is a typical connection string:
OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;Region=US1;InitiateOAuth=GETANDREFRESH;
Authenticating to Anaplan
The driver supports authenticating with Basic, Certificate, or OAuth. In every case, set Region to the region where your Anaplan account data is hosted (e.g., US1, which is the default).
Using Basic Authentication
Set AuthScheme to Basic, then supply your Anaplan User and Password. If your workspace uses single sign-on (SSO), you must be assigned as an Exception User to use Basic authentication.
Using Certificate Authentication
Set AuthScheme to Certificate, then supply the Certificate, CertificateType, and PrivateKey properties (and the matching CertificatePassword / PrivateKeyPassword if either is encrypted). The certificate must be a CA-issued X.509 certificate registered with your Anaplan tenant administrator.
Using OAuth Authentication
Register a custom OAuth application in Anaplan, then set the following properties:
- OAuthClientId: The client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
- CallbackURL: The redirect URI defined when you registered your application.
- InitiateOAuth: Set to GETANDREFRESH to have the driver manage the OAuth token exchange and refresh automatically.
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.
- Choose the database objects you want to work with. This example uses the Sales 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 Region and the y-axis to Product.
- In the Chart properties, click the button in the Series property to open the Series Collection Editor.
- 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 Anaplan data. Run the chart to display the current data.
Code Walk-through
DataBinding to Anaplan data requires only a few lines of code and can be completed in three easy steps.
- Connect to Anaplan.
- Create the AnaplanDataAdapter to execute the query and create a DataSet to be filled with its results.
- DataBind the result set to the chart.
Below is the complete code:
AnaplanConnection conn = new AnaplanConnection("OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;Region=US1;InitiateOAuth=GETANDREFRESH;");
AnaplanCommand comm = new AnaplanCommand("SELECT Region, Product FROM [Workspace].[Model].[Sales] WHERE Value = '100'", conn);
AnaplanDataAdapter da = new AnaplanDataAdapter(comm);
DataSet dataset = new DataSet();
da.Fill(dataset);
chart1.DataSource = dataset;
chart1.Series[0].XValueMember = "Region";
chart1.Series[0].YValueMembers = "Product";
// Insert code for additional chart formatting here.
chart1.DataBind();