Pie chart widgets

Pie chart widgets display information from a specific data model, according to the filters applied to the Rest URL for the data, as a pie chart.

If a Group By field is specified for the pie chart, its sections are determined by the Group By field, and the values displayed for them are determined by the field selected for Aggregation.

If a Group By field is not specified, the chart's sections are determined by the aggregated values from the fields selected for the chart. Each field corresponds to a section on the pie chart.

You can group and aggregate the data as required, limit the number of records displayed, and receive filter events which apply to the chart.

Clicking a section of the pie chart drills through to the Detail View, which displays a table of data filtered according to the section that was clicked. For example, if a pie chart is grouped by CommunicationState, clicking the section for the count of Draft communications will open the Detail View to display the data for Draft communications only.See Configure the Detail View for more information.

Note Drill-through on charts is not available to the Administrator when creating and updating standard dashboards.

Add a pie chart widget

To add a pie chart widget to a dashboard:

1. Click the drop-down arrow on the dashboard tab and select Add Widget.

   The Add Widget window is displayed.

2. Click the name of the widget you want to add to the dashboard.

   The dashboard is refreshed to show the new widget ready for configuration.

   Tip You can drag the widget to a different location on the page, e.g. to a different column, and to above or below existing widgets. You can also resize the widget by dragging the edges to change the height or width.

Configuration field descriptions

Note Fields marked with an asterisk are required.

Widget configuration

To configure the pie chart widget:

3. If necessary, click Edit on the title bar of the widget to open its properties.

   Note Fields marked with an asterisk are required.

4. Enter the Title of the widget.

5. Enter the Rest URL of the data model which will be used in the widget, typically https://YourServer/ProConAnalyticsAPI/datamodel where datamodel is:

   • Contracts

   • BreakdownItems

   • LineItems

   • Communications

   • CommunicationReviews

   • CommunicationLineItems

   • Obligations

   • Tenders

   • ScheduleItems

   • TenderReviews

   • StageGates

   If necessary, customize the URL to select, filter, sort and limit the data - see Specifying URLs for more information.

   Tip By default, data is returned from deleted contracts/tenders which are in the recycle bin.

   Include $filter=IsDeleted eq 'No' in your URL to exclude this data.

6. If you want to group the data by a single field:

   1. Enter the name of the field in the Group By field.

      For example, to group communication data by the state of the communications, enter CommunicationState.

   2. In the Aggregation section, select the Type (Average, Count or Sum) and enter the Column Name for the field by which you want to aggregate the data (not required for Count).

7. If you want to view data for several fields, enter the Column Names and Display Names for the fields by which you want to aggregate the data. Click Add to add more fields.

8. If desired, enter the Legend Title. If this is not set, the Group By field name is used if it has been specified; otherwise the title of the legend is left blank.

9. You can click Save to display a pie chart of all the data returned by the specified Rest URL and specified fields, or continue to refine your widget data before saving.

Limit the displayed records

If a Group By field has been specified, you can limit the number of records displayed in the chart, based on a sort of the values of the Group By field. Limiting the records displayed also sorts the data in the chart by ascending/descending order.

To limit the number of records displayed:

10. From Limit Records, select:

    • Top to show the first X records.

    • Bottom to show the last X records.

    Tip Numeric values are sorted in ascending order (smallest first). Therefore, for fields which have numeric values, you must specify Bottom to get the records with the highest values or Top to get the records with the lowest.

11. Enter the number of records you want to display in the Record Count field.

12. Select Include Tied Results if you want to display all records which rank equally in the top or bottom X, even if this means that more than X records are displayed .

The sections in the chart are displayed in sorted order, depending on whether Top or Bottom was selected.

Receive filter events

See Configure widgets to broadcast and receive filters.

Example

Business unit or contract dashboard.

Displays the total number of overdue communications for each communication template.