Creating a metric report definition in the Portal

In addition to configuring the metrics.xml file, you can also create custom reports from the Portal.

Before creating a metric report for imported Helix QAC metrics, you must first connect your Helix QAC project with Validate and upload your contents, including metrics data. Make sure to enable metrics by unchecking the Disable metrics box during upload.

To create a metric report definition:

1. Go to the Reports tab for your project.
2. Navigate to Manage Metric Report Definitions.
3. Select Add New Definition.
4. On the Add Metric Report Definition form:
   • For Name, enter a name for the new definition. The maximum length for metric definition names is 100 characters.
   • From the Category drop-down, choose Total Metric Value or Entity Count Over Threshold.
   • For Description, enter a description.
   • For Metric Types, enter the metric IDs. You can find the metric IDs in Metrics reference and QAC metrics reference.

     Metric Types are known as "kids" in the metrics.xml file.

   • For Entity Types (only for Entity Count Over Threshold), enter the entity names or IDs. You can find the entity names and IDs in Supported entity types.

     Entity IDs are known as "entityKids" in the metrics.xml file.

   • For Default Threshold (only for Entity Count Over Threshold), enter the desired default custom threshold for this metric configuration.
   • For Custom Metric Names, enter the values of your custom metrics. See Adding custom reports based on metrics you define.
   • Use the This report definition is enabled toggle to enable or disable the report.

     • When enabled, this definition will be able to be used to create reports.

     • When disabled, this definition will not be able to be used to create reports.

       Important: Disabling an already existing definition will also disable the reports created from it. Users without the "manage metric report config" permissions will not see any of the disabled metric report definitions.

     If you are using a previously configured metrics.xml file, disabling a definition of this file will hide that configuration from the Portal.
     

   • Click Add.

View your metric report definition in the Report Definitions tab.