DataBind Charts to Pipeliner CRM Data
DataBinding facilitates two-way interaction with data through UI controls. Using the CData ADO.NET Provider for Pipeliner CRM streamlines the process of binding Pipeliner CRM data to Windows Forms and Web controls within Visual Studio. In this article, we will demonstrate using wizards to establish a binding between Pipeliner CRM 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 Pipeliner CRM, follow the steps outlined below using the Data Source Configuration Wizard. Within the wizard, you'll have the option to choose the specific Pipeliner CRM 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 Pipeliner CRM Data Source.
Below is a typical connection string:
Profile=C:\profiles\Pipeliner.apip;ProfileSettings='User=your_api_token;Password=your_api_password;SpaceId=your_space_id;ServiceUrl=your_service_url';
Start by setting the Profile connection property to the location of the Pipeliner CRM Profile on disk (e.g. C:\profiles\Pipeliner.apip). Next, set the ProfileSettings connection property to the connection string for Pipeliner CRM (see below).
Pipeliner CRM API Profile Settings
Navigate to Administration > Obtain API Key within your Pipeliner CRM workspace to retrieve the API Token, API Password, Space ID, and Service URL.
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 Account 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 Success and the y-axis to Id.
- 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 Pipeliner CRM data. Run the chart to display the current data.
Code Walk-through
DataBinding to Pipeliner CRM data requires only a few lines of code and can be completed in three easy steps.
- Connect to Pipeliner CRM.
- Create the APIDataAdapter 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:
APIConnection conn = new APIConnection("Profile=C:\profiles\Pipeliner.apip;ProfileSettings='User=your_api_token;Password=your_api_password;SpaceId=your_space_id;ServiceUrl=your_service_url';");
APICommand comm = new APICommand("SELECT Success, Id FROM Account WHERE Name = 'Acme Corporation'", conn);
APIDataAdapter da = new APIDataAdapter(comm);
DataSet dataset = new DataSet();
da.Fill(dataset);
chart1.DataSource = dataset;
chart1.Series[0].XValueMember = "Success";
chart1.Series[0].YValueMembers = "Id";
// Insert code for additional chart formatting here.
chart1.DataBind();