Applies to: brains.app Platform

Users who can do this: Administrator

Introduction

Metrics are a key component of the brains.app platform as they allow to expose data from various data sources and to use this data in dashboards and reports.

Numerous metrics are set-up during the initial implementation at a new site, with more metrics added overtime to expose more data or to set new equations.

How to use the administrate metrics?

Only Admin users can use administrate metrics screen. To access the administrate metrics screen, follow the below steps:

  • Click on the Admin icon on the left navigation panel to open the Admin menu.

  • Click on Metric Admin in the menu.

  • And navigate to the Administrate metrics screen.

The Administrate metrics page consists of:

  • A way to search for metrics.

  • A table of all metrics currently set for the site.

  • Action buttons on each metric row to edit, duplicate, and delete the metric.

  • Add Metric button in the top right-hand corner to add new metrics.

SEARCH A METRIC

To search for a metric, type in the Search box any text found in the name for this metric. For example search by typing:

  • 3373, if you know the ID of the metric.

  • EQUATION, if you know that the source of the metric is EQUATION

  • Crusher as a keyword, if you know that the name of the metric contains Crusher.

ADD NEW METRIC

  1. To add/create a new metric, click on the ADD METRIC button.

2. Fill in the required fields in the New Metric form, such as:

  • Name

  • Unit

  • Icon

  • Source

  • Cumulative

  • Color

  • Mongo Metric Name

3. Use the drop-down menu in the field to choose the suggested and available options.

4. The Metrics are created based on the metric types that are in the SOURCE field.

5. The different metric types that can be configured are as below:
Click on the respective metric type to learn more about their specificities and configuration:

6. Press the Confirm button to save the new metric successfully.

EDIT METRIC

  1. Search for the metric you want to edit/update using the search text box.

  2. Click on the Edit (Pencil) icon for the metric.

3. Make the required changes to the metric details fields in the Edit Metric form.

4. And click on the Confirm button to save the changes successfully.

DUPLICATE METRIC

  1. Search for the metric you want to edit/update using the search text box.

  2. Click on the Duplicate(Copy) icon for the metric.

3. Make the required changes to metric details, such as the Name, Source, and Mongo Metric Name.

Note: Do not forget to update the Metric Name for the new (duplicated) metric, in order to avoid data overriding of the similar metrics wherever the metric used in the application.

4. Press the Confirm button to save the changes successfully.

DELETE METRIC

  1. Search for the metric you want to edit/update using the search text box.

  2. Click on the Delete (Trash) icon for the metric.

  3. Click Confirm in the Delete Confirmation Form to delete the metric from the system successfully.

For more information related to metrics, please refer to the following articles:

Did this answer your question?