How To Guides

This section contains how to guides with respect to report category definitions in the Metrix Asset Management system.

Creating Report Categories

This section covers the necessary steps involved in creating a new report category within the Metrix Asset Management System. This extends to the initial creation of the category, as well as populating the category options for it.

To create a new report category within Metrix, complete the following steps:

Navigate to the ‘Report Categories’ management page (Assets Menu > Report Categories).
Click on ‘Create New Report Category’ at the top of the page.
This will initialise and display a blank report category definition in a new dialog window.
Set the new ‘Category Name’ by entering it into the text input.
Set the label for the first ‘Category Option’ for the report category by typing it into the corresponding option input.
To add additional ‘Category Options’ simply click on the plus (’+’) symbol next to one of the existing options.
To remove a ‘Category Option’ simply click the remove (’-’) symbol next to the corresponding option.

Info

Each report category definition must have at least one (1) report category option assigned to it. This is why the first option in each set of report category definitions does not have a remove option.

When you have finished defining the report category, click ‘Create’.

Edit Existing Report Categories

As your organisation evolves over time, it may become necessary to alter your report category definitions to reflect additional or revised category options. Typically, this involves adding and/or removing category options. To edit an existing report category definition set, follow these steps:

Navigate to the desired Report Category (Assets Menu > Report Categories > Selected Category).
With the desired report category selected, a preview of the definition will appear on the right-hand side of the page. This is a read-only overview of the selected report category.
To remove a report category option, simply click on the trash can icon to the right of the option entry. If this icon is muted, it means that the option is currently assigned to an asset component and cannot be removed.
To add a new option to the category definition, click on ‘Create New Option for Current Category’ at the top of the category definition. A new dialog will appear, enter the label of the new option and click ‘Create’.

Note

Renaming category titles or category option labels is currently NOT supported.

Deleting Report Categories

When a report category is no longer required, the Metrix Asset Management system provides functionality for administrators to permanently remove it from the system.

Warning

Deleting report categories cannot be undone. The following restrictions also apply when it comes to deleting forms:

Report category cannot be in use: If the report category is currently assigned to any component, regardless of status, then it cannot be deleted.

To delete a report category (including all of it’s options), follow these steps:

To begin deleting a report category, navigate to that report category (Assets Menu > Report Categories > Selected Category).
Underneath the category title, there is an ‘Actions’ button – this type of button is implemented system wide as an indicator of additional options to manage a resource.
From the ‘Actions’ menu, choose ‘Delete Report Category’. If the button is not enabled, this means that the category cannot be deleted (see warning notes, above).
In the subsequent dialog, confirm your decision by clicking ‘Delete’.
The report category will now be permanently deleted from the system.