Activity Metrics

Configuring the display of essential key performance indicators.

The Activity Metrics configurator is available from the App Studio.

The Activity Metrics Configurator is a modal dialogue with a master hierarchical tree of activity metrics on the left, with metric properties displayed on the right. There are two places where activity metrics can be displayed.

Each activity metric is linked to a ReST API data source request which simply returns a number which is displayed in your chosen colour on the navigation bar or drop-down account summary menu, or both.

When the user clicks on each metric, you can specify which form should open. This approach draws user attention to the important key performance indicators.

Each user can have their own specific KPI's controlled the the security subsystem.

When editing the properties of each toolbar element, the 3 buttons to the bottom right of the popup modal dialogue are used to either save or discard your changes:

Button	Action
Apply	Apply/save your changes. The app toolbar refreshes to reflect the changes. The popup remains open.
Apply & Close	Apply/save your changes. The app toolbar refreshes to reflect the changes. The popup closes.
Close	Cancel/discard all changes. The app toolbar does not refresh. The popup closes.

Activity Metrics

The Activity Metrics hierarchical tree appears to the left showing all configured metrics beneath. Each metric can be dragged and dropped into the preferred location when ordering items.

The Metric Properties are as follows:

Field	Description
ID	The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name	This is the read-only name of the element.
Description	A description about what this element does.
Frequency	How often the metric is refreshed in seconds. This lower this number, the more frequently the associated data source request is called.
Locked	Whether the item is locked. The Activity Metrics root is locked i.e. cannot be removed.
Caption	The text of the activity metrics. For example "KPI's".
Visible	Whether this is visible or not.

Add Metric

The add metric button appears in the left panel and is used to configure a new activity metric.

Type a descriptive name for your metric. This must be unique and you will not be able to change this later. Once saved, your new metric will appear selected in the tree on the left.

The Metric Properties can now be edited.

Field	Description
ID	The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name	This is the read-only name of the metric.
Description	A description about what this metric does.
Data Source Request	This is the ReST API data source request which is used to return a number which is displayed in the metric.
Drill Down Form	When the user clicks on the activity metric, this is the form which is opened.
Locked	Whether the item is locked. The History menu is locked i.e. cannot be removed.
Caption	The text of the menu item.
Tooltip	When the user hovers over the menu item you can remind them of any specific instructions.
Icon	The icon that appears to the left of the menu item.
Style	The custom button can be styled using the standard 'bootstrap' colours: Blue [info], Green [success], Grey [default], Red [danger], Themed, Yellow [warning].
Visible	Whether this is visible or not.

Delete Metric

The Delete button is used to delete the selected metric. This will remove it from the list of activity metrics displayed.