Treatment IDs

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 treatment code references.

Treatment Definition ID

The treatment ID is the only way to make a valid reference to an intervention treatment from external locations such as API calls or CSV Data Imports. Once a treatment definition has been created, the ID value (which will remain constant regardless of alterations) can be found in the treatment preview under the section labelled, ‘Code’.

Treatment Cost Methods

Each intervention treatment unit rate will be based off one of the following three (3) ‘Cost Rate Methods’:

• Unit Rate: when the calculation of a components value is dependent on the size (or amount) of the component. The Unit Rate is multiplied by the component ‘Cost Unit’ value to yield the calculated cost. For Unit Rate, the formula for replacement cost is:

  $$\lbrack Unit\ Rate\rbrack\ \times \ \lbrack Component\ Cost\ Units\rbrack$$

• Fixed Value: when the components value is a known fixed figure. No calculation occurs for Fixed Value costs. For Fixed Value, the formula for replacement cost is:

  $$\lbrack Unit\ Rate\rbrack$$

• Network Asset: when the individual cost of the component is negligible; at a network level however, the cost of a large collection of said components is substantial, and that is what is stored. To calculate individual component cost of a Network Asset, the proportionate share of ‘Cost Units’ of the component is multiplied by the Network Asset value. For Network Assets, the formula for replacement cost is:

  $$\frac{\lbrack Unit\ Rate\rbrack}{\Sigma\lbrack Network\ Cost\ Units\rbrack} \times \lbrack Component\ Cost\ Units\rbrack$$

Creating Intervention Treatments

This section covers the necessary steps involved in creating a new intervention treatment within the Metrix Asset Management System. This extends to the initial creation of the treatment with basic field values. In subsequent sections, details such as attachments, bulk creation, and history will also be detailed.

To create a new intervention treatment within Metrix, complete the following steps:

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

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

   

3. This will create and display a default treatment definition on the right-hand side of the page.

4. From here, you will first need to set the ‘Treatment Name’ and provide a short ‘Description’ for the new intervention treatment. Simply type these values into the corresponding form fields.

5. Next, you will need to choose the ‘Cost Method’ of the intervention treatment. See (see Background for more information on choosing an appropriate method.

6. With the ‘Cost Method’ chosen, the interface will react by asking for follow up information related to this method. Firstly, you will need to set the ‘Unit of Measure’ for the intervention treatment. This is a free text field and is typically populated with values such as ‘metres’, ‘square metres’, and the like.

7. Next, set the ‘Unit Rate’ value – this is the dollar value unit rate for the treatment.

8. Lastly, set the optional ‘Default Useful Life’ field. This value, if set, will provide a suggested useful life to users applying this treatment to components.

9. Once all fields are completed as desired, click ‘Create’. The treatment has now been created.

Creating Intervention Treatments in Bulk

Given the breadth of scope surrounding intervention treatments, it can become overwhelming to consider keying each definition into the system manually. For this reason, the Metrix Asset Management System supports importing bulk treatment definitions through simply pasting compatible Excel/CSV data rows. The following instructions guide you through using this bulk import process.

1. Navigate to the Treatments management page (Assets Menu > Treatments).

2. Next to the ‘Create New Treatment’ button, click on the ‘Actions’ menu.

3. From the drop-down options, select ‘Import Treatments from CSV’.

4. A dialog will appear with an input for pasting Excel/CSV data, and some basic instructions on use. Before proceeding, consider the following notes on data formatting.

   a. The pasted data should NOT contain the header row.

   b. The pasted data should contain the following fields (in this specific order):

   1. Treatment
   2. Description
   3. Cost Method ID (see below for details)
   4. Unit Rate
   5. Unit of Measure
   6. Default Useful Life

   c. With regards to the Cost Method ID, the accepted values are:

   • For Unit Rate, use $ unit\_rate $
   • For Network Rates, use $ network\_assets $
   • For Fixed Rate, use $ fixed\_value $.

5. Paste your formatted data into the text box.

6. A preview of your pasted data will appear in a table view below the text box. Any errors will be highlighted in this preview.

   

7. To confirm the creation of the previewed treatments, click ‘Save’ below the preview table. Alternatively, click ‘Clear’ to cancel.

8. The imported treatments will now be created.

Editing existing Intervention Treatments

As conditions over time adjust, it becomes necessary to maintain your treatment definitions to reflect the new normal. Typically, this means updating unit rates, and/or default useful lives. To edit an existing intervention treatment, follow these steps:

1. Navigate to the desired Intervention Treatment (Assets Menu > Treatments > Selected Treatment).

2. With the desired treatment selected, an editable preview of the definition will appear on the right-hand side of the page.

3. Enter the required alterations to the selected treatment.

4. Once complete, simply click ‘Update’ to commit the changes.

   

Attaching Information to Intervention Treatments

Given the amount of detail that goes into calculating treatment unit rates and default life values, there is often a large amount of supporting documentation around the intervention treatments inside the Metrix Asset Management System. To assist with managing this information, the system makes it easy to upload these documents against the treatment definition directly. To do so, follow these steps:

1. Navigate to the desired Intervention Treatment (Assets Menu > Treatments > Selected Treatment).

2. With the treatment selected, a preview of the treatment definition will appear on the right-hand side of the page.

3. At the bottom of this preview, is an ‘Actions’ menu that provides additional management options for the selected treatment. Click on the ‘Actions’ menu.

4. From the drop-down menu, choose ‘Manage/View Attachments’.

5. The standard Metrix attachments interface will then display in a new dialog box. Any existing attachments will be displayed, as well as an option to upload additional documents.

6. To create a new attachment against the selected treatment, you can do one of the following:

   a. Drag and drop the file into the ‘drop space’ denoted by a dashed line. The attachment will immediately upload and be linked to the treatment.

   b. Choose the file from your file system using the file picker. To do this, click ‘Select File for Upload’ and then choose the desired file from the file picker. The attachment will immediately upload and be linked to the treatment.

   c. Choose from an existing attachment that is already linked to another Intervention Treatment. To do this, click ‘Link to an Existing Upload’ and choose the attachment from the subsequent list. This will mean that you do not have multiple copies of the same attachment but can still access it from many treatments.

7. Once finished, simply close the dialog box.

Viewing Intervention Treatment History

At any time in the Metrix Asset Management System, you can see the status of a treatment at any time in its history. To do so, follow these steps:

1. Navigate to the desired Intervention Treatment (Assets Menu > Treatments > Selected Treatment).

2. With the desired treatment selected, an editable preview of the definition will appear on the right-hand side of the page.

3. At the bottom of this preview, is an ‘Actions’ menu that provides additional management options for the selected treatment. Click on the ‘Actions’ menu.

4. From the drop-down menu, choose ‘Show Treatment History’.

5. A dialog box will appear, showing the earliest record of the current intervention treatment.

6. At the bottom of this preview are two arrows for navigating through historic versions of the treatment.

7. Just above these arrows, is an ‘Updated on’ field detailing when the change occurred.

Assigning Intervention Treatments to Classifications

Once a treatment definition has been constructed, you can assign it to a specific classification (or a set of classifications) in order to use that treatment in production as either a component current treatment, or next treatment.

1. To begin assigning treatment to a classification or set of classifications, navigate to that treatment within the Intervention Treatment page (Assets Menu > Treatments> Selected Treatment).

2. With the desired treatment selected, an editable preview of the definition will appear on the right-hand side of the page.

3. At the bottom of this preview, is an ‘Actions’ menu that provides additional management options for the selected treatment. Click on the ‘Actions’ menu.

4. From the ‘Actions’ menu, choose ‘Manage Classification Links’.

5. A dialog box will appear with lists of available links that could be made. It should be noted that only Component Classification links are valid for Intervention Treatments.

6. To assign a treatment to a classification, simply click ‘Assign’ next to that classification title.

7. To unassign a treatment from a classification, simply click ‘Unassign’ next to that classification title.

8. The system will manage the availability of the above buttons based on the form state in the system.

Using the filter options

9. When there are a great number of Classification configurations to wade through, it can become difficult to find the one you are after. This is where the filter option comes in handy. To filter the classification list, simply click on the ‘Filter’ icon at the top of the classification list – the icon looks a little like a funnel.

10. To filter by a specific letter or set of letters, simply type them into the text input that will appear above the classification list.

11. To filter by classifications that already have the treatment assigned, mark the checkbox titled ‘Show Assigned Only’.

Deleting Intervention Treatments

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

To delete a treatment definition, follow these steps:

1. To begin deleting an intervention treatment, navigate to that treatment (Assets Menu > Treatments > Selected Treatment).

2. On the bottom right-hand side of the treatment preview, there is an ‘Actions’ button – this type of button is implemented system wide as an indicator of additional options to manage a resource.

3. From the ‘Actions’ menu, choose ‘Delete Treatment’. If the button is not enabled, this means that the treatment cannot be deleted (see warning notes, above).

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

5. The treatment will now be permanently deleted from the system.