Card widgets
- Last UpdatedAug 02, 2024
- 4 minute read
Card widgets display single values which do not need to show any context such as a positive or negative trend, for example the number of days remaining on a contract.
Add a card widget
To add a card widget to a dashboard:
-
Click the
drop-down arrow on the dashboard tab and select Add Widget.
The Add Widget window is displayed.
-
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.
|
Field/section |
Description |
|
Title |
The title of the widget. |
|
Rest URL |
The URL of the data which will be used in the card widget. See Specifying URLs for more information. |
|
Prefix |
The prefix to be shown before the value on the card; e.g. a currency symbol. |
|
Suffix |
The suffix to be shown after the value on the card; e.g. "days". A space is automatically added before the suffix. |
|
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 number of items which are returned by the REST URL is displayed - e.g. the total number of communications. See Data models and fields for information about the fields which are available for each type of data. |
|
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 card widget:
-
If necessary, click
Edit on the title bar of the widget to open its properties.
Note Fields marked with an asterisk
are required.
-
Enter the Title of the widget.
-
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.
-
Enter any Prefix and/or Suffix that you want displayed with the value on the card.
-
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).
-
You can click Save to display the value returned by the specified Rest URL and specified fields, or continue to refine your widget data before saving.
Receive filter events
See Configure widgets to broadcast and receive filters.
Example
Contract dashboard.
Displays the number of days until the planned end date of the contract.
|
Field |
Value |
Notes |
|
Title |
Days Remaining on Contract |
The title of the widget. |
|
Rest URL |
https://YourServer/ProConAnalyticsApi/Contracts |
Returns data from the Contracts data model. No filter applied on the URL. Because this is a contract dashboard, only data for the current contract is returned. |
|
Prefix |
(leave blank) |
|
|
Suffix |
(leave blank) |
|
|
Aggregation - Type |
Count |
Counts the number of records returned. |
|
Aggregation - Column 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. |