How To Guides

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

Subsections of How To Guides

Creating Status Codes

This section covers the necessary steps involved in creating a new status code within the Metrix Asset Management System. This extends to the initial creation of the code with status effect. In subsequent sections, editing and deleting status codes is discussed.

To create a new status code within Metrix, complete the following steps:

  1. Navigate to the ‘Status Codes’ management page (Assets Menu > Status Codes).

  2. Click on ‘Create New Status Code’ at the top of the page.

  3. This will initialise a new status code and display a dialog box waiting for additional details.

  4. From here, you will need to set the ‘Status Name’, the ‘Status Effect’ (see Status Codes), and a brief ‘Description’ for the new status code.

  5. When you have finished defining the status code, click ‘Create’

Note

Editing a status code is restricted to updating the description only. Other properties including the status label and the status effect cannot be modified after initial creation.

Editing Status Codes

In the Metrix Asset Management system, editing a status code is restricted to updating the description only. Other properties including the status label and the status effect cannot be modified after initial creation.

To edit the description of a status code, complete the following steps:

  1. Navigate to the ‘Status Codes’ management page (Assets Menu > Status Codes).

  2. This page renders every status code currently configured in the system. To edit a particular status code description, click on the pencil ‘Edit’ icon on the right-hand side of the description field in the corresponding row.

  3. Once finished, click on the tick icon at the right-end of the input box.

Deleting Status Codes

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

Warning

Deleting status codes cannot be undone. The following restrictions also apply when it comes to deleting status codes:

  • Status codes cannot be in use: If the status code is currently assigned to any component within the system, then it cannot be deleted.

To delete a status code, follow these steps:

  1. To begin deleting a status code, navigate to the ‘Status Codes’ management page (Assets Menu > Status Codes).

  2. This page renders every status code currently configured in the system. To delete a particular status code, click the trash-can ‘Delete’ icon at the far right-hand side of the row. If the button is not enabled, this means that the status code cannot be deleted (see warning notes, above).

  3. In the subsequent dialog, confirm your decision by clicking ‘Delete’.

  4. The status code will now be permanently deleted from the system.