Create a Calculated Number Metric

A calculated number metric is a metric that is generated from a data source in BrightWork. The data source can be a list (an entire list, a view in a list or a list filtered by your own custom CAML), a BrightWork Reporter report, or the Project Cache.

Example: Issues. This metric counts the number of Issues with a Red Status Indicator. This metric is available in the Project Lite, Project Standard and Project Structured templates.

See Supplied Metrics for more metric examples. Most of the supplied metrics are actually calculated number metrics.

To create a calculated number metric:

1. Navigate to the Metrics list and click new item, then click Calculated Number Metric.
2. Give the metric a Title and a Description.
3. If necessary, specify a new Metric ID.

   The system will automatically generate a Metric ID for the metric using the title, but you may update to one that makes more sense to you.

   If the Metric ID already exists in the list, you will see a message saying that 'the Metric ID is not available' when you attempt to save it or click the Check button. This means you will have to edit so that it is unique.

   

4. If necessary, unselect the Activate Metric check box to make the Metric inactive.

   Making the Metric inactive does the following:

   • Prevents data from this Metric appearing in reports where the Metric was added to join with the Project Statement
   • Excludes the Metric from the Metric Recalculation Timer Job
5. Select a Category for the metric. The available options include:
   • Cost
   • Date
   • Duration
   • Project
   • Quality
   • Resource
   • Scope
   • Variance
   • Work
6. Choose Metric Data Source:
List:
1. Select the list.
2. Select the filter:
   • All items
   • Items in this view

   Note: If the view has item limits enabled, the metric will only use the items returned.

   

   If the items in the view are grouped into batches, the metric will use all the items returned by the view in all the batches.

   • Specify filter (CAML)
3. Select the Metric Calculation:
   • Number of items returned
   • Select a column and a formula:
   • • Average
     • Maximum
     • Minimum
     • None
     • Sum
4. Select whether or not to automatically calculate the metric in the Metric Recalculation Timer Job.

Or

Report:
1. Select the Report.

   Note: You must select a report which does not include report filter(s).

   Reports that include report filters (e.g. My Work, Work Due Soon) are not supported as a Metric Data Source. Selecting such a report will cause a warning message to display and you will be unable to save the metric.

   

2. Select the Scope:
   • Current Site
   • Current Site and Subs
3. Define the Metric Calculation:
   • Number of items returned
   • Select a column and a formula:
   • • Average
     • Maximum
     • Minimum
     • None
     • Sum
4. Select whether or not to automatically calculate the metric in the Metric Recalculation Timer Job.

Or
Project Cache:
1. Select the filter:
   • Items in this view

   Note: The metric will use all the items returned by the view even if the view has item limits enabled.

   

   If the items in the view are grouped into batches, the metric will use all the items returned by the view in all the batches.

   • Specify filter (CAML)
2. Select the Scope:
   • Current Site
   • Current Site and Subs
3. Select the Metric Calculation:
   • Number of items returned
   • Select a column and a formula:
   • • Average
     • Maximum
     • Minimum
     • None
     • Sum
4. Select whether or not to automatically calculate the metric in the Metric Recalculation Timer Job.

Or
Work Cache:
1. Select the filter:
   • All items
   • Items in this view

   Note: The metric will use all the items returned by the view even if the view has item limits enabled.

   

   If the items in the view are grouped into batches, the metric will use all the items returned by the view in all the batches.

   • Specify filter (CAML)
2. Select the Scope:
   • Current Site
   • Current Site and Subs
3. Select the Metric Calculation:
   • Number of items returned
   • Select a column and a formula:
   • • Average
     • Maximum
     • Minimum
     • None
     • Sum
4. Select whether or not to automatically calculate the metric in the Metric Recalculation Timer Job.
7. Select the Metric Value Format:
   • Number: Specify the Number of Decimals
     or
   • Percentage: Specify the Number of Decimals
     or
   • Currency: Specify the Number of Decimals and select the Currency
     or
   • Custom: Enter the Custom Number String

   • Note: The following characters are supported for number columns - "."; ","; "#","%","0".

     The "#" character is used to describe integers. The "." and "," characters are used to describe the location and type of punctuation. The "0" character is used enforce digits before and after the "." character.

     An example of their use:

     The number 5351 would be displayed in reporter using the following display format - "#,###"- as "5,351".

     See Custom Number String Examples for more examples.

8. Select the Metric Indicator Settings.

   The Metric Indicator settings allow you compare the Metric value to a target and specify Warning and Danger parameters to trigger associated icons.

   1. Specify whether or not to show an indicator for the metric.
   2. Specify whether lower values or higher values are better.

      Note: When Lower values are better is selected, a value above the specified thresholds will trigger an indicator.

      When Higher values are better is selected, a value below the specified thresholds will trigger an indicator.

   3. Specify the value to compare the metric to:
      • Enter a fixed value
        or
      • Select a numeric metric value in another metric item.
   4. Specify the Threshold settings:
      • Select Compare range is fixed to use numbers, and enter a Warning Level and a Danger Level
        or
      • Select Compare range is tolerance to use percentages, and enter a Warning Level and a Danger Level

      • Note: When Lower values are better is selected, the Warning Level must be less than the Danger Level.

        When Higher values are better is selected, the Warning Level must be greater than the Danger Level.

   5. If desired, specify custom icon paths.
9. Click Update.