RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.
Widget Type:
Page Widgets
TPC Version:
  • 3.3 +
VideoLogos
The CRM Donut Chart is a specialized widget that allows you to create a chart to display data. A donut chart represents data in a circular shape with larger values taking up more of the 'donut'. It also sports a hole in the center much like an actual donut! The chart data is fetched by FetchXML via CRM Entities and has the option of choosing a presaved configurations for the chart. Additionally, the option to create a custom chart exists. 

Configuration

Basic Setup

  1. From the Portal Connector (Charts) widget list, click and drag the CRM Donut Chart into the body of the page.

  2. In order for the widget to properly function, there are a few options that must be configured. Click on the edit button to display the properties prompt. It should look like this: 

    CRM Donut Chart Basic Properties

Data

Next, navigate to the Data tab. It should look like this: 

CRM Donut Chart Data Properties

Filters

Next, navigate to the Filters tab. It should look like this: 

CRM Donut Chart Filter Properties

Appearance 

Next, navigate to the Appearance tab. It should look like this: 

CRM Donut Chart Appearance Properties

The Appearance tab contains an array of options for you to customize the appearance of your chart to the exact way you'd like it. The CRM Donut Chart has a few unique options under Miscellaneous.

  1. When you are finished configuring the chart, click on the save button to save it.

Widget Properties

Basic Properties

Saved Visualization

The Saved Visualization drop drop list will allow you to choose from a list of preconfigured chart views based on the default CRM Entities. Please note that if a custom FetchXML fetch is provided for the widget, the Saved Visualization drop down should be set to the upper-most, blank field or else the chart will conflict with the custom FetchXML

FetchXML

The FetchXML text area determines what sort of data a widget will be populated with. Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen.  By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function, please see the FetchXML Builder How-To.

Vertical Axis Data Field (Series)

The Vertical Axis Data Field (Series) drop down list is used to bind data to the Y Axis of the chart. The drop down list is automatically populated via the FetchXML.

Horizontal (Category) Axis Label #2

The Horizontal (Category) Axis Label #2 drop down list will further group the fetched records. It is normally not required. For example, a chart has been configured to count the amount of songs per artist. Normally, the Horizontal (Category) Axis Label #1 would be set to Artists while the Vertical Axis Data Field (Series) would be set to Songs. The Horizontal (Category) Axis Label #2 column can be used to add additional organization to the chart by including genres. The chart would then organize each artist into a genre with the count of songs of that genre appearing.

Horizontal (Category) Axis Label #1

The Horizontal (Category) Axis Label #1 drop down list will choose what fetched fields will appear on the X axis of the chart. This drop down list will be automatically populated by the fetched fields from the FetchXML. Please note that if an alias has been set for the fetched field, the drop down list will retrieve that alias instead.

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

Axis-Y Title

The Axis-Y Title text box will determine the name of the Y axis upon the chart.

Axis-X Title

The Axis-X Title text box will determine the name of the X axis upon the chart.

Chart Title

The Chart Title text box will determine the name of the chart. This will appear on the actual chart.

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Saved Visualization

The Saved Visualization drop drop list will allow you to choose from a list of preconfigured chart views based on the default CRM Entities. Please note that if a custom FetchXML fetch is provided for the widget, the Saved Visualization drop down should be set to the upper-most, blank field or else the chart will conflict with the custom FetchXML

FetchXML

The FetchXML text area determines what sort of data a widget will be populated with. Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen.  By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function, please see the FetchXML Builder How-To.

Vertical Axis Data Field (Series)

The Vertical Axis Data Field (Series) drop down list is used to bind data to the Y Axis of the chart. The drop down list is automatically populated via the FetchXML.

Horizontal (Category) Axis Label #2

The Horizontal (Category) Axis Label #2 drop down list will further group the fetched records. It is normally not required. For example, a chart has been configured to count the amount of songs per artist. Normally, the Horizontal (Category) Axis Label #1 would be set to Artists while the Vertical Axis Data Field (Series) would be set to Songs. The Horizontal (Category) Axis Label #2 column can be used to add additional organization to the chart by including genres. The chart would then organize each artist into a genre with the count of songs of that genre appearing.

Horizontal (Category) Axis Label #1

The Horizontal (Category) Axis Label #1 drop down list will choose what fetched fields will appear on the X axis of the chart. This drop down list will be automatically populated by the fetched fields from the FetchXML. Please note that if an alias has been set for the fetched field, the drop down list will retrieve that alias instead.

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

Axis-Y Title

The Axis-Y Title text box will determine the name of the Y axis upon the chart.

Axis-X Title

The Axis-X Title text box will determine the name of the X axis upon the chart.

Chart Title

The Chart Title text box will determine the name of the chart. This will appear on the actual chart.