Status Codes, in the Metrix Asset Management System provide the ability for users to apply customised life-stage tags to their asset portfolio. Such associations can assist with triaging assets through various phases of life including proposed assets, active assets and inactive assets.
This section contains basic information about status code definitions in the Metrix Asset Management system.
Within the system, the above phases are referred to as ‘Status Effects’. These are predefined codes that impact the behaviour of status codes of each type. A status code’s effect cannot be modified after initial creation. Following is a description of each built-in status effect:
Assets that have not yet been commissioned, but are included in the asset portfolio for information and data tracking. Assets at with status codes of this type cannot have financial ledger transactions logged against them.
Assets that form part of the normal asset portfolio.
Assets that are no longer part of the asset portfolio. These assets typically represent those that have been fully disposed and/or removed from service. Assets at with status codes of this type cannot have financial ledger transactions logged against them.
Using the correct ID is important when accessing Metrix via APIs or using CSV file imports. The following details the ID values that can be used for status code references.
The status code ID is the only way to make a valid reference to a status code from external locations such as API calls or CSV Data Imports. Once a status code has been created, the ID value (which will remain constant regardless of alterations) can be found in the ‘Code’ column of the status configurations table.
This section contains how to guides with respect to status code definitions in the Metrix Asset Management system.
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:
Navigate to the ‘Status Codes’ management page (Assets Menu > Status Codes).
Click on ‘Create New Status Code’ at the top of the page.
This will initialise a new status code and display a dialog box waiting for additional details.
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.
When you have finished defining the status code, click ‘Create’
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.
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:
Navigate to the ‘Status Codes’ management page (Assets Menu > Status Codes).
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.
Once finished, click on the tick icon at the right-end of the input box.
When a status code is no longer required, the Metrix Asset Management system provides functionality for administrators to permanently remove it from the system.
Deleting status codes cannot be undone. The following restrictions also apply when it comes to deleting status codes:
To delete a status code, follow these steps:
To begin deleting a status code, navigate to the ‘Status Codes’ management page (Assets Menu > Status Codes).
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).
In the subsequent dialog, confirm your decision by clicking ‘Delete’.
The status code will now be permanently deleted from the system.