Table widgets

Table widgets display information from a specific data model, according to the specified REST URL and the fields selected in the table configuration.

You can group and aggregate data as required, limit the number of records displayed, configure the data displayed in the Detail Panel, and receive and broadcast filter events which apply to the table.

The options selected when the table widget is configured affect its behavior when a row is clicked.

Note The data models which provide current data should be used for this widget; for example, Contracts or Communications. The History data models should only be used if the data request is restricted to current data by applying a filter: include $filter=RowIsCurrent eq 'Yes' in your URL.

Add a table widget

To add a table 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.

Basic configuration

To configure the table 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 do not want to group and aggregate data, specify the Table Columns to Display:

   1. Enter the Column Name for a field you want to include in the table display. Click Add to add more columns.

   2. If desired, enter a Display Name for the field (e.g. a short name or friendly name).

   3. You can click Save to display a table with the specified fields, or continue to refine your widget data before saving.

Group and aggregate data

To group the data:

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

   Note This is also the field for which the value is broadcast as a filter event if Broadcast Filter Events is selected.

   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.

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

9. Click Add to specify more aggregated columns.

10. The list of Table Columns to Display automatically updates to include the Group By field and all Aggregated Columns.

    If desired, enter a Display Name for the field (e.g. a short name or friendly name).

Limit the displayed records

If you have chosen to group your data (by specifying a Group By field), you can limit the number of records displayed in the table. Limiting the records displayed also sorts the rows in the table by ascending/descending order.

To limit the number of records displayed:

11. From Limit Records, select:

    • Top to show the first X records.

    • Bottom to show the last X records.

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.

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

14. Enter the name of the Limit Column on which the records will be sorted to get the top or bottom X records - the column must be listed in the Table Columns to Display. You can use aggregated columns, e.g. Sum of TotalFinancialValue.

Detail panel configuration

To configure the data displayed in the Detail Panel when the table is filtered (by clicking a row):

15. Select Enable Detail Panel. See the Options table above for what happens if Enable Detail Panel is not selected.

16. Specify the field you want to display by entering the following details:

    • Column Name

    • Display Name (e.g. a short name or friendly name)

17. Click Add to specify more columns.

Broadcast and receive filter events

See Configure widgets to broadcast and receive filters.

Example

Business unit dashboard.

Lists the projects in the business unit, with the number of contract communications in each project and the average value of the financial impact of the communications.