Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Contract Risk Management - Company Portal

Line chart widgets

  • Last UpdatedAug 02, 2024
  • 6 minute read

Line chart widgets display information from a specific data model, according to the filters applied to the Rest URL for the data, as a single line graph.

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

The X axis of the chart displays the values from the specified Group By field; the Y axis displays the values from the field selected for Aggregation.

Clicking a point on the line drills through to the Detail View, which displays a table of data filtered according to the point that was clicked . For example, if a line chart is grouped by CommunicationState, clicking the point 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.

Embedded Image (65% Scaling) (LIVE)

Note Column names longer than 10 characters will be truncated.

Add a line chart widget

To add a line chart widget to a dashboard:

  1. Click the fa-sort-down 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 fa-asterisk are required.

Field/section

Displayed when

Description

Title

The title of the widget.

Rest URL

The URL of the data which will be used in the chart widget.

See Specifying URLs for more information.

Group By

Enter the name of the field by which you want to group the data.

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

See Data models and fields for information about the fields which are available for each type of data.

Aggregation

Select the Type: Average, Count or Sum.

For Average and Sum, enter the Column Name for the field by which you want to aggregate the data.

Tip You can use the $filter option with the Rest URL to exclude zero values from calculated averages. For example, to exclude zero values for the average DaysToRespond for communications, use $filter=DaystoRespond gt 0. See Specifying URLs for more information.

For Count, the Group By field is automatically used.

See Data models and fields for information about the fields which are available for each type of data.

Limit Records

Select how to limit the number of records which are displayed, based on the value of the Group By field:

  • None - all records are displayed.

  • Top or Bottom - the top or bottom X records are displayed, where X is the Record Count, e.g. the top 5 records.

Record Count

Top or Bottom is selected for Limit Records.

The number of records (X) which are displayed.

Include Tied Results

Top or Bottom is selected for Limit Records.

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

For example, if X is 10, and the 11th and 12th records have the same value as the 10th, all 12 records will be displayed.

However, if the 5th and 6th records have the same value but the 10th has a unique value, only 10 records are displayed.

X Axis Title

The text to be displayed as the title of the X axis of the line chart.

Y Axis Title

The text to be displayed as the title of the Y axis of the line chart.

Receive Filter Events

Select to receive any broadcast filter events from other widgets. This widget will be filtered based on the filter event received.

For example, if the current widget shows the financial values of all communications, and a filter event is received from another widget which has been filtered to show only data for a specific communication state, the current widget will be filtered by the same communication state.

Widget configuration

To configure the line chart widget:

  1. If necessary, click fa-pencil Edit on the title bar of the widget to open its properties.

    Note Fields marked with an asterisk fa-asterisk are required.

  2. Enter the Title of the widget.

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

    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.

  4. In the Group By field, enter the name of the field by which you want to group the data.

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

  5. 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).

  6. If desired, enter the X Axis Title and Y Axis Title. If these are not set, the field names are used.

  7. You can click Save to display a line 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

    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:

    1. 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.

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

    3. 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 .

      Receive filter events

      See Configure widgets to broadcast and receive filters.

      Example

      Business unit dashboard.

      Displays the total number of contracts for each project.

      Embedded Image (65% Scaling) (LIVE)

      Field

      Value

      Notes

      Title

      Contracts per Project

      The title of the widget.

      Rest URL

      https://YourServer/ProConAnalyticsApi/Contracts

      Returns data from the Contracts data model. No filter applied on the URL.

      Group By

      ProjectDepartmentName

      Groups the data by the project/dept - i.e. each point of the chart is a project/dept.

      Aggregation - Type

      Count

      Counts the number of records returned for each project/dept.

      Aggregation - Column Name

      -

      Limit Records

      Optional

      Used to specify the maximum number of records you want to include in the data shown.

      Axis Titles - X Axis Title

      Project

      Optional display name.

      Axis Titles - Y Axis Title

      Count

      Optional display name.

      Receive Filter Events

      Optional

      If selected, the data will be filtered according to the selection in a Slicer or Table widget that broadcasts filter events.

      In This Topic
      Related Links
      TitleResults for “How to create a CRG?”Also Available in