Status Summary Control

Description

The Status Summary control provides a quick summary of items in various tracking registers and appears alongside the list of items when viewed from the Project, Program and Portfolio forms.

The Status Summary control appears in Altus out of the box in the following contexts - and can be configured using the corresponding Configuration Setting;

Form	Tracking Register	Configuration Setting
Project (Tracking)	Decisions	Projects > Decisions Summary [projectDecisions]
Project (Tracking)	Deliverables	Projects > Deliverables Summary [projectDeliverables]
Project (Tracking)	Issues	Projects > Issues Summary [projectIssues]
Program	Decisions	Programs > Decisions Summary [programDecisions]
Program	Issues	Programs > Issues Summary [programIssues]
Portfolio	Decisions	Portfolios > Decisions Summary [portfolioDecisions]

The control provides a quick glance summary of the data in the related tracking register (e.g. a count of overdue items, active items and items with no due date).

As items are added or removed from the related subgrid, the control should update automatically to display the current summary data. However, there is one known scenario where the manual refresh button needs to be pressed in order for the summary data to display correctly. In the scenario where you select all of the items in the subgrid (where there is more than one) and perform a multiple delete, there is currently a bug in the Dataverse where the message for the control to update is not sent and therefore the control is not aware of the need to update. Pressing the refresh button to refresh the control, refreshing the form, or navigating away and returning to the tab will resolve to then display the correct summary information.

The out of the box behaviour of the control can be customised, and in addition the control can be repurposed to be used in other contexts, including with custom entities/tables.

Overall Status Summary Configuration Setting Options

Note

For those familiar with the Widget Dashboard control configuration, these settings are identical (both controls leverage the same behaviour)

Setting	Description
Title	Can be used to display a title above the control. If left blank, no Title will display. The out of the box uses of this control do not display a Title, because the Form itself is configured to display a title.
Layout Mode	Default for Status Summary control is to use Vertical layout mode. Horizontal layout mode switches the behaviour to display the data horizontally.
Show Refresh Button	When set to 'Yes', will display a refresh button (icon) in the top right corner of the control. When pressed, this will force a data refresh.
Numbers Shade Colour	Configures the background colour to display behind the summary numbers.
Labels Shade Colour	Configures the background colour to display behind the summary labels.
Show Numbers	When set to 'Yes', will display the summary number values.
Show Chart	When set to 'Yes', will display a chart below the number summary values.
Chart Type	When Show Chart is set to 'Yes', will display a chart of the type selected. Options are 'Pie', 'Column' and 'Donut'.
Chart Size	When Show Chart is set to 'Yes', will display a chart sized according to this value. Options are 'Small', 'Medium' and 'Large'.
Padding above chart	This value will optionally insert padding above the chart (when Show Chart is set to 'Yes').

Vertical layout mode:

Horizontal layout mode:

Value Configuration Setting Options

Note

For those familiar with the Widget Dashboard control configuration, these settings are identical (both controls leverage the same behaviour)

Each Value to be displayed in the Status Summary control can be configured in the Value Configurations section of the main configuration setting. To adjust any of the out of the box value configurations, select 'Load Defaults' from the main configuration setting control. Then select to edit the setting that you wish to customise. Alternatively, additional summary values can be appended to the out of the box values by adding a New Value Configuration.

Setting	Description
Id	A unique id for the value configuration item. This can be used to overwrite an existing out of the box configuration value. To overwrite a built in value the id will need to match. Generally we have used the label in lower case without spaces. For a new value, simply enter a value that does not include spaces and gives a description to the value you are entering.
Label	The label to use for the number being displayed. Please keep text concise to fit the limited space.
SubText	Subheading to display under the label. Please keep text concise to fit the limited space.
Tooltip	Value to be shown if mouse is hovered over this item.
Default Value	The value to be shown while the actual values are calculated. Default is 0.
Colour	The colour to use for the number that is being displayed.
Icon	Optional. This can either be fluent ui icon, a base64 data: string or a path to an icon file.
Order	Numerical value that determines the order in which to show this value (when compared to the other Values). Built-in orders are generally set to 10, 20, 30�
Odataurl	The Dynamics/Dataverse ODATA query that will return a collection (potentially an aggregation) and arrive at the value that you wish to display. (Load Defaults to see examples of the ODATA Urls that are used out of the box)
Odatafield	The field returned by the Odataurl query that contains the value that you wish to display.
Hide	In instances where you wish to hide an out of the box value (or a custom one that you have previously added), you can select to set Hide to 'Yes' and that Value Configuration item will not appear when the control is rendered.

Notes for using the Status Summary Control with a custom entity/table or in other contexts

Start by creating a new Configuration Setting that you will associate to your new instance of the Control. Give your Configuration Setting an appropriate Category, Display Name, Name and Description.

In another browser window or tab, open an existing setting that is used by the Status Summary control (e.g. Project > Issues Summary). From that configuration setting, select the cog icon in the bottom right to open the schema values for that setting.

Copy the values from both the JSON Schema and UI Schema to the corresponding settings in your new configuration setting.

Save your new Configuration Setting.

Then, populate your new Configuration Setting with the appropriate configuration and values to display the data you wish to show in the custom context.

Next, select to Edit the Form that you wish to display the custom Summary Control on. Add a subgrid to the Form where you would like the control to display and configure the subgrid to display the 'Altus Status Summary' control. In the details for the control, enter the Name value you gave to your new Configuration setting.

Save and Publish your form changes.

Migrating from Previous Version of Status Summary Control

A previous version of the Status Summary control was present in earlier versions of the product but was quite limited in terms of customisability. The original control allowed only configuration of the labels and colours of the values (but not the order, or calculation and did not allow for use with custom entities/tables). Environments where the previous version was installed will automatically be updated to use the new control - and in instances where the previous configuration setting (to modify the labels) was customised, those customisations will still be honoured by the new control. However, customers are encouraged to migrate any customisations from the old setting to the new setting for the control and to then deactivate the old setting (which will have been denoted as deprecated).

Old Setting Name	New Setting Name
Portfolios > Decisions Summary (Deprecated) [PortfolioDecisions-SummaryConfig_IQA]	Portfolios > Decisions Summary [portfolioDecisions]
Programs > Decisions Summary (Deprecated) [ProgramDecisions-SummaryConfig_IQA]	Programs > Decisions Summary [programDecisions]
Programs > Issues Summary (Deprecated) [ProgramIssues-SummaryConfig_IQA]	Programs > Issues Summary [programIssues]
Projects > Decisions Summary (Deprecated) [ProjectDecisions-SummaryConfig_IQA]	Projects > Decisions Summary [projectDecisions]
Projects > Deliverables Summary (Deprecated) [ProjectDeliverables-SummaryConfig_IQA]	Projects > Deliverables Summary [projectDeliverables]
Projects > Issues Summary (Deprecated) [ProjectIssues-SummaryConfig_IQA]	Projects > Issues Summary [projectIssues]

Example OData Queries

For example OData queries click here