System Navigation

Depending on your account privileges – which will be set by your system administrator – you will see different functions available to you when you first login. There are, however, a couple of core system pages that will be available to you regardless of your account privileges. This section details some of the basic facets of these pages.

1. To navigate to each page of the Metrix system, use the section header located at the top of the application. Regardless of where you are within the system, this section header will always be available. The section header will generally look like the following:

2. Review the Dashboard Page - The dashboard provides a quick and easy overview of some core statistics about your assets within the system. This can be useful for extracting charts and graphs for generating your Asset Management Plans and Policies. It is also handy for gaining a high-level snapshot of your asset performance.

3. Review the Assets Page - The assets page is the main engine room of the system. This is where users can view their asset portfolio through an intuitive map interface, fetch information, as well as perform edits on that information.

4. Review the Capital Page (permissions dependant) - The capital page is where you can manage your capital works projects. This includes the ability to create, edit, and track the progress of projects, as well as view associated costs and timelines. Additionally, you can manage settings such as the current financial year and the like.

5. Review the Operations Page (permissions dependant) - The operations page is where you can manage your operational activities. This includes the ability to create, edit, and track the progress of operational tasks. These can include maintenance activities, inspections, and other operational tasks related to your assets.

6. Review the Reports Page - The report generation page is full of predefined report templates to help you extract the information you need about your assets. Additionally, you can access previously generated reports from within this page.

7. Review the System Menu - In the top right-hand corner of the application, you will see a menu drop-down labelled with your organisation’s Site ID. This contains all site configuration options (if your account has the rights to see such settings). It is also where you can access and manage your Profile information and sign out of the application.

Initialising a Metrix Account

Before you can use your Metrix Asset Management System, you must have a valid Metrix account with which you can login with. To gain access to such an account, your organisation’s system administrator needs to generate an invitation for you to register. If you have not received an invitation, please consult your organisation’s system administrator.

Once invited, you will receive an email with your username details as well as a temporary password that you need to change immediately. Follow the ‘Sign In’ button from this email to perform the password change.

Your new password must meet the following requirements:

• Minimum length of 8 characters
• No spaces
• At least one uppercase letter
• At least one lowercase letter
• At least one number
• At least one special characters (excluding + and -)

Once you set and confirm your new password, you can safely delete the invitation email. Please note that the invitation email will expire after 7 days. At which time, a new invitation will need to be generated.

Logging in to Metrix

To log in to your Metrix Asset Management System environment, you will need to know your organisation’s Site ID and have a valid username and password for that environment. Your organisation’s Site ID is used within the web URL of your system.

Once you enter your organisation’s web URL, you will be presented with a login page. This page is requesting your username – which is your email address – and the password that you have defined when initialising your Metrix account (see Initialising a Metrix account for details on this).

Resetting your Password

If at any time, you forget your password for the Metrix Asset Management System, you can request a password reset from the main login page. To do this, complete the following steps.

1. Click on “Forgot Password” below the “Sign In” button and you will be redirected to the password reset page.

2. Enter your username – which is your email address – and click “Reset Password”.

3. At this point, you will be redirected to a password reset verification stage. A verification code will be emailed to your email address.

4. Once you have received your email, enter the verification code along with a new password. The new password must also meet the password requirements stipulated above (see Initialising a Metrix account for details on this).

Map View Tools

This page covers some of the basic navigation options available within the core ‘Assets’ page in the Metrix Asset Management system including:

• Pan / Tilt / Zoom the map window
• Info Tool
• Search

Map Window Pan / Tilt / Zoom

The built-in map window inside the main ‘Assets’ page supports various computer mouse gestures to interact with the map location and view. These are detailed below:

Pan:

Panning a map means to shift the map image relative to the display window without changing the viewing scale.

To pan the map window, hold down the ’left’ (main) mouse button and drag your cursor. The map will follow until you release the mouse button.

Zoom-In:

‘Zooming in’ refers to the action of adjusting the view of the map to make a specific area appear larger and closer.

To zoom in, scroll the mouse wheel up.

Zoom-Out:

‘Zooming out’ refers to the action of adjusting the view to make the image or area ot he map appear smaller and farther away.

To zoom out, scroll the mouse wheel down.

Rotate:

‘Map rotation’ is a way of viewing the map window from a different orientation.

To rotate the map view, hold down the ‘right’ mouse button and drag your cursor to the left of the map window. The map will continue to rotate in a clockwise direction until you release the mouse button.

Note: to rotate counter-clockwise, drag the cursor to the right.

Tilt:

‘Map tilt’ refers to the angle at which the map is being viewed from. By default, the tilt is ‘flat’ and being viewed from directly above. When ’tilted’, the map view is angled so that the user feels they are looking ‘along’ the map.

To tilt the map view, hold down the ‘right’ mouse button and drag your cursor up to the top of the map window. The map will continue to tilt until you release the mouse button.

Note: to reverse the tilt, drag the cursor down.

Info Tool

In order to interrogate an asset via the main ‘Assets’ page map window, pan & zoom the map window to the asset location and single click (left-click) on the asset’s spatial feature.

The info panel will appear/populate on the right hand side of the map window when one or more valid features have been interrogated by a click.

Search

In addition to basic pan and click operations, the Metrix Asset Management system contains a free text search tool that can navigate and select chosen results for you. To start a search, simply click inside the search pill at the top of the page, and begin typing your criteria. The following asset/component fields are included in the search index:

• Asset Description
• Asset ID
• Component Description
• Component ID

The search tool will begin looking for results immediately and render them in a box below the search pill. By default, ‘All Results’ will be shown. Users can however, refine their results to the following result levels:

• Assets
• Components
• Programmes

Info Panels

This section details the info panels available within the core ‘Assets’ page in the Metrix Asset Management system including:

• Component Info Panel
• Intervention Info Panel
• Transactions Info Panel
• Programming Info Panel
• Parent Asset Info Panel

Info Panel Tools

In addition to the above panel structures, various tools built into these information panels are also detailed, including:

• Actions Menu
• Map Zoom Options
• Expand/Collapse Content
• Information Shortcuts
• Collections Interfacing
• Managing Pending Edits
• Component Group Selection
• Copying Field Values

Basemaps & Focus Mode

The Metrix Asset Management system provides built-in access to publicly accessible aerial photography imagery as well as basemaps as backdrops to your asset portfolio. These layers provide users with helpful context on the area they are viewing in the map window. To further assist with seeing asset content in association with these layers, Metrix also contains some tools to modify which backdrop you are seeing, as well as the colour intensity of the backdrop in comparison to your asset portfolio.

Focus Mode

For nearly all users, there exists a colour combination that is hard to decipher between and thus difficult to read when displayed in a map window. To cater for this, the Metrix Asset Management map tools provide users with the ability to put the map backdrop into ‘Focus Mode’. This will binarise (to make black-and-white) the backdrop so that the colours of your asset portfolio are easier to distinguish.

View Aerial Imagery as Backdrop

To view the aerial imagery as a backdrop to your asset portfolio, simply click on the ‘Imagery’ button in the top-left hand corner of the map window. This will swap out the underlying view to the aerial photograph imagery configured for your environment. The screenshot below shows a map window with aerial imagery as the backdrop, split between focus mode and standard.

View Basemap as Backdrop

To view the basemap as a backdrop to your asset portfolio, simply click on the ‘Base’ button in the top-left hand corner of the map window. This will swap out the underlying view to the basemap configured for your environment. The screenshot below shows a map window with basemap as the backdrop, split between focus mode and standard.

Custom Filters

The Metrix Asset Management system is equipped with a built-in data filtering tool that works across a variety of pages and functions within the system. This allows users to create and manage subsets of their entire asset portfolio for viewing, reporting, as well as sharing with other users of the system. Additionally, the data filtering tools can aid in highlighting asset management targets within your asset portfolio - filters can be combined to create multiple restrictions on included components.

Saving & Sharing Filters

Once a filter has been configured, users can choose to save that filter for later reuse. Saved filters can also be shared so that all users of the system can leverage that filter set.

Filters across the System

In addition to the core ‘Assets’ page map window, the filter tool works across the Metrix Asset Management system in areas such as:

• Dashboards,
• Report Exports, and
• Capital Budgeting

This means that users can define a filter once, and then, view dashboard widgets as they pertain to that reduced data set only. Further more, users can create a filter and then export the results of that filter to a CSV report by choosing the filter in the reports page.

Filter Options

The following options are filterable in the Metrix Asset Management System:

• Asset Classification
• Component Group
• Status Code
• Reporting Category
• Condition
• Useful Life
• Residual Life
• Next Intervention Year
• Metric Values (area, length, diameter, height, length, volume, and width)
• Component ID list

Map Themes (Visualisation)

The Metrix Asset Management system is equipped with a built-in map theming tool that works automatically with your data and attributes. This allows users to visualise breakdowns of their entire asset portfolio, assisting in better and faster decision making. Additionally, these visualisation tools can aid in highlighting asset management targets within your asset portfolio.

Available Map Themes/Visualisations

There are a number of built-in map theme visualisations that are ready to work immediately for you. These cover a range of areas from lifecycle theming, to report category visualisations. The following details some of the available themes. This is not an exhaustive list, but provided for context on the types of themes provided.

General Map Themes

These map themes switch around the asset classification and status.

• Asset Class

This is the default visualisation theme for the system. Each component is coloured according to its Asset Class (the first level of the asset classification structure).

• Component Group

This theme colours according to the Component Group level of the classification structure. This offers far more granularity than the Asset Class theme.

Users should be aware of potential stacked geometry issues when using this theme.

• Status

The status theme colours each component geometry according to its current status code.

Intervention Map Themes

These map themes aim to highlight the lifecycle metrics associated with your asset portfolio.

• Condition

The condition theme displays components on a colour gradient from green (1 - excellent) to red (5 - really poor).

• Residual Life

This theme converts a component’s residual life to a percentage of its overall useful life. The result is then displayed on a colour gradient from green (100% remaining life) to red (0% remaining life).

• Construction Year

This displays components in a accordance with their recorded original construction date. This is a useful data audit tool as it will highlight anomaly records (in comparison to the surrounding asset components).

Report Categories

The system takes each of your configured report category configurations and automatically creates a map theme to render each component in accordance with their assigned option within that category (including missing or no assignments).

The map theme switcher will render an option for each configured report category.

Metric Attributes

The custom attribute form specifications contain several restricted attribute names that relate to component metrics such as width, length, height, etc. If any of these fields are implemented within your component custom attribute definitions, the map theme generator can style your geometries based on these numeric results.

Custom Attributes

Any custom attribute definition that is controlled by an option list will be available within the map theme switcher for render.

Collection Sets

The concept behind collections within the Metrix Asset Management system is to allow users to choose various components from a map or list, and build an actionable group from them. A collection, in other words, is a selection set that users can use in system actions.

Once a collection set has been constructed, users can use that collection to:

• Perform bulk data updates
• Schedule inspections
• Generate reports
• Create custom filters using the entities in the filter

When a component is included in a collection set, the spatial feature will be rendered with a halo, highlighting it to the user.

As mentioned in the above list, collections can be converted into permanent custom filters. User can also start a collection from the components resulting from an existing custom filter. There is a two-way interoperability at play here.

Spatial Features

An elemental facet of the Metrix Asset Management system is spatial representation of asset components. At a basal level, this is enforced by the mandatory requirement that every component maintained in the system MUST reference a valid spatial feature. The system has been built around the existence of spatial features, and several tools exist to make this both beneficial, and easy for end users, including:

• Feature sharing across asset components.
• Built-in geometry editing tools,
• Integration with 3rd party GIS editing platforms such as QGIS,
• Attribute updates tied to relative spatial properties, and
• Performing asset operations using spatial techniques (line split),

Shared Component Geometries

Each spatial feature in the system is its own record. That is, the geometry is not ‘just’ another attribute of the asset component. Instead, by maintaining spatial features as distinct entities, we are able to ’link’ a single geometry to more than one component. This means, you can have the same line feature representing the earthworks, base, and surface of your road asset. Editing the line once, will update the representation for all.

It should be noted, however, that this sharing feature is not mandatory. Within an asset, each component could have their own distinct spatial representation. YOu could even maintain a hybrid approach, with two components sharing a geometry, whilst a third maintains a distinct feature.

The only caveat is that geometries cannot be shared across components with different asset parents. The relationship must stay within a single asset.

Managing Spatial Features

The system come with built-in spatial editing tools for basic geometry creation and updates. These tools are simple to use and support all simple geometry types; points, lines, and polygons. In the case that your geometric construction requirements are more advanced that those offered in system, the Metrix Asset Management system has published a free to access QGIS plugin that can connect to your cloud environment (using your Metrix account details), view your geometry data, as well as make edits and save changes back to the system.

Asset Operations with Spatial Tools (the line splitting tool)

With such a strong relationship to underlying spatial features, the Metrix Asset Management system is able to leverage geometric principles in offering advanced asset management operations, in an easy to use and understand package. Such an operation is the ability for users to SPLIT assets or components at a given point with the system handling all the financial apportionment of capital value for them. This is great for recording partial renewals, re-segmenting your network assets to cater for additional installations.

Smart Attributes

Another added benefit of mandating spatial features is the ability to leverage spatial properties as attribute information. See smart attributes for more information.

Residual Life Calculations

In simple terms, the Residual Life is the number of years that a Component has left/remaining before a capital intervention is required. The Residual Life is calculated as the difference between its useful life and the Component’s age plus any residual life offsets (see below) recorded against the Component.

As a Component goes through it’s life, it is expected that it will degrade/age over the years. How any particular Component experiences this ageing process however, will be in accordance with some very local factors relevant to that Component only. This means that any one Component could under-shoot or exceed it’s expected useful life - it also exemplifies how a Component’s useful life is just an averaged expectation, rather than a hard-and-fast rule.

To cater for such variations to lifecycle patterns, the system allows for the Residual Life to be ‘set’ by the user at any point throughout the Component’s life cycle. That is, the user need not modify the useful life of each Component, but rather, can set the residual life to the value they see fit.

This translates to a residual life offset being inferred upon the Component. This residual life offset takes effect on the calculated residual life by being added to the calculated residual life.

It is for the reasons stated above, that the formula for Residual Life in the Metrix Asset Management system is:

It is important to remember however, the Component will NOT start ageing until it reaches it’s Initial Capital Anniversary date. By default, this is 30 June and is listed in th ‘Intervention Summary’ section of the Component info panel.

Inputs to Residual Life

The following provides additional details on the inputs to the residual life formula discussed above.

Residual Life Offset

A component’s residual life offset is an offset applied to the calculated ‘residual life’, to either increase or decrease the resulting value. The residual life offset is calculated by the Metrix Asset Management system as the difference between the calculated ‘residual life’ and the subjectively assessed remaining life. That is:

There is NO requirement of a user to consider the concept of residual life offset when altering the residual life of a component. In fact, a user can be safely ignorant of the concepts of residual life offset. All the user needs to supply (going by the above example) is that the residual life of the component should be 6, not 5. The system will take that value and calculate the +1 years offset in the backend.

If the user were to state that the residual life was actually 8, then the system would calculate an offset of +3 years.

As the residual life offset is applied to the residual life value after the initial basic residual life calculation takes place, the reported residual life will continue to decrease as time passes. The user does not need to do anything for this, the system will handle it all.

Capital Anniversary Dates

A Capital Anniversary date is a pre-ordained time of the fiscal year when a capital asset undergoes an ageing event. By default, Metrix environments are configured for annual (once per year) capitalisation. - however, this can be adjusted to suit the needs of the organisation to frequencies such as quarterly, monthly, or the like.

When a Component is first built, or renewed, it will receive a construction date and/or a last intervention date. The Capital Anniversary event relevant to this date is:

• the Initial Capital Anniversary. This is the date in which the Component will BEGIN ageing.

Throughout the Component’s life, two other Capital Anniversary events are continuously relevant to the Component - the Most Recent Capital Anniversary and the Next Capital Anniversary:

• the Most Recent Capital Anniversary is the most recent date in which the Component underwent an ageing event, and
• the Next Capital Anniversary is the next date in which the Component is scheduled to undergo a capitalisation event.

All of the above Capital Anniversary dates are listed in the ‘Intervention Summary’ section of the Component info panel.

Age

A component’s age is calculated as the difference between the first ‘capital anniversary’ that occurred after the component’s intervention date, and the most recent ‘capital anniversary’ to have passed.

Reports generated from the system support returning the age of a component at a date other than the current date. A report generated at a date of 2 years in the past, will return the age of the component at that date - not today.

Last Intervention Date

The last intervention date refers to the date in which a component last underwent capital intervention works relating to it’s treatment. This includes:

• the original_construction_date of the component,
• the date of major renewal works on the component, or
• the date of substantial upgrade works on the component.

The original_construction_date will NOT change following an intervention (i.e. a reseal for a road surface). Only the last intervention date will change over the course of a component’s lifetime.

Component Quantity/Size

The quantity/size of a component in the Metrix Asset Management system is stored within the ‘Cost Units’ value, in the ‘Intervention’ info panel. Given that component shapes and measurement techniques differ from type to type, and the method of ascribing a cost to that shape/technique is variable, the cost units value of a component is not restricted to a specific component metric such as length, area, volume, etc. Rather, the cost units number field is free to represent whatever quantity that is required to satisfy the assigned intervention treatment.

Metrix also supports the implementation of cost unit formulas to automatically calculate these values based off the value of certain metric fields. This is covered in another section pertaining to Smart Attributes and Cost Unit Formulas.

Component Treatments & Next Treatment

Intervention Treatments in the Metrix Asset Management System provide the ability for users to store and manage unit rates and default useful lives for a variety of component interventions. When assigned to a component group, treatment definitions are able to be used to define the current and/or next intervention method for given components.

Component Treatment

The current component treatment informs a component ‘Unit Rate’ (for current cost calculations), the ‘Default Useful Life’, as well as an indicator to the material and/or methodology used in it’s original construction. The later of these depends on the naming conventions used in defining intervention treatments.

Next Treatment

A component’s next treatment definition allows for users to record their ‘best guess’ how a component’s upcoming intervention treatment will be conducted. Such definitions can be based on:

• Estimated Cost: for works that may be based around an externally quoted price.
• Treatment with Override Unit of Measure: for works that will be conducted in accordance with a chosen treatment definition - but for a specific quantity of cost units.
• Treatment with Percentage of Component: for works that will be conducted in accordance with a chosen treatment definition - but for a percentage share of the component’s current cost units.

Financial Movements

The financial transactions ledger within the Metrix Asset Management system tracks the financial consumption and restoration of asset components over their lifetime. This data is then collated in a number of system reports that satisfy the financial reporting obligations of user organisations. The following outlines a number of terms used throughout the system, and how they tie into the financial frameworks in force.

Gross Value

The replacement cost of a component at the time of valuation (or revaluation). Gross value can increase or decrease over the life of a component through intervention actions such as additions or upgrades to the asset component. Another way that gross value increases or decreases is through indexation – this is essentially increasing the value of a component by a percentage amount, typically in line with CPI.

Accumulated Depreciation Value

The accumulated depreciation of a component is the sum of all depreciation transactions logged against it over its life time.

The formula for accumulated depreciation is:

In the Metrix Asset Management system, the accumulated depreciation is posted as a NEGATIVE NUMBER to reflect the fact that it is a ‘consuming’ factor.

Carrying Value

The carrying value of a component is the net worth of the component to the entity in adjusted terms. Carrying value is a calculated value that deducts the accumulated depreciation from the gross value. Given that the depreciation figure is already stored within the Metrix Asset Management system as a negative figure however, the formula for carrying value is:

Renewals and Depreciation

In the Metrix Asset Management system, a renewal expenditure is typically posted as a POSITIVE movement against the components accumulated depreciation. This is to recognise the fact that the action has ‘undone’ the financial consumptions of the past. In turn, the components carrying value (assuming renewal costs equal gross value and a fully depreciated component) is restored to its original gross value as expected.

Making a Selection

This guide provides an overview on how to make asset component selections from a map view withing the Metrix Asset Management system, including:

Selecting from the Map

1. When you wish to get information about an asset and/or component in your current map view, simply click on the spatial feature.

2. On the right-hand side of the window, an info panel will appear. If the area you clicked on contains more than one (1) valid asset component, you will be presented with the option to refine your selection down to the target component you want information about.

3. As seen above, each asset (falling in the range of your click location) will be grouped and the sub-components displayed for your choice. Click on the asset/component you wish to view.

4. The component info panel will then render for your chosen component.

   Info

   If the location of your mouse click only intersected one (1) component, you will be taken straight to this panel.

Changing Component Groups within an Asset

1. When viewing information about a selected component, you can switch to another component on the same asset using the ‘Components’ switcher on the left-hand side of the info panel.

2. Each available component group (on the asset classification configuration) will be rendered in this side panel. If the asset has one or more component entries against a particular component group, a component ID and status tag will be shown. Otherwise, it will state, ‘None’.

3. To view the information about one of the listed components in this list, simply click on that entry in this panel.

Changing Info Panel Display

1. To view different information about the selected component, users can simply switch between the tabs across the top of the info panel.
   Info

   The ‘Parent Asset’ tab contains asset level information and is therefore identical no matter what component within the asset you are viewing.

Using Custom Filters

This document provides an overview on how to filter your asset portfolio using the built-in custom filter tools, including:

Filtering Data

1. To get started using custom filters, navigate to the main ‘Assets’ map in the Metrix Asset Management system.

2. On the left hand side of the page, make sure the ‘Filter Data’ tab is activated.

3. Here, you will see a number of categories that can be used to filter the visible asset components in the map view.

   Note: If there is a current filter applied, clear it by following these steps.

4. Choose any category to begin your filter by clicking on the ‘filter pod’ for that category. For example: Click on ‘Condition’.

5. A menu fly-out will appear where you can then further define how you wish to apply the filter using the chosen category. These will typically be represented by checkboxes for restrictions to apply to your portfolio. For example: For condition, you may tick ‘Excellent’. This would restrict the visible asset portfolio to components with a Condition value of ‘Excellent’.

6. Filter conditions can be chained together. Click on another ‘filter pod’ and set some additional restrictions. For example: Click on ‘Residual Life Years’. The fly-out requests that you input two (2) values:

   a. The operator (<, >, =), and

   b. The value relative to the operator.

   Inputting > 6 would restrict the visible components to those with more than 6 years of residual life remaining.

7. To remove a specific filter definition, simply uncheck the restriction within that category. For value based filter settings, there is a ‘Reset’ option within the menu fly-out.

Clear the Filter

1. To clear an active filter, simply click the ‘return’ icon at the top of the filter panel. This will remove all of your configured filter settings.

   

   Note: This does not affect the settings of ‘Saved’ filters, but will clear the filter from being active.

Saving/Sharing a Filter Definition

1. The system supports the saving and sharing of filters. To do so, define your filter following the steps above.

2. Once you have finished configuring the filter properties, simply click on the ‘Save’ option at the top of the filter panel.

   

3. A fly-out menu will appear prompting you for a name for the new filter. Input a name for the filter (this is how you will find it later).

4. To opt to allow other system users to see the filter you have defined, toggle the ‘Shared’ control. By default, filters are private and NOT shared.

5. When you are done, click ‘Save’. The filter is now saved under that name. If you shared the filter, other users will see it in the ‘Filter Drop-Down’ at the top of the panel.

Using Save Filters

1. To use a predefined filter that you have saved, or another user has saved and shared, simply expand the drop-down menu at the top of the filter panel.

   

2. Here you will find a list of filters that can be applied. If you already have a saved filter applied, it will be highlighted in this menu.

3. To stop using the filter, either clear it, or select ‘No Filter’ from the ‘Filter Drop-Down’.

   Info

   The ‘Filter Drop-Down’ menu also contains a section for filters that were defined using a collection set. These can be accessed from the ‘Collection’ tab of the menu. More information on saving collection sets as filters can be found here.

Deleting a Saved Filter Definition

1. At any time, the user who created a custom filter, can delete that custom filter definition. This includes shared filters.

2. To delete a saved filter, click on the ‘Settings’ cog in the ‘Filter Drop-Down’ menu.

3. A dialog detailing each saved filter available to the user will then be displayed. Next to each of the filters in the table, is a button to ‘Delete’ the filter from the system. Click this button to delete the filter.

   Info

   If the ‘Delete’ button is not visible, or deactivated, it means that you do not own the filter.

Filter Actions

1. The ‘Filter’ panel also contains short-cuts to a few reports that can be generated using the current filter definition as a filter.

2. To use these action short-cuts, simply click on the ‘Filter actions’ menu at the top of the filter panel.

3. From the menu, choose which report you would like to generate.

   Info

   The filter does NOT have to be saved in order to generate a report in this fashion.

Using Map Themes (Visualisations)

This document provides an overview on how to use the built-in custom map themes in the Metrix Asset Management system.

1. To get started, navigate to the main ‘Assets’ map in the Metrix Asset Management system.

2. On the left hand side of the page, make sure the ‘Visualise By’ tab is activated. .

3. Initially, you will see a map legend for the currently applied map theme. By default, this is set to colour switch on ‘Asset Class’. To change the map theme to a different pre-configured visualisation, simply click ‘Switch Map Theme’ at the top of the panel.

4. This will now display all of the available built-in map themes in a range of contextual categories. .

5. To apply a specific visualisation, simply click on the tile in this view.

6. The theme will apply, and you will be returned to the ‘Legend View’ as it pertains to your chosen theme.

7. Repeat this process to go to another theme.

   Info

   Remember, the default map theme is called ‘Asset Class’. Choosing this theme will essentially reset your visualisations to system standard.

Component Change History

This document provides an overview on how to use the Component Change History Viewing tool in the Metrix Asset Management system.

1. To get started, navigate to the main ‘Assets’ map in the Metrix Asset Management system and select an asset record to bring up it’s Info Panel.

2. Ensure you have either the ‘Info’ or ‘Intervention’ panel tab open, and look for the ‘History’ icon along the right-hand side edge of the panel. A ‘History’ icon is available at the top of each ‘section’ of Info Panel content. .

3. A slide-out drawer will appear, initially with the Component’s current information listed. Only sections where history is tracked, are shown.

4. At the bottom of the slide-out drawer, you will see some navigation buttons. These allow you to move backwards and forwards through the change history of the active component. Additionally, around these navigation buttons, you will see the date and time of the change, as well as the name of user who made the change. .

5. Any differences that exist between the record version you are CURRENTLY VIEWING and the LIVE VERSION of the component record will be highlighted in red. In the example below, the current (live) value of the component’s length is 966.8467, whereas the historic value of this field value is 1150.6717. .

6. Additional indicators exist on each tab to guide users towards areas where changes exist on the current component version. These indicators are shown as a red dot next to the tab label. In the example below, the ‘Info’ and the ‘Intervention’ tabs contain changes, whereas the ‘Spatial’ tab does not. .

Building Collection Sets

This document provides an overview on how to use the collection set concept in the Metrix Asset Management system, including:

Defining a Collection Set

1. To get started, navigate to the main ‘Assets’ map in the Metrix Asset Management system.

2. On the left hand side of the page, make sure the ‘Collection’ tab is activated.

3. To start building your collection set, click the ‘Add with select tool’ option at the top of the panel. This will place you in ‘Selection’ mode where any clicked assets in the map view will add those asset components to your collection set.

   Info

   The selection tool will add ALL components from a clicked asset. It does, however, respect any applied custom filters that may be excluding some component types. That is, if you filter out road base and road earthworks (leaving just surface), and click on a road segment, only the surface will be added to your collection. Without a filter, all three (3) component groups will be added.

4. Once you have added some asset components to your collection, the ‘Remove with select tool’ option will activate as an optional mode. Using this mode will mean that every asset clicked on will REMOVE its components from your collection set (if they were a part of it).

5. Also, you have the option of simply adding ALL components from your current custom filter definition to your collection set. That is, if you have a filter that results in 15 components, then those 15 components would be added to your collection set.

6. Once you have finished defining your collection set, click the ‘End selection’ option which will be hovering at the top of the map window.

Collection Set Actions

1. Once you have a defined collection set, you can then perform actions on it including bulk data updates and generating reports.

2. To generate a report from the current collection set, simply click ‘Generate Report’ from the ‘Collection Panel’ and choose the report you would like to create. The results of the report will be filtered down to your current collection set.

   Info

   Other available collection actions are subject to their own instructions.

Saving Collection Set as Filter

1. Once you have finished building the collection, simply click on the ‘Save as filter’ option in the ‘Collection Panel’.

2. A fly-out menu will appear prompting you for a name for the new filter. Input a name for the filter (this is how you will find it later).

3. To opt to allow other system users to see the filter you have defined, toggle the ‘Shared’ control. By default, filters are private and NOT shared.

4. When you are done, click ‘Save’. The filter is now saved under that name. If you shared the filter, other users will see it in the ‘Filter Drop-Down’ at the top of the panel.

   Info

   Filters created from Collections will be listed under the ‘Collection’ tab of the ‘Filter Drop-Down’ list.

Staged Changes

Making edits to your asset information in the Metrix Asset Management system is a two-phased process. First, you make the alterations. Then, you save those changes (or discard them). Prior to this second step, the changes are considered to be STAGED, and awaiting final SAVE.

Users can make many edits in a single sessions before opting to save or discard the staged changes.

After your first alteration, you will notice that the ‘Save or Discard Edits’ button in the top-right hand corner of the page is now activated. Additionally, there is an orange marker line surrounding the info panel for the asset/component that the changes occurred on.

Prior to saving changes, users are provided the chance to review their work via a summary of the changes panel.

Basic Data Edits

With appropriate user rights, editing your asset information in the Metrix Asset Management system has been tailored to be super simple, and safe. To get started with editing your asset information, follow these steps:

1. Navigate to the main ‘Assets’ page and make a selection from the map screen.

2. Your asset and component data is displayed inside the info panel on the right-hand side of the page. This is where you will also edit the data.

3. To edit a field, simply click the information content - if the field is editable, and you have the appropriate privileges, the content will transform into an editable control. Depending on the field, users will be presented with one of the following controls:

   Instructions on how to use each of the above controls are discussed below.

Text Input Box

1. For alpha-numeric free text fields, the control that renders when you set it to edit mode will be a standard input box.

2. To edit content in an input box, simply locate your cursor and begin typing.

3. Once you have finished making your edits, click anywhere outside of the box to release the control.

4. The edits you made are now STAGED and ready to save.

Number Input Box

1. For numeric data fields, the control that renders when you set it to edit mode will be a standard number input/picker box.

2. To edit content in an input box, simply locate your cursor and begin typing.

3. Another option you have is to click the increase/decrease toggles on the right-hand side of the input box.

4. Once you have finished making your edits, click anywhere outside of the box to release the control.

5. The edits you made are now STAGED and ready to save.

Option Row

1. For list based data fields that have fewer than 5 options, the control that renders when you set it to edit mode will be an option row.

2. To alter or set the active choice in the option row, simply click that option.

3. The edits you made are now STAGED and ready to save.

Drop Down List

1. For list based data fields that have more than 5 options, the control that renders when you set it to edit mode will be an drop-down list.

2. To alter or set the active choice in the option row, simply choose that option from the list.

3. The drop down list control also supports filtering of the visible list items. To do this, simply type your filtering letters into the search box at the top of the list.

4. The edits you made are now STAGED and ready to save.

Calendar Picker

1. For date based data fields, the control that renders when you set it to edit mode will be a dynamic calendar control.

2. To edit content in a calendar control, simply choose the date value from the displayed calendar widget.

3. The calendar is month based. Users can change the visible month and year using the drop down options at the top of the control.

4. Some calendar controls are also pre-configured with ‘quick-dates’ allowing you to set the value to date such as ‘1 week ago’.

5. The edits you made are now STAGED and ready to save.

Save or Discard Changes

Making edits to your asset information in the Metrix Asset Management system is a two-phased process. First, you make the alterations. Then, you save those changes (or discard them). The following outlines how you can do this.

This document provides guidance on saving changes, as well as some other options around saving or discarding your changes, including.

For each of the following sections, we assume you have one or more pending changes to your asset information. If not, make some edits to your asset and/or component information.

After your first alteration, you will notice that the ‘Save or Discard Edits’ button in the top-right hand corner of the page is now activated. Additionally, there is an orange marker line surrounding the info panel for the asset/component that the changes occurred on.

Saving Changes

1. Start by reviewing your change(s), click on the ‘Save or Discard Edits’ button. A dialog will appear with a summary of the changes you have made to your asset and/or component data. Alterations are broken down by type, and summarised into affected record counts.

2. To commit the changes, provide a short comment about the alteration, and then click ‘Commit Changes’.

3. The data will then be permanently saved to your Metrix Asset Management system.

Saving Changes at a Specific Date

The Metrix Asset Management system maintains a full audit history of changes users make in the system. This audit history is available through the ‘Report’ generators - allowing a user to backdate certain reports, to get asset/component information as it was at a specific point in time.

To extend upon this capacity, the system also supports backdating the ‘Effective Date’ of an alteration so that it can be visible in specific reporting ranges.

1. Start by reviewing your change(s) - click on the ‘Save or Discard Edits’ button. A dialog will appear with a summary of the changes you have made to your asset and/or component data. Alterations are broken down by type, and summarised into affected record counts.

2. To set a specific ‘Effective Date’ for the alterations summarised, expand the panel below the current date (which is rendered at the top of this dialog).

3. The expanded panel provides options to override the ‘Effective Date’ with shortcut values, or a custom date entry. Make your selection for ‘when’ the change(s) should be applied.

4. The data will then be permanently saved to your Metrix Asset Management system, effective from the date you specify.

Discarding ALL Changes

1. Start by reviewing your change(s), click on the ‘Save or Discard Edits’ button. A dialog will appear with a summary of the changes you have made to your asset and/or component data. Alterations are broken down by type, and summarised into affected record counts.

2. On the bottom left-hand side of the dialog portal, a collapse panel is rendered offering you the option to ‘Undo all Changes’. Click on this panel.

3. The panel will expand, revealing an option to ‘Rollback Changes’. To continue with undoing any alterations you have made since your last save, click this button.

4. Any alterations you have made will be reverted, and your session restored.

Discarding Specific Component Alterations

1. At any time during an editing session, users can review what information has changed on a specific asset or component from right within the info panel. In the top right-hand corner of the info panel is an ‘Edits Indicator’ that appears when the active asset/component has pending edits against it.

2. Click on this indicator to see a brief summary of the changes.

3. To rollback all changes recorded against the active component, click on the ‘Rollback’ button inside this preview.

   Note

   This option only relates to COMPONENT data edits. It cannot be used to revert alterations made on the parent asset info panel.

Task Types

This guide provides an overview on how to create or edit task records in the Metrix Asset Management system. The areas covered include:

Viewing Task Records

1. Any task records that have been captured, will be displayed in the parent asset info panel (for records logged at an asset level), or the component info panel (for records logged against a specific component). To see the records, scroll to the bottom of the respective info panel, to the section titled ‘Task Data’.

2. The most recent entry will be displayed in a form layout. In the top right-hand corner of the form is an indicator (titled ‘More’) regarding how many records of that task type exist against the asset or component. Click this label to see more records.

3. The form view will expand at this point to a form view per task record, stacked and ordered by record date. Scroll this view to see the details of each entry.

Enter a New Task Record

1. To capture a new task data record, navigate to the relevant info panel. That is, to capture a record against the asset, go to the parent asset info panel. To capture a record against a specific asset component, go to that component info panel.

2. Scroll to the bottom of the info panel to where the task records are rendered.

   Info

   If no task types are assigned to the appropriate classification level, this section will simply state ‘No task types configured’.

   If more than one task type is assigned, they will each be listed in this section.

3. For the relevant task type definition, click on the ‘New’ button.

4. A fly-out panel will appear with the task form rendered in edit mode. Complete this form.

5. When you are finished, simply click ‘OK’ at the bottom of the form. To cancel, click the ‘X’ in the top right-hand corner of the form.

6. The new task record entry is now STAGED and ready to save.

Edit a Task Record

1. To edit an existing task data record, simply navigate to the record in the appropriate info panel. That is, for a record logged against an asset, go to the parent asset info panel. For a record logged against specific asset component, go to that component info panel.

2. Scroll to the bottom of the info panel to where the task records are rendered.

3. For the task type you are altering, click the ‘More’ option to expand the entries.

4. Each record entry rendered for the task definition will have an ‘Edit’ button at the top of it. Click this button.

5. A fly-out panel will appear with the task form rendered in edit mode. Update this form.

6. When you are finished, simply click ‘OK’ at the bottom of the form. To cancel, click the ‘X’ in the top right-hand corner of the form.

7. The modified task record entry is now STAGED and ready to save.

Delete a Task Record

1. To delete an existing task data record, simply navigate to the record in the appropriate info panel. That is, for a record logged against an asset, go to the parent asset info panel. For a record logged against specific asset component, go to that component info panel.

2. Scroll to the bottom of the info panel to where the task data records are rendered.

3. For the task type you are altering, click the ‘More’ option to expand the entries.

4. Each record entry rendered for the task type definition will have an ‘Actions’ button at the top of it. Click this button.

5. In the menu that flies out from this button, there will be a ‘Delete’ option. Click this option.

6. The task record entry is now STAGED for deletion. Simply save your changes for this to take effect.

Reshape/Replace Component Geometry

This section provides an overview on how to manage your spatial features within the Metrix Asset Management system. The context covered includes:

Reshaping an existing Component Spatial Feature

1. To alter the spatial feature of a component, select the asset and navigate to the appropriate component info panel.

2. Within the component info panel, is a section titled ‘Spatial’. To modify the current geometry without changing the geometry type (point, line, polygon), click ‘Reshape/Move’.

3. The info panel will hide itself and you will be immersed into the geometry editing view.

4. Make the desired edits to your geometry, according to its type of point or line/polygon.

5. When finished, click ‘End Editing’ on the panel at the top of the map window.

6. The updated geometry is now STAGED and ready to save.

Replacing an existing Component Spatial Feature

1. To replace the spatial feature of a component, select the asset and navigate to the appropriate component info panel.

2. Within the component info panel, is a section titled ‘Spatial’. To replace the current geometry by changing the geometry type (point, line, polygon), click the ‘Replace With’ menu.

3. From the menu list, choose the desired geometry type for the new spatial feature - point, line, or polygon.

4. The info panel will hide itself and you will be immersed into the geometry editing view.

5. Create the desired geometry type as either a point or line/polygon.

6. When finished, click ‘End Editing’ on the panel at the top of the map window.

7. The replaced geometry is now STAGED and ready to save.

For more information, see the helpful tutorial video below.

Confirming Shared Spatial Features

1. To confirm whether or not an active component spatial feature is shared with other components on the asset record, navigate to the parent asset info panel.

2. Within the parent asset info panel is a section titled ‘Component Spatial Breakdown’. This displays a table view specifying each asset component alongside the geometry number* that the component is using.

   

   In the above screenshot, the asset has four (4) components, and three (3) unique spatial features. The first and last component (in the table view) are using ‘Shape 1’* and the middle two components reference their own shape. We therefore know that ‘Shape 1’ is shared across those two components.

   * this number is dynamically generated and simply serves to inform whether a shape feature is used on more than one component.

Modifying Point Features

Point features support relocation.

Moving Points To move a point, simply:

1. Click once on its current location (it will change color to bright green).
2. Click-and-drag the feature from where it currently is, to where you wish it to be located.
3. Release to finish relocating.

When finished, click ‘End Editing’.

Modifying Lines & Polygons

Line/Polygon features support both relocation and reshaping.

Moving Lines/Polygons To move a line or polygon, simply:

1. Click once on any of the line/perimeter segments.
2. Click-and-drag (from that segment). The entire shape will begin to follow your cursor across the map.
3. Release to finish relocating.

Reshaping Lines/Polygons

To reshape a line or polygon, simply:

1. Click once on any of the line/perimeter vertex nodes (it will change color to bright green).
2. Click-and-drag (from that vertex node) from where it currently is, to where you wish it to be located.
3. Release to finish relocating the node.
4. Repeat the above for other vertex nodes that need moving.
5. To ADD a new vertex node, click once on one of the segment center marker (white dot).
6. A new vertex node will be created, click-and-drag it to the desired location.
7. Release to finish relocating.

Creating Point Features

To create a new point feature:

1. Simply click on the map window where you want the point to be located.
2. To alter this location after initial placement, follow the instructions to relocate a point

Creating Line & Polygons

To create a new line or polygon feature:

1. Click on the map window where you want the first vertex node to be located.
2. Then, continue to click map locations for each subsequent vertex node location.
3. Double-click to finish drawing new vertex nodes.
4. To alter the location of a vertex node after initial placement, follow the instructions to relocate a line/polygon

Assign/Unassign Report Categories (Tags)

This document provides an overview on how to assign and unassign specific report category tags from asset components in the Metrix Asset Management system. Please note that in order to use a report category, it must be first defined in the system configuration.

Assign Report Categories

To assign a report category (tag) against a component:

1. Navigate to the component info panel for the asset component.

2. Within the first ‘Identification’ section of the panel is a sub-section called ‘Report Categories’.

3. To add a new report category tag, click on the ‘+’ drop down list. The remaining available (not currently assigned to the active component) report categories will render inside this menu.

   Info

   If the ‘+’ button is disabled, it means there are no available report categories, or, all report categories have already been assigned to the active component.

4. For each report category, the menu will render a sub-menu so that you can choose the tag to apply. Choose the desired combination you wish to apply.

5. The category assignment is now STAGED and ready to save.

Unassign Report Categories

To unassign a report category (tag) from a component:

1. Navigate to the component info panel for the asset component.

2. Within the first ‘Identification’ section of the panel is a sub-section called ‘Report Categories’.

3. Current assignments will display in this section. On the right-hand side of each rendered category tag, there is a ‘-’ (remove) icon. To unassign the category tag, simply click this icon.

4. The category un-assignment is now STAGED and ready to save.

Update Condition

This document provides an overview on how to set or update the condition score of an asset component in the Metrix Asset Management system. Please note that in order to use CUSTOM condition assessments, one must be first defined and assigned to the relevant component group in the system configuration. Otherwise, the default condition assessment form will be used.

To set/update the condition for a component:

1. Navigate to the desired asset component and select the intervention info panel.

2. At the top of the intervention info panel, the current condition is summarised. If this part of the info panel is not currently expanded, click on ‘Show More’ to expand it.

3. Click on ‘Update Condition’

4. A fly-out panel will then appear with the condition form rendered in edit mode. Fill out this form.

5. When finished, click ‘Update Condition’ at the bottom of the form.

6. The new condition entry is now STAGED and ready to save.

Update Treatment

This document provides an overview on how to set, update, or remove an intervention treatment of an asset component in the Metrix Asset Management system. Please note that in order to use an intervention treatment definition, it must be first defined and assigned to the relevant component group in the system configuration.

To set/update the intervention treatment for a component:

1. Navigate to the desired asset component and select the intervention info panel.

2. Within the intervention info panel, the current treatment details are summarised. If this part of the info panel is not currently expanded, click on ‘Show More’ to expand it.

3. Click on ‘Update Treatment’

4. A fly-out panel will then appear with a list of assigned intervention treatments as well as other intervention related settings.

5. For your first step, choose the appropriate treatment from the list of treatments by clicking on it. Alternatively, to completely clear the component’s treatment definition, select ‘Unassign Treatment from Component’ at the bottom of the table.

6. At the bottom of the panel, a brief summary of the change is rendered. Additionally, there is a checkbox asking if you wish to change any associated details along with the treatment. To update the:

   • Last Intervention Date,
   • Useful Life, and
   • Residual Life, toggle the checkbox. Doing so will set the intervention date to today, the useful life to the treatment definition’s default useful life, and the residual life to be equal with useful life.

7. For the above associated lifecycle metrics, users are able to overwrite the default values generated by the system. Simply input any adjustments to the Last Intervention Date, Useful Life, and/or Residual Life as deemed fit.

   Info

   Be aware that the useful life cannot be exceeded by the residual life. Also, when setting a value for the residual life, please be aware that the default effective date for the residual life offset is today. See Residual Life Calculations

8. When finished, click ‘Apply Condition’ at the bottom of the form.

9. The new treatment and any associated changes are now STAGED and ready to save.

Update Next Treatment

This document provides an overview on how to set or update the next treatment specifications of an asset component in the Metrix Asset Management system. Please note that in order to use particular treatment definitions, they must first be defined and assigned to the relevant component group in the system configuration.

To set/update the next treatment specification for a component:

1. Navigate to the desired asset component and select the intervention info panel.

2. Within the intervention info panel, the current definition for the next treatment is summarised. If this part of the info panel is not currently expanded, click on ‘Show More’ to expand it.

3. Click on ‘Update Next Treatment’

4. A fly-out panel will then appear with the options for setting the next treatment specification.

5. The first part of the panel requires users to choose the manner in which the component next treatment is being specified. This is either:

   • Estimated Cost: If choosing this method, enter the estimated cost of the next treatment into the input box below the radio button.
   • Treatment with Override Unit of Measure: if choosing this method, pick a treatment from the drop-down list, and also set an override value for the component cost units.
   • Treatment with Percentage of Component: if choosing this method, pick a treatment from the drop-down list, and also set an override percentage share for the component cost units.

   Set one of these options.

6. Next, set the estimated date for the next intervention treatment. This is an optional field.

7. Lastly, enter a description and reason for the next intervention treatment.

8. When finished, click ‘Apply Next Treatment’ at the bottom of the form.

9. The new treatment specification is now STAGED and ready to save.

Bulk Updates

This document provides an overview on how to perform bulk updates across many asset components in the Metrix Asset Management system. To use this feature, the components must be a part of an active collection set.

To perform bulk updates:

1. Navigate to the main ‘Assets’ map in the Metrix Asset Management system.

2. Build a collection containing the asset components you want to update.

3. When the collection is ready, click ‘Bulk Data Updates’ in the collection actions area. This will launch the ‘Bulk Data Update’ panel where assets and components within your collection are batched into their respective classification configuration.

Data Updates

4. To perform data updates, ensure you are using the ‘Data’ tab of the bulk panel and then locate the specific asset classification or component group on the left-hand side navigation tree.

5. On the right-hand side of the panel, a form will render showing you the possible data updates that you can make.

   Info

   At the top of this form, the number of assets or components (from your collection set) that are associated with the selected asset classification or component group will be rendered.

   Remember, any changes you make on this panel will be played out across all of those records.

Report Category Updates

6. To perform report category updates, switch to the ‘Assign/Unassign Report Categories’ tab of the bulk panel. Each report category defined in the system will be listed.

7. Click to expand the desired report category.

8. Each category has two options to choose from:

   • Bulk assign your collection set to a single report category option.
   • Bulk unassign your collection from one or more report category options. Choose options from the left or right-hand side controls based on your desired outcome.

9. When finished, click ‘Stage Changes’.

10. The updates are now STAGED and ready to save.

    Warning

    Bulk updating information is more prone to errors as the program cannot perform much of the validation until the save step of the process.

Component Finance Settings

This document provides an overview on how to set or update the financial settings for an asset component in the Metrix Asset Management system. These settings relate to how the component is going to be depreciated over it’s lifetime, including any residual value, and the rate at which it is consumed.

To set/update the finance settings for a component:

1. Navigate to the desired asset component and select the transactions info panel.

2. Within the transactions info panel is a section title ‘Financial Settings’. It is here that users can record such information.

Depreciable Value

3. To set or update the ‘Depreciable Value’, click on the current field value (it may be set to ‘Not Set’).

4. First, choose whether the ‘Depreciable Value’ is to be a fixed dollar value, or a percentage figure based on the component’s gross value. To completely remove the ‘Depreciable Value’ setting for the active component, choose ‘Not Set’ and skip the next step.

5. Set the numeric value that corresponds with the option you set in the previous step. For percentage figures, the value must be between 0 & 100.

Period Depreciation Value

6. To set or update the ‘Period Depreciation’ value, click on the current field value (it may be set to ‘Not Set’).

7. First, choose whether the ‘Period Depreciation’ value is to be a fixed dollar value, or a percentage figure based on the component’s gross value. To completely remove the ‘Period Depreciation’ value setting for the active component, choose ‘Not Set’ and skip the next step.

8. Set the numeric value that corresponds with the option you set in the previous step. For percentage figures, the value must be between 0 & 100.

9. The updated finance settings are now STAGED and ready to save.

Posting Component Transactions

This document provides an overview on how to create a new posting to the financial transactions ledger for an asset component in the Metrix Asset Management system. These transactions form the basis of a component’s capital valuation and an organisation’s end of period financial statements.

To post a new financial transactions ledger entry for an asset component:

1. Navigate to the desired asset component and select the transactions info panel.

2. Within the transactions info panel is a section title ‘Transaction History’. It is here that users can see past recorded movements, as well as post new ones.

3. To post a new financial transactions ledger entry, click ‘New Transaction’ at the top of the history summary table.

   Info

   If the summary table and/or the ‘New Transaction’ button is not displayed for your active component, it typically means that the asset component does not currently contain the prerequisite information for carrying capital value.

   This includes a valid construction date, and useful life. The reason for this constraint is to ensure organisations have sufficient information available to depreciate a component before ascribing capital value to it.

   A fly-out panel with a transaction generation form will appear.

   

4. Set the posting ‘Date’ for the new transaction. This is the date that the transactions value will be recognised by the system. The date cannot extend beyond the end of the current financial period (typically the end of the financial year).

5. Select the ‘Effect’ that the posting will have on the asset component. That is, will the posting affect the component’s gross value, or its accumulated depreciation value.

6. From the transaction ‘Type’ drop-down list, choose the desired transaction type for the new posting.

   Info

   Each transaction type in the list is tagged with the required polarity of the transaction ‘Value’ according to the chosen transaction type ‘Effect’. This will be either:

   • Positive: value must be greater than zero
   • Negative: value must be less than zero
   • Any: no restriction

7. Enter a transaction ‘Value’ with consideration for the polarity restriction for your chosen transaction type.

   Info

   For the ‘Depreciation’ transaction type, an ‘Estimated Annual Depreciation Amount’ figure will be displayed above the ‘Value’ input box for information purposes.

8. If the component does not currently carry any capital value, the ‘Finance Category’ will need to be defined next. Choose a valid finance category from the drop-down list. If your component already carries value, this drop-down will be disabled.

9. Lastly, enter a comment for the transaction.

10. When finished, click the button below the comment input box that contains a summary of the transaction.

11. The transaction has been generated and is now STAGED and ready to save.

Deleting Component Transactions

This document provides an overview on how to delete existing postings to the financial transactions ledger for an asset component in the Metrix Asset Management system.

To delete an existing financial transactions ledger entry for an asset component:

1. Navigate to the desired asset component and select the transactions info panel.

2. Within the transactions info panel is a section title ‘Transaction History’. It is here that users can see past recorded movements, and delete them.

3. In the transaction history table, each entry contains a ‘Delete’ option (rendered as a trash-can) on the far right-hand side of the row. To delete a transaction entry, click this button.

   Info

   When processing the deletion of one or more transactions, the system considers the following:

   • Following removal of the transactions, the component must not be left with a negative carrying value.
   • Transactions from previous financial periods cannot be removed.

   These restrictions do not apply to transactions that have not yet been saved/committed to the system.

4. Repeat the above step for each transaction that you may need to remove.

5. The transaction(s) have been STAGED for removal and are ready to save.

The Bare Minimum

The Metrix Asset Management system supports a wide scope of asset related data. When it comes to creating new records within your system, more information is always encouraged. As a minimum however, the following record types are required:

• Each asset must contain at least one (1) asset component record.

Additionally, the following resources or fields are MANDATORY:

• A valid asset classification and component group definition,
• A short Asset description and Component description,
• A valid Component status
• A valid Spatial Feature Definition

Creating Assets

Creating a new asset record in the Metrix Asset Management system is a simple process that involves choosing an asset classification, defining a spatial feature, and then populating the asset and component data fields.

To create a new asset record:

1. Navigate to the main ‘Assets’ page.

2. Above the map window, is a button titled ‘Create Asset’. Click this button.

3. A fly-out ‘Create New Asset’ panel will show at the bottom of the map window. Firstly, it will render a list of available asset classes configured in your system.

   Info

   The asset class is the ‘first level’ of the asset classification structure.

   Choose an asset class for your new asset.

4. The panel will then render the the list of asset classifications relative to your chosen asset class. Choose an asset classification for your new asset.

5. On the right-hand side of the panel, you will then be presented with options for creating the asset components. Firstly, confirm which component group(s) you wish to include as components for your new asset.

   Info

   For each component group that remains checked, the system will generate one (1) component.

6. Next, choose the initial status from the status drop-down list. The default status is ‘Proposed’. Each of the components, defined in step 5, will be assigned this status.

7. Then set the effective date for the new asset components via the calendar input control. Each of the components created, defined in step 5, will be generated as at this date.

8. The last step involved in creating a new asset is to define the spatial feature that will be assigned to ALL of the asset components, defined in step 5. Click on either

   • New Point,
   • New Line, or
   • New Polygon and digitise the spatial feature as per these instructions for points ↗ or these instructions for lines/polygons ↗.
   Info

   To finish digitising lines and polygons, simply double-click the map.

9. When you have finished digitising the spatial feature, click ‘Finish & Create’ at the bottom of the panel. Assets will be created immediately upon clicking ‘Finish & Create’. They do NOT go via the staged changes process.

10. The asset, once created, will then be selected and ready for you to update the attributes, intervention details, and condition as necessary.

Appending Components to Assets

Creating a new component record against an existing asset in the Metrix Asset Management system is a simple process that involves selecting the parent asset, choosing the target component group, confirming or defining a spatial feature, and then populating your new component data fields.

To create a new component record against an existing asset:

1. Navigate to the main ‘Assets’ page and make a selection from the map screen.

2. On the left-hand side of the info panel (right side of the page) the ‘Components’ switcher lists each component group (from the asset classification configuration) available to the asset. At the bottom of this listing, there is a button labelled ‘Add New’ and titled ‘Component’. Click this button.

3. A fly-out ‘Create New Component’ panel will show at the bottom of the map window rendering your component creation options. Firstly, confirm which component group(s) you wish to generate and append to the parent asset.

   Info

   For each component group that remains checked, the system will generate one (1) component.

4. Next, choose the initial status from the status drop-down list. The default status is ‘Proposed’. Each of the components, defined in step 3, will be assigned this status.

5. Then set the effective date for the new components via the calendar input control. Each of the components created, defined in step 3, will be generated as at this date.

6. The last step involved in appending components for an asset is to define the spatial feature that will be assigned to the new components, defined in step 5. Click on either

   • New Point,
   • New Line,
   • New Polygon, or
   • Create with / Choose from Current Asset Geometry

   New Spatial Feature

   If defining a new spatial feature, digitise the geometry as per these instructions for points ↗ or these instructions for lines/polygons ↗.

   Info

   To finish digitising lines and polygons, simply double-click the map.

   When you have finished generating or confirmting the spatial feature, click ‘Finish & Create’ at the bottom of the panel. To finish, click ‘Finish & Create’.

   Using Existing Spatial Features

   If you choose to inhertit the spatial feature from an existing component on the parent asset, one of two workflows will occur:

   • If the components of the parent asset rely on a single spatial feature, the fourth button option will be labelled ‘Create with Current Asset Geometry’. Clicking this option will complete the process and your new components will be appended to the parent asset and share the one spatial feature.

   • If the components of the parent asset rely on multiple spatial features, the fourth button option will be labelled ‘Choose from Current Asset Geometries’. Clicking this option will present another panel requiring you to choose which spatial feature to inherit.

     As you hover on each option row (representing a distinct spatial feature), the corresponding feature will be highlighted in the map window.

     Click a spatial feature row to choose your geometry. Then click ‘Create Component’.

   Components will be created immediately - they do NOT go via the staged changes process.

7. The components, once created, will then be selected and ready for you to update the attributes, intervention details, and condition as necessary.

Splitting Assets

The ability to split an Asset is vitally important in keeping the Organisation’s financial reporting, engineering concepts, and asset management data policies in sync. The core concept involves splitting a linear geometry (representing one or more Components associated with an Asset) at any given coordinate, at an effective date.

The returned feature set represents the two (or more in certain cases) new Assets, each containing a distinct copy of the original Components, with each new Component being proportionately associated with one of the two (or more) resultant geometries. The original Asset and Components are deprecated (see section on deprecation).

The following concepts are covered in this article:

Note: This article is specifically addressing Asset Split operations where the goal is to generate two (or more) distinct new Assets with their own Components (mirroring the original). Users may also be interested in reading about splitting asset components whereby the parent Asset is maintained, but a sub-selection of Components are split and duplicated within said parent Asset.

How a Split Works

The basic mechanics of the Asset Split operation is that a user submits a request to the system for a split to occur. The system will respond (assuming no errors occur) with the required Asset, Component, and Resource inserts and updates that need to occur. Accepting this response will process the Split operation. This process is summarised below:

1. User submits request for a split operation
2. System assesses the request and responds with a detailed summary of the inserts and updates required to achieve the split
3. User accepts the response, and the split occurs.

Requesting a Split

To request a split, the following information is required:

• The Split Level (split_level) which must be set to ‘asset’ for an Asset Split.
• The Asset Record ID (asset_uid) of the Asset being split
• The Splitting Blade definition (intersection_wkt) defined in Well Known Text.
• An optional Posting Date (posting_date) for when transactions associated with the split operation should occur. This field will default to the current date/time if empty.
• An optional Effective Date (effective_date) for when the split should occur. This field will default to the current date/time if empty.
• Optional Split Flags (flags) that can control facets of what will be copied across to the new Assets and Components. See ‘Advanced Splitting: Resource Exclusions’ for more information.

System Assesses the Request and Response

Upon receiving a split request, the system will review the prohibitions detailed in the section, ‘When a Split can Occur’. It will then commence building a response that (if accepted by the user) instructs the system on how to:

• Deprecate the Old (split) Asset and Components
• Create the new Asset and Components
• Append the appropriate valuations and resources to the new Assets and Components.

User Accepts the Response and the Split Occurs

After reviewing the response - where the user can investigate in detail what will and wont be created - the user can accept the response and the relative Split Operation will occur.

How the Split Works at a Geometry Level

In order to perform the split, the user must provide a splitting blade - a linear geometry that cuts across the Component geometry/geometries at the desired split coordinate. See screenshot below:

In the above screenshot, the Asset (Twynam Avenue) is highlighted in yellow and the user provided splitting blade is located about 25% along it’s overall length. For the purpose of this example, we will assume that Twynam Avenue has three (3) Components - earthworks, base, and seal - all sharing the same linear geometry running from Governors Parade to Barr Street.

Prior to the split, the Twynam Avenue Asset Components could be represented by the following (basic) attribute data set:

With the ID of the Asset and the definition of the splitting blade supplied, the system first derives the NEW Component Geometries that would result from the split operation. See screenshot below:

In the above screenshot, the split has occurred and the first of the resultant two geometries is highlighted in yellow. The remaining portion of Twynam Avenue is associated with the second of the resultant two geometries.

Following the split, Twynam Avenue is now two (2) distinct Assets whose Components could be represented by the following attribute data set:

Asset 1 (highlighted in yellow)

NOTE: the proportion of length between ‘Asset 1’ and the original Asset is assumed to be 25% - the System has returned the new Cost Unit values based on this geometric truth.

Asset 2 (not highlighted)

NOTE: the returned data for ‘Asset 2’ represents 75% of the original Cost Unit values. All Components have been duplicated to the second Asset and can be managed in isolation of Asset 1 from now on.

When a Split can Occur

The following restrictions are enforced by the system when a user attempts to perform an Asset Split operation:

• The splitting blade MUST pass through the subject Geometry/Geometries at some point.
• The construction/Intervention dates of the Components cannot be after the effective date.
• The status effect of the Components must be active.
• The Component must have no Transaction postings that occur after the posting date.
• The posting date must not conflict with a Locked Financial Year.
• Only linear Geometries can be split.

Resources Assigned to the New Assets

Following an Asset Split, the following resources are copied across to the new Assets. They are discussed in detail below.

• Original Attribution
• Transaction Summary
• Condition History
• Report Categories
• Task Records

Original Attribution

Each new Asset or Component record that is created will inherit it’s attribution from the original Asset or relevant Component. Attributes are copied to the new Assets and Components unchanged - The ONLY EXCEPTION to this is the cost units value, which is modified by the Component’s relative proportionality.

Transaction Summary

Each new Component record that is created will inherit a proportionate baseline value from the original relevant Component and the original Component’s Value is written-off. This means there is ZERO change in overall value in the system. Consider the following 50/50 split of a single Component into two (2) new Components.

The original transaction schedule would look something like this, with the carrying value displayed at the bottom.

As a part of the Asset Split operation, the following transaction schedule would be generated and applied. Note: transaction schedule simplified to years for the example.

By the end of the process, the valuation summary for ALL Components would be:

Condition History

For each newly created Component, the relevant Condition History is copied to across in a split operation. The term ‘relevant’ refers to whether or not the Condition record concerned the spatial bounds associated with the new Component (see section: Advanced Splitting: Multiple Geometry Features), as well as whether or not the Condition record existed at the ‘Effective Date’ for the split operation.

The following table details this concept of ‘relevant’ Condition history for an Effective Date of 12/10/2000. Note, each row represents a Condition record that lasts from the Assessment Date until the Assessment Date of the subsequent row. That is, the above Component was considered to be in Condition 1 from January 1993 to February 1997.

Note: this condition record is carried over, however the Assessment Date is set to the Effective Date (October 2000) and a comment is added to reflect the original Assessment Date.

Report Categories

For each newly created Component, the LATEST (as at the Effective Date) relevant Report Categories are copied across in a split operation. That is, if a Component held a Special Schedule 7 Category of ‘Roads’ at the Effective Date, each new Component would inherit this Report Category.

Task Records

For each newly created Component, the relevant Task Records are copied across in a split operation. This occurs at both the Asset and Component Register level. Please note, the same rules of ‘relevancy’ that apply to the Condition History, apply to Task Records.

What happens to the Original Asset and Components

Following an Asset Split operation, the original Asset and ALL of it’s Components are marked with a status code of ‘Deprecated’. This is a special system status code (that users cannot access) which marks the record as ‘superseded by another record or records’. Deprecated records remain in the system, but they are excluded from the default map view, tables, filters, dashboards, and reports.

Information associated with a Deprecated Asset record can be fetched via the NEW Asset record(s). Each new record maintains a ‘Deprecated Parent’ linkage back to the original Asset.

Note: In the case of an Asset Split operation, only the Asset records receive a Deprecated Parent link back to the original Asset. The Component’s do not receive such a linkage in this case as the operation was at the Asset level.

Advanced Splitting: Multiple Geometry Features

In certain situations, an Asset’s Components may not all be represented by the same Geometry record. See the cross-section view below:

In the above example, the Asset (Twynam Avenue) is associated with five (5) Components. An earthworks Components, represented by a single Geometry running from Governors Place to Barr Street. Two (2) base Components running from Governors Place to Matthews Street and then from Matthews Street to Barr Street. And Two (2) seal Components running from Governors Place to Matthews Street and then from Matthews Street to Barr Street (identical to the base).

Given the above scenario, if Poate Street was to be extended such that it now crosses Twynam Avenue, the Asset Management and Engineering principles may require Twynam Avenue to be now represented as two (2) Assets, split by it’s intersection with Poate Street. In this case, the splitting blade would look like the following:

In the above, the Twynam Avenue Asset is to be split by its new full intersection with Poate Street. For the purpose of the example, we will assume the split blade is 75% along the original Asset’s length.

The resultant Assets and Components of such a split are shown below. The original Seal 1 and Base 1 features are not altered by proportionality, they are simply copied and associated with the new, shorter, Twynam Avenue Asset. The Seal 2, Base 2, and Earthworks Components however, are split between the two new Twynam Avenue Assets.

In the above, the Twynam Avenue Asset is to be split by its new full intersection with Poate Street. For the purpose of the example, we will assume the split blade is 75% along the original Asset’s length.

The association and proportion share of the new Assets and Components can be represented in the following table. As can be seen, Base 1 and Seal 1 features are copied and wholly associated with the first Asset (Governors Pde to Matthews Street). However, the Earthworks, Base 2, and Seal 2 are copied and distributed across the splitting blade.

Splitting Asset Components

The ability to split a Component is vitally important in keeping the Organisation’s financial reporting, engineering concepts, and asset management data policies in sync. The core concept involves splitting a linear geometry ( representing one or more Components) at any given coordinate, at an effective date.

The returned feature set represents the two or more new Components, each containing a distinct copy of the original Components, with each new Component being proportionately associated with one of the two (or more) resultant geometries. The original Components are deprecated (see section on deprecation) and the new Components are inherited by the original Asset.

The following concepts are covered in this article:

Note: This article is specifically addressing Component Split operations where the goal is to maintain the single Asset parent. Users may also be interested in reading about asset splitting whereby the parent Asset is also deprecated and the result is two (or more in certain cases) new Assets with all new associated Components.

How a Split Works

The basic mechanics of the Component Split operation is that a user submits a request to the system for a split to occur. The system will respond (assuming no errors occur) with the required Component/Resource inserts and updates that need to occur. Accepting this response will process the Split operation. This process is summarised below:

1. User submits request for a split operation
2. System assesses the request and responds with a detailed summary of the inserts and updates required to achieve the split
3. User accepts the response, and the split occurs.

Requesting a Split

To request a split, the following information is required:

• The Split Level (split_level) which must be set to ‘component’ for a Component Split.
• The Asset Record ID (asset_uid) of the Asset that ‘owns’ the Component(s) being split.
• The Component Record IDs (component_uids) of the Component(s) that are being split.
• The Splitting Blade definition (intersection_wkt) defined in Well Known Text.
• An optional Effective Date (effective_date) for when the split should occur. This field will default to the current date/time if empty.
• Optional Split Flags (flags) that can control facets of what will be copied across to the new Components. See ' Advanced Splitting: Resource Exclusions’ for more information.

System Assesses the Request and Response

Upon receiving a split request, the system will review the prohibitions detailed in the section, ‘When a Split can Occur’. It will then commence building a response that (if accepted by the user) instructs the system on how to:

• Deprecate the Old (split) Components
• Create the new Components against the original Asset
• Append the appropriate valuations and resources to the new Components.

User Accepts the Response and the Split Occurs

After reviewing the response - where the user can investigate in detail what will and wont be created - the user can accept the response and the relative Split Operation will occur.

How the Split Works at a Geometry Level

In order to perform the split, the user must provide a splitting blade - a linear geometry that cuts across the Component geometry/geometries at the desired split coordinate. See screenshot below:

*In the above screenshot, the Asset (Twynam Avenue) is highlighted in yellow and the user provided splitting blade is
located about 25% along it’s overall length. For the purpose of this example, we will assume that Twynam Avenue has
three (3) Components - earthworks, base, and seal - all sharing the same linear geometry running from Governors Parade
to Barr Street.*

Prior to the split, the Twynam Avenue Components could be represented by the following (basic) attribute data set:

Assuming the user only wants to split the Base and Surface Components (leaving the Earthworks untouched), they would supply the Asset Record ID, and the two (2) Component ID’s relating to the Surface and Base. The system then derives the NEW Component Geometries that would result from the split operation. See screenshot below:

*In the above screenshot, the split has occurred and the first of the resultant two geometries is highlighted in
yellow - a portion of the base and seal will be associated with this geometry. The remaining portion of base and seal
Components are associated with the second of the resultant two geometries. The earthworks are still associated with the
original geometry record.*

Following the split, Twynam Avenue is still one distinct Asset, however, instead of having three (3) Components, it now has five (5). The new Component Structure (ignoring deprecated Components) would look like this:

NOTE: the proportion of length between the smaller geometry and the original Asset is assumed to be 25% - the System has returned the new Cost Unit values based on this geometric truth.

When a Split can Occur

The following restrictions are enforced by the system when a user attempts to perform an Asset Split operation:

• The splitting blade MUST pass through the subject Geometry/Geometries at some point.
• The construction/Intervention dates of the Components cannot be after the effective date.
• The status effect of the Components must be active.
• The Component must have no Transaction postings that occur after the effective date.
• The effective date must not conflict with a Locked Financial Year.
• Only linear Geometries can be split.

Resources Assigned to the New Components

Following a Component Split, the following resources are copied across to the new Components. They are discussed in detail below.

• Original Attribution
• Transaction Summary
• Condition History
• Report Categories
• Task Records

Original Attribution

Each new Component record that is created will inherit it’s attribution from the original relevant Component. Attributes are copied to the new Components unchanged - The ONLY EXCEPTION to this is the cost units value, which is modified by the Component’s relative proportionality.

Transaction Summary

Each new Component record that is created will inherit a proportionate baseline value from the original relevant Component and the original Component’s Value is written-off. This means there is ZERO change in overall value in the system. Consider the following 50/50 split of a single Component into two (2) new Components.

The original transaction schedule would look something like this, with the carrying value displayed at the bottom.

As a part of the Component Split operation, the following transaction schedule would be generated and applied. Note: transaction schedule simplified to years for the example.

By the end of the process, the valuation summary for ALL Components would be:

Condition History

For each newly created Component, the relevant Condition History is copied to across in a split operation. The term ' relevant’ refers to whether or not the Condition record concerned the spatial bounds associated with the new Component ( see section: Advanced Splitting: Multiple Geometry Features), as well as whether or not the Condition record existed at the ‘Effective Date’ for the split operation.

The following table details this concept of ‘relevant’ Condition history for an Effective Date of 12/10/2000. Note, each row represents a Condition record that lasts from the Assessment Date until the Assessment Date of the subsequent row. That is, the above Component was considered to be in Condition 1 from January 1993 to February 1997.

Note: this condition record is carried over, however the Assessment Date is set to the Effective Date (October 2000) and a comment is added to reflect the original Assessment Date.

Report Categories

For each newly created Component, the LATEST (as at the Effective Date) relevant Report Categories are copied across in a split operation. That is, if a Component held a Special Schedule 7 Category of ‘Roads’ at the Effective Date, each new Component would inherit this Report Category.

Task Records

For each newly created Component, the relevant Auxiliary Data Records are copied across in a split operation. Please note, the same rules of ‘relevancy’ that apply to the Condition History, apply to Task Records.

What happens to the Original Components

Following a Component Split operation, the original Components are marked with a status code of ‘Deprecated’. This is a special system status code (that users cannot access) which marks the record as ‘superseded by another record or records’. Deprecated records remain in the system, but they are excluded from the default map view, tables, filters, dashboards, and reports.

Information associated with a Deprecated Component record can be fetched via the NEW Component record(s). Each new record maintains a ‘Deprecated Parent’ linkage back to the original Component.

Advanced Splitting: Resource Exclusions

When requesting a Component Split operation, a user can supply some optional flags that will alter what resources the newly created Components will receive. The flags currently available in the system are:

• Apportion Cost Units (apportion_cost_units - true/false): If not supplied, this defaults to TRUE. This flag indicates that the user wishes for the Cost Unit values of each new Component to be proportionately set based on its ' share’ of the original Component. If set to FALSE, each new Component will receive a Cost Units value equal to that of it’s parent Component.
• Copy Condition History (copy_condition_history - string): If not supplied, this defaults to all. This flag indicates what sort of Condition History the user would like to translate to the new Components. The following options are available:
  • all (default): All relevant Condition history will be copied.
  • latest: Only the most recent Condition record (relative to Effective Date) will be copied.
  • none: No Condition records will be copied.
• Copy Report Categories (copy_report_categories - true/false): If not supplied, this defaults to TRUE. This flag indicates that the user wishes for the relevant Report Categories to be copied to the new Components.
• Copy Task Records (copy_auxiliary_data - string): If not supplied, this defaults to all. This flag indicates what sort of Task Record History the user would like to translate to the new Components. The following options are available:
  • all (default): All relevant Records will be copied.
  • latest: Only the most recent Record (relative to Effective Date) will be copied.
  • none: No Records will be copied.

Advanced Splitting: Multiple Geometry Features

In certain situations, an Asset’s Components may not all be represented by the same Geometry record. See the cross-section view below:

*In the above example, the Asset (Twynam Avenue) is associated with five (5) Components. An earthworks Components,
represented by a single Geometry running from Governors Place to Barr Street. Two (2) base Components running from
Governors Place to Matthews Street and then from Matthews Street to Barr Street. And Two (2) seal Components running
from Governors Place to Matthews Street and then from Matthews Street to Barr Street (identical to the base).*

Given the above scenario, if Poate Street was to be extended such that it now crosses Twynam Avenue, the Asset Management and Engineering principles may require the Component’s of Twynam Street to reflect this new extent. In this case, the splitting blade would look like the following:

*In the above, the Twynam Avenue Components are to be split by its new full intersection with Poate Street. For the
purpose of the example, we will assume the split blade is 75% along the original Asset’s length.*

The resultant Components of such a split are shown below. The original Seal 1 and Base 1 features are not altered by proportionality, they are therefore UNMODIFIED by the split operation. The Seal 2, Base 2, and Earthworks Components however, are split by the intersection blade.

*In the above, the Twynam Avenue Components are to be split by its new full intersection with Poate Street. For the
purpose of the example, we will assume the split blade is 75% along the original Asset’s length.*

The association and proportion share of the new Components can be represented in the following table. As can be seen, Base 1 and Seal 1 features are left UNMODIFIED. However, the Earthworks, Base 2, and Seal 2 are copied and distributed across the splitting blade.

Deprecated Records

Following an action that results in assets or components being regenerated into a new entity, the original records will be marked as ‘deprecated’. This is a special system status code (that users cannot access) which marks the record as ‘superseded by another record or records’. Deprecated records remain in the system, but they are excluded from the default map view, tables, filters, dashboards, and reports.

Information associated with a Deprecated records can be fetched via the NEW (replacing) record(s). Each new record maintains a ‘Deprecated Parent’ linkage back to the original record. This can be accessed via the Actions menu at the top of the info panel.

Finance Re-Categorisation

A component’s finance category is defined by the first entry into the financial transactions ledger posted against that component. Following that, all transactions against that component will utilise that same finance category. To change a component’s finance category, the adjustment must be recorded through the financial transactions ledger as a movement off the original category, and then on to the new category.

Below is a summary of the involved movements posted during a financial re-categorisation from ‘Roads’ to ‘Footpaths’.

Note: In the above example, the gross value is $200, and the accumulated depreciation is -$150

In the above schedule, the process involves:

1. Writing off the accumulated depreciation value from the old category
2. Writing off the gross value from the old category
3. Writing on the gross value for the new category
4. Writing on the accumulated depreciation value for the new category

Importantly, the net change in carrying value for the component is zero.

Financial Re-Categorisation

To perform a financial re-categorisation, firstly, ensure that you understand the purpose and implications of such a process. Then, simply follow these steps.

1. Navigate to the main ‘Assets’ page and make a selection from the map screen.

   Ensure the correct asset component is your active selection.

2. Within the transactions info panel is a section title ‘Transaction History’. It is here that users can see past recorded movements, as well as perform financial re-categorisations.

3. At the top of the ‘Transaction History’ section, click on the ‘Reclassify’ button.

   Info

   If the summary table and/or the ‘Reclassify’ button is not displayed for your active component, it typically means that the asset component does not have any transactions posted against it. This therefore indicates that re-categorisation is NOT necessary.

4. A fly-out panel will display, requiring the target finance category and posting date for the change to occur.

5. Enter the posting date for the financial re-categorisation to occur using the calendar input.

6. Select the target finance category from the drop-down list.

7. Provide an optional comment.

8. Click ‘Reclassify’ when ready.

9. This operation does NOT proceed via staged changes, and occurs immediately. You have successfully re-categorised your component.

Splitting Assets or Components

The ability to split an Asset is vitally important in keeping the Organisation’s financial reporting, engineering concepts, and asset management data policies in sync. This section provides an overview on two different methods supported by the Metrix Asset Management system to perform spatial, linear bisections of your assets or asset components.

• Split Asset
• Split Asset Components
• Explode Multi-Geometry features

For a basic overview of how splitting works, please see the video below:

Reclassification

From time to time, an organisation’s asset infrastructure will undergo different purposes - or data management practices may adjust. In these cases, it can become necessary to reclassify assets and/or components to different asset classifications (or component groups). This section provides an overview on two different methods supported by the Metrix Asset Management system to perform reclassification of assets (including the asset components) or components.

• Reclassify Asset
• Reclassify Component within Asset Classification

For a basic overview of how reclassification works, please see the video below:

Set Component Status

This section provides an overview on how to alter a component’s status code in the Metrix Asset Management system:

1. Navigate to the main ‘Assets’ page and make a selection from the map screen.

   Info

   Make sure you have the correct component selected - the one you wish to update the status for

2. The component’s status is referenced toward the top of the ‘Info’ tab in the component information panel. To the right of this label, exists an option to ‘Update Status’ for the active component. Click this drop down list and choose the desired status from the options presented.

   Alternatively, setting the status in an option in the Info Panel ‘Actions’ menu. From the ‘Actions’ menu, choose ‘Set Component Status’ and then, from the sub-menu, choose the target component status that you wish to set.

   

3. A fly-out panel will appear seeking confirmation for the status change. If the target status effect is ‘inactive’, the system will also generate the required financial transactions ledger postings required to successfully set the status.

   These transactions are designed to ensure that ‘inactive’ components (i.e. disposed) do not carry any value or have any gross value. If you proceed, the transactions will be posted to your ledger.

4. Once satisfied with the proposed change, click the confirmation button at the bottom of the panel.

5. This operation does NOT proceed via staged changes, and occurs immediately. You have successfully updated the status on your component.

Deleting Assets & Components

From time to time, you may create a new asset or asset component and that eventuates to being a mistake. For these scenarios, the Metrix Asset Management system has support for users deleting assets or asset components.

Delete Assets

To delete an asset record and its asset components:

1. Navigate to the main ‘Assets’ page and make a selection from the map screen.

2. At the top of the info panel, click the ‘Actions’ menu.

3. From the ‘Actions’ menu options, hover or select ‘Parent Asset Actions’ and then choose ‘Delete Asset’.

4. The asset deletion has been STAGED and is ready to save.

Delete Component

To delete an asset component from a parent asset:

1. Navigate to the main ‘Assets’ page and make a selection from the map screen.

   Info

   Make sure you have the correct component selected - the one you wish to delete.

2. At the top of the info panel, click the ‘Actions’ menu.

3. From the ‘Actions’ menu options, choose ‘Delete Component’.

4. The component deletion has been STAGED and is ready to save.

Classification Structure

Below is a representation of the asset classification structure within the Metrix Asset Management System. Each asset classification structure is broken into four levels being asset class, asset type, asset sub-type, and asset group. Each of these levels are hierarchical in that:

• Asset classes contain one or more asset types,
• Asset types contain one or more asset sub-types, and
• Asset sub-types contain one or more asset group.

Each asset in your Metrix Asset Management System will be assigned to an asset classification at the asset group level. Then, within the asset group definition is one or more component group definitions. Each component assigned to the asset will be ascribed to one of these component groups.

Classification 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 classification references.

Asset Classification ID

The asset classification ID references a classification structure down to the asset group level. Once a classification has been created, the ID value (which will remain constant regardless of classification alterations) can be found at the top of the classification configuration screen, below the ‘Classification Label’.

Component Group ID

The component group ID references a specific component group within a greater asset classification reference.Once a classification has been created, the ID value (which will remain constant regardless of classification alterations) can be found at the top of the classification configuration screen, below the ‘Classification Label’.

Navigating Classifications

To view your asset classifications:

1. Navigate to the system menu in the upper right-hand corner of the application and select the “Assets” option.

   

2. On the left-hand side of the application, you will notice a list of menu items. The Asset & Component Classification section is contained within the first option labelled, “Classifications”. If it is not already active, click on “Classifications”.

3. This “Classifications” management screen is broken down by asset class and then each class is segmented by the class’s types, the type’s sub-types, and lastly, the sub-type’s groups (asset group then contain one or more component types).

   To navigate the classification structure, simply choose an asset class, and then the type/sub-type/group combination your desire. The corresponding configuration and available component types will then be shown.

Creating Classifications

To create a new asset classification definition, you will need to have prepared the following pieces of information:

• The asset class name, or the name of an existing asset class that will contain the new classification asset type.

• The asset type name, or the name of an existing asset type that will contain the new classification asset sub-type.

• The asset sub-type name, or the name of an existing asset sub-type that will contain the new classification asset group.

• The asset group name.

To get started, click on “Create New Classification” on the “Classification” management page. A dialog box will appear to prompt you through the following steps.

1. Firstly, you need to select or define the asset class name for your new asset classification. Click on the “Select (or define new) class” drop down control and either select from the existing list of asset class names or create a new asset class by typing it into the input box and clicking “Add”.

   

2. Once the asset class is selected or inputted, the system will prompt for the asset type name that belongs to the above asset class.

3. Repeat the process defined in step 1 for asset type, asset sub-type, and asset group.

4. With the asset group defined, the system will then prompt for the component type definition(s).

5. The default “Composite” component type can be either left in place, r renamed.

6. To add additional component types, simple click “New Component Type” and provide a name for the definition.

   

7. Once satisfied with the new classification structure, click “Create Classification”. Your new classification will now be available for use.

Adding Component Groups to Classifications

If you have a pre-existing classification definition (class / type / sub-type / group) but you wish to further refine available component types by adding additional options, you can choose to create component types against existing asset classifications. To do so, select the desired asset classification from the “Classifications” management page, and complete the following steps:

1. In the “Classification Configuration” panel (on the right-hand side of the page), click on “New Component Type”.

   

2. For component type creation, there are two initial options under the ‘Add Mode’ section. You can create a component type from blank, or you can create a component type and base it’s initial configuration against a difference component type’s definition.

   From Blank

   To create from blank, simply type the new component type name in the input box and click “Create”.

   From Existing

   To create from an existing component type, select the desired component type definition to copy, and then type the new component type name into the input box. Click “Create” when ready.

3. Type the name of the new Component type.

   

4. Once finished, click ‘Create’ and your new component type will be ready for configuration.

Deleting Component Groups from a Classification

When a component group is no longer required within the scope of an asset classification, the Metrix Asset Management system provides functionality for administrators to permanently remove it from the system.

To delete a component group from an asset classification, follow these steps:

1. To begin, navigate to the component group within the asset classification using the ‘Classifications’ page. (Assets Menu > Classifications > Selected Classification > Selected Component Group).

2. Click on ‘Edit Configuration’ to enter allow editing the classification definition.

   

3. This will convert the view to an editing mode with some additional options. Make sure you have the desired component group selected (for delete) before continuing.

4. Click on ‘Delete Component Classification’ in the upper right-hand corner of the component configuration breakdown. If the button is not enabled, this means that the component cannot be deleted (see warning notes, above).

   

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

6. The component group will now be permanently deleted from the system.

Deleting Asset Classifications

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

To delete an asset classification, follow these steps:

1. To begin, navigate to the asset classification using the ‘Classifications’ page. (Assets Menu > Classifications > Selected Classification).

2. Click on ‘Edit Configuration’ to enter allow editing the classification definition.

   

3. This will convert the view to an editing mode with some additional options. Note: the selected component group will not have any impact on this process.

4. Click on ‘Delete Asset Classification’ in the upper right-hand corner of the parent asset classification configuration breakdown. If the button is not enabled, this means that the asset classification cannot be deleted (see warning notes, above).

   

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

6. The asset classification will now be permanently deleted from the system.

Form Definitions

The form manager allows users to create forms to capture data in a controlled yet customisable manner. It does this by providing:

• Unlimited data field count.

• User defined data types including:

  • Text fields
  • Number fields
  • Date fields

• List fields that give end-users a range of options to choose from for the answer.

• The ability to mark fields as required.

• Form sections to improve readability.

It should be noted that there are several functions within the system that support custom form definitions. These include, but are not limited to:

• Custom attribute forms for assets and components,

• Task Type forms, and

• Mobile Data Capture custom forms.

As such, the steps involved in initiating a new form definition can differ from case to case. However, once the form has been established, the construction and manipulation of the form’s attributes and layout is identical between cases.

Creating Forms

This section covers the necessary steps involved in creating a new form definition within the Metrix Asset Management System.

To create a new form definition within Metrix, complete the following steps:

1. From the Form Manager page within the Metrix configuration section, click on ‘Create New Form’.

2. On the right-hand side, a new default form definition will appear. This layout is the same for all types of form designers within the Metrix Asset Management System. That is, form element management on the left, form structure in the middle, and a form preview on the right.

   

3. Firstly, in the text input at the top of the form designer, give you form a title – this value is defaulted to ‘New Form’. Simply overwrite that value with the title of your form.

Adding fields to a form definition

4. Next, try adding a new field to the form definition. To do this, simply choose from the new attribute templates on the left-hand side of the form designer. Each of these templates offer a distinct set of default attribute field constraints, including:

   a. Text: A free text input field with no restrictions

   b. Whole Number: A numeric input field that restricts entries to whole numbers only.

   c. Decimal Number: A numeric input field that allows entry of numbers to decimal precision.

   d. Date: A calendar-based input field that allows users to pick date values.

   e. List: An empty option row configuration. Once configured, users will need to choose from the list of options presented.

   f. Yes/No: A preconfigured option row field. This is pre-populated with two options – ‘Yes’ and ‘No’.

5. Once you add the field, you will be presented with the attribute field configuration dialog.

   

6. In this dialog, you can alter the attribute label – this is defaulted to ‘New Field’ and should be replaced before you can commit the field.

7. Another option to set is the ‘Help’ option for the field. Attribute help, if set, will be shown to the user when they hover or click on the question-mark icon next to the field in the form layout. This can be a short sentence giving context to the attribute.

8. The ‘Required’ checkbox will allow you to set this attribute as NOT optional. This will mean users cannot save an entry until they fill out this specific (and any other required) attribute(s).

9. Lastly, for attribute configuration, you can alter the ‘Data Type’ and ‘Attribute Control’. These two settings essentially enable you to essentially overwrite the initial attribute template you chose in step 4. For example, assuming that you selected a ‘Text’ attribute template, you could change this to a ‘Whole Number’ for the ‘Data Type’ and/or ‘Options List’ for the ‘Attribute Control’.

Additional settings for ‘Options List’ Attributes

10. When the ‘Attribute Control’ is set to ‘Options List’ there are additional configuration steps that need to be completed before committing the attribute definition. That is, to set the option array that the user will be presented with. In the screenshot below, the attribute example has been configured with two (2) options – ‘Yes’ and ‘No’.

    

    The list contains four (4) columns. From left to right, they are:

    a. Label: This is the text that is displayed to the user.

    b. Value: This is the value that is stored as the actual attribute value.

    c. Is Active: This checkbox allows you to disable certain options from an Options List array.

    d. Delete (untitled): On the far right-hand side of each Options List configuration is a ‘minus’ symbol. This represents the ability to remove an Options List option from the configured list.

11. To add an option to the Options List configuration, simply click ‘Add Option’ at the base of the existing list. Fill out the ‘Label’ and ‘Value’ for the new option.

Adding Core Metric fields to a form definition

12. In addition to ‘Attribute Templates’, the left-hand panel also contains various predefined ‘Core Metric Field’ definitions that can be added to the form. These fields are special in the following ways:

    a. Metric fields can be used as a Data Filter.

    b. Metric fields can be used to define a Map Theme.

13. A ‘Core Metric Field’ definition is hard coded as a ‘Decimal Number’ field that is NOT marked as required. The following fields are preconfigured in the system:

    a. Length,

    b. Height,

    c. Width,

    d. Area,

    e. Depth,

    f. Diameter,

    g. Volume.

14. It should be noted that any single Core Metric Field can only be used once per form definition. That is, you cannot add ‘Height’ more than once to any one form – it can, however, be used on as many separate forms as you wish.

Managing Form Layout

15. With the desired attributes established on your form definition, you may wish to tweak the layout in one or more ways. The Metrix form designer allows users to do such quickly and easily.

    

16. To relocate an attribute within the form definition, you can click on the arrow up/down buttons on the centre form structure layout when in edit mode.

17. To remove a field from a form definition, you can click on the trash-can icon on the right-hand side on the field within the form definition.

Managing Form Groups

18. Lastly, one or more attribute fields can be grouped within a form section. To create a new field group, simply click ‘New Section’ on the left-hand side of the form designer (beneath the Core Metric Fields picker).

19. To move fields into the section, simply move the field up or down until its position is within the section outline. It should be noted that each group will default to the bottom of the existing form definition layout.

    

20. To rename a form group, click on the ‘Edit’ icon (pencil) next to the current group title. Replace the current title and save that change.

21. Form groups (and all of the attributes within that group) can be moved up and down the form in the same manner as individual attribute fields. To do so, use the up/down arrows beneath the group title.

22. To remove a form group from the form definition, click on the menu option (next to the up/down buttons). There are two options:

    a. Remove Section: This will remove the form group from the definition, but any attributes that were a part of that group will be retained, and simply left as un-grouped attributes.

    b. Remove Section and Fields: This will remove the form group as well as any of the attributes that were part of that group.

Editing Existing Forms

From time to time, it becomes necessary to edit the structure or contents of an existing attribute form. To do this, use the following steps as a guide:

1. Navigate to the form manager page (Assets Menu > Form Manager > Selected Form).

2. With the form you wish to edit selected, simple click on the ‘Edit Form’ button at the top of the form preview.

3. From here, the steps to alter the form contents are identical to creating a new form.

4. When you have finished the alterations, click on ‘Save Changes’. Alternatively, click ‘Cancel’ to revert to the original form.

Assigning Forms to Classifications

Once a form definition has been constructed, you can assign it to a specific classification (or a set of classifications) in order to use that form in production.

1. To begin assigning a form to a classification or set of classifications, navigate to that form within the Form Manager page (Assets Menu > Form Manager > Selected Form).

2. Underneath the form title, 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 ‘Manage Classification Links’.

4. A dialog box will appear with lists of available links that could be made. On the left-hand side, are Asset Classifications. On the right-hand side, are Component Classifications. These break down as follows:

   • Assigning a form to an Asset Classification will make the form behave as a custom form for an entire asset. That is, all Components of that Asset will share the attributes on that form.

   • Assigning a form to a Component Classification will only make the form available when users are editing that specific Component Type. Each Component within an Asset can have different form definitions (i.e. base vs seal forms).

   

5. To assign a form to a classification, simply click ‘Assign’ next to that classification title.

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

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

Using the filter options

8. 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.

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

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

Deleting Forms

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

To delete a form definition, follow these steps:

1. To begin deleting a form definition, navigate to that form within the Form Manager page (Assets Menu > Form Manager > Selected Form).

2. Underneath the form title, 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 Form’. If the button is not enabled, this means that the form cannot be deleted (see warning notes, above).

4. In the subsequent dialog, confirm your decision by clicking ‘Yes delete this form’.

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

Task Types

A Task Type specification is backed by the built-in form manager (see Form Management ) delivering the same freedom to record the information that matters to your organisation, without needing to fit within any predefined system limits. Each task definition is essentially an attribute form that can be posted against a component many times – to track the changes over time.

In information management speak, the task definitions offer one-to-many relationship capabilities.

Further to the above, a task definitions can also be linked to one or more attached documents and/or images. These attachments can be used to provide additional context to the task definition. When mobile application users interface with the task definition, they can view the attachments and download them to their device for offline. Sample use cases for task definition attachments include:

• A photo of a damaged component
• A PDF of a service manual
• A photo of a completed task

Creating Task Types

This section covers the necessary steps involved in creating a new task type definition within the Metrix Asset Management System. As the task types are backed by the form management system (see Form Management ), after a certain point the instructions will defer to the directions on creating/managing a form definition.

To create a new task type definition within Metrix, complete the following steps:

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

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

   

3. This will create and display a default task type definition with a single form field, ‘Comment’.

4. Replace the Task Type Name (‘New Form’) with a task name that relates to the new task, and then begin editing the task type form layout. For this, follow the steps outlined in Creating a new Form.

Editing Existing Task Types

From time to time, it becomes necessary to edit the structure or contents of an existing task type specification. To do this, use the following steps as a guide:

1. Navigate to the task types manager page (Assets Menu > Task Types > Selected Task Type).

2. With the task type you wish to edit selected, simple click on the ‘Edit’ button at the top of the preview.

3. From here, the steps to alter the form contents are identical to creating a new form.

4. When you have finished the alterations, click on ‘Save Changes’. Alternatively, click ‘Cancel’ to revert to the original form.

Task Type Attachments

Task Type attachments are used to provide additional context to a task definition. When mobile application users interface with the task definition, they can view the attachments and download them to their device for offline use. To add an attachment to a task definition, follow these steps:

1. Navigate to the ‘Task Types’ management page (Assets Menu > Task Types).
2. With the task type you wish to attach to selected, simple click on the ‘Add Attachments’ button at the top of the preview.
3. This will open a dialog box where you can upload the attachment. Supported file types include images, PDFs, and other common document formats.
4. Please note, that there is also the option to link to an existing attachment. This is useful when the attachment is already stored in the system, and you wish to link/share it with another task definition.
5. Once the attachment is uploaded, it will be displayed in the task type preview. You can add multiple attachments to a single task definition.

Assigning Task Types to Classifications

Once a task type has been constructed, you can assign it to a specific classification (or a set of classifications) to use in production.

1. To begin assigning a task type to a classification or set of classifications, navigate to that task type within the Task Type page (Assets Menu > Task Types > Selected Task Type).

2. Underneath the task type title, 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 ‘Manage Classification Links’.

4. A dialog box will appear with lists of available links that could be made. On the left-hand side, are Asset Classifications. On the right-hand side, are Component Classifications. These break down as follows:

   • Assigning a task type to an Asset Classification will make the task type available on the ‘Parent Asset’ tab of all child Components. That is, all Components of that Asset will share the task type.

   • Assigning a task type to a Component Classification will only make the task type available when users are editing that specific Component Type. Each Component within an Asset can have different task type links definitions (i.e. base vs seal forms).

   

5. To assign a task types to a classification, simply click ‘Assign’ next to that classification title.

6. To unassign a task type from a classification, simply click ‘Unassign’ next to that classification title.

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

Using the filter options

8. 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.

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

10. To filter by classifications that already have the task types assigned, mark the checkbox titled ‘Show Assigned Only’.

Deleting Task Types

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

To delete a task type definition, follow these steps:

1. To begin deleting a task type definition, navigate to that task type within the Task Type management page (Assets Menu > Task Types > Selected Task Type).

2. Underneath the task type title, 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’. If the button is not enabled, this means that the task type cannot be deleted (see warning notes, above).

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

5. The task type definition will now be permanently deleted from the system.

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.

Condition Function Scoring

The fundamental principle of condition functions within the Metrix Asset Management System is a guided questionnaire that accumulates weighted scores throughout its completion – with the ultimate score yielding a condition result. There is no limit on the number of questions that can be set within a condition function. The only requirement is that the total weight of scored results sums to 100. See below for an example condition function.

Question 1 - Weight 40% - Are there any potholes occurring throughout the segment?

Question 2 - Weight 30% - Are the any shoves occurring throughout the segment?

Question 3 - Weight 30% - Is there evidence of Cracking or Flushing?

Using the above example condition function as a template, the following results would be generated by the system as condition results.

The Metrix Asset Management System comes pre-configured with a default condition function for use by any newly created classifications. This function has one (1) question with five (5) answer options detailed below:

Question: Condition (Weight 100%)

As seen above, the default condition function simply defers the condition result to the end user’s subjective assessment.

Creating Condition Functions

This section covers the necessary steps involved in creating a new condition function within the Metrix Asset Management System. This extends to the initial creation of the function with scored & weighted questions, as well as additional information fields. In subsequent sections, details such as editing functions and assigning functions to component classifications is discussed.

To create a new condition function within Metrix, complete the following steps:

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

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

   

3. This will initialise and display a default condition function definition on the right-hand side of the page.

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

5. Next, you will define the condition score factors for the new condition function. This will form the set of questions asked of the user in order to derive a final condition score.

Defining Condition Score Factors

6. To initialise your first condition score factor, simply click on the ‘Add Condition Score Factor’ button.

   

7. Each condition score factor you define will require the following:

   a. Enter a Factor Label - this is the question that will be asked of the end user.

   b. Confirm a Factor Weight for the score.

   c. For each answer Option, provide an Option Label and Score.

   To perform the above steps, simply type these values into the corresponding form fields. In the screenshot below, the Factor Label has been set to ‘Question Label’, the Factor Weight has been set to 60%, the Option Label has been set to ‘First Option’ and the Option Score was set to 56.

   

8. To add more options to the condition score factor, simply click ‘Add Option’ and fill out the new Option Label and Option Score.

9. To add additional condition score factors, simply click on ‘Add Condition Score Factor’.

Defining Extra Information Fields

10. The Extra Information Fields allow you to create additional inputs for users to populate when completing condition assessments using the new condition function. An extra information field does not contribute to the overall condition score - rather, provides any required context you may wish to collect.

    To add new extra information fields to your condition function, simply click ‘Add Extra Information Field’.

    

11. Each extra information field you define will require the following:

    a. Enter a field label - this is the question that will be asked of the end user.

    b. If applicable, mark the extra field as required by ticking the checkbox, ‘Required’.

    c. Choose the response type as either ‘Text Value’ or ‘Option List’. See below for details on the two options:

    From Text

    This will present the user with a free text input field to respond to the extra information question.

    Option List

    This will require you to configure a list of valid answers to the extra information question.

    When using ‘Option List’, the extra information question must be marked as required.

    ‘Option List’ options can be added and removed once ‘Option List’ has been chosen from the drop down.

    

12. Once complete, simply click ‘Save Function’ to commit the new function.

Editing Existing Condition Functions

As your organisation’s Asset Maturity evolves over time, it may become necessary to alter your condition functions to reflect additional or revised data scopes. Typically, this involves adjusting some condition factor scores/weights, more or less condition factors, and/or adjusting extra field definitions. To edit an existing condition function, follow these steps:

1. Navigate to the desired Condition Function (Assets Menu > Condition Functions > Selected Function).

2. With the desired condition function selected, a preview of the definition will appear on the right-hand side of the page. This view will default to read-only. To begin editing the condition function, click the ‘Edit Function’ button.

   

3. Enter the required alterations to the selected condition function.

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

   

Condition Function Attachments

Condition Function attachments are used to provide additional context to a function definition. When mobile application users interface with the condition function, they can view the attachments and download them to their device for offline use. To add an attachment to a condition function, follow these steps:

1. Navigate to the ‘Condition Function’ management page (Assets Menu > Condition Functions).
2. With the condition function you wish to attach to selected, simple click on the ‘Add Attachments’ button at the top of the preview.
3. This will open a dialog box where you can upload the attachment. Supported file types include images, PDFs, and other common document formats.
4. Please note, that there is also the option to link to an existing attachment. This is useful when the attachment is already stored in the system, and you wish to link/share it with another condition function.
5. Once the attachment is uploaded, it will be displayed in the condition function preview. You can add multiple attachments to a single condition function.

Assigning Condition Functions to Classifications

Once a condition function has been constructed, you can assign it to a specific classification (or a set of classifications) in order to use that function in production when completing condition assessment inspections.

1. To begin assigning condition functions to a classification or set of classifications, navigate to that function within the Condition Function page (Assets Menu > Condition Functions> Selected Function).

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

3. At the top-right of this preview, is an ‘Actions’ menu that provides additional management options for the selected function. 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 Condition Functions.

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

7. To unassign a function 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 function assigned, mark the checkbox titled ‘Show Assigned Only’.

Deleting Condition Functions

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

To delete a condition function, follow these steps:

1. To begin deleting a condition function, navigate to that function (Assets Menu > Condition functions > Selected Condition function).

2. Underneath the condition function title, 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’. If the button is not enabled, this means that the function cannot be deleted (see warning notes, above).

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

5. The condition function will now be permanently deleted from the system.

Report Categories

Report Categories, sometimes referred to as Tags, in the Metrix Asset Management System provide the ability for users to apply custom levels of organisation to their asset portfolio. This has proven to be very useful for grouping otherwise unrelated assets and components together for specific reporting purposes.

A report categories is simply a custom category, set by your administrators, with pre-defined category options, also configured by your administrators.

Report Category ID

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 report category references.

Report Category & Option ID

The report category ID is the only way to make a valid reference to a report category & option combination from external locations such as API calls or CSV Data Imports. Once a report category has been created, the ID value (which will remain constant regardless of alterations) can be found in the report category preview table in the ‘Code’ column.

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:

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

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

   

3. This will initialise and display a blank report category definition in a new dialog window.

4. Set the new ‘Category Name’ by entering it into the text input.

5. Set the label for the first ‘Category Option’ for the report category by typing it into the corresponding option input.

   

6. To add additional ‘Category Options’ simply click on the plus (’+’) symbol next to one of the existing options.

7. To remove a ‘Category Option’ simply click the remove (’-’) symbol next to the corresponding option.

8. 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:

1. Navigate to the desired Report Category (Assets Menu > Report Categories > Selected Category).

2. 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.

3. 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.

4. 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’.

   

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.

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

1. To begin deleting a report category, navigate to that report category (Assets Menu > Report Categories > Selected Category).

2. 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.

3. 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).

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

5. The report category will now be permanently deleted from the system.

Status Code Effect

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:

Proposed:

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.

Active:

Assets that form part of the normal asset portfolio.

Inactive:

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.

Status Code 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 status code references.

Status Code ID

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.

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’

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.

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.

Finance Categories

The finance category is the principle categorisation field for the Financial Movement Report - the key input tool for an organisations ‘Infrastructure, Property, Plant, and Equipment’ statement. Typically, organisations will configure one finance category within Metrix for each desired reporting row within this end of period statement.

In practice, an asset components finance category is assigned via the first financial transaction ledger entry made against it. Each subsequent transaction, posted against that component, will inherit that finance category. To change a components finance category, a ‘Reclassification’ process must occur which will write-off the gross and accumulated depreciation value from the component under the ‘old’ category, and then write both back on against the ’new’ category (no value is created or lost, but the finance category will be changed).

Finance Category ID

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

Transaction Types

The transaction type is designed to inform the financial transaction ledger on the type of financial movement that the entry represents. Built-in transaction types include ‘Recognition’, ‘Renewal’, ‘Addition’, etc.

Transaction Type Effects

Each transaction type is assigned to a transaction type effect of ‘Gross’ and/or ‘Accumulated Depreciation’. When the Temporal Finance Report is generated, the movement results are summed into these transaction type allotments.

Restrictions can be applied to transaction type posting values such as ‘Positive Values’ only, or, ‘Negative Values’ only. This can assist with controlling end user input around expected movement behaviour in terms of capital value. For example, the built-in depreciation transaction type has a restriction of ‘Negative Values’ only because depreciation is always and only ever a decrement to an asset components carrying value.

Transaction Type ID

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

Creating Finance Categories

This section covers the necessary steps involved in creating a new finance category within the Metrix Asset Management System. This extends to the initial creation of the category along with a description. In subsequent sections, editing and deleting finance categories is discussed.

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

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

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

3. This will initialise a new finance category and display a dialog box waiting for additional details.

4. From here, you will need to set the ‘Finance Category Name’, and an optional ‘Description’ for the new category.

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

Editing Finance Categories

In the Metrix Asset Management system, editing a finance category is restricted to updating the description only. Other properties including the category name cannot be modified after initial creation.

To edit the description of a finance category, complete the following steps:

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

2. This page renders every finance category currently configured in the system. To edit a particular finance category 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 Finance Categories

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

To delete a finance category, follow these steps:

1. To begin deleting a finance category, navigate to the ‘Finance Categories’ management page (Assets Menu > Finance Categories).

2. This page renders every finance category currently configured in the system. To delete a particular finance category, 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 finance category cannot be deleted (see warning notes, above).

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

4. The finance category will now be permanently deleted from the system.

Creating Transaction Types

This section covers the necessary steps involved in creating a new transaction type within the Metrix Asset Management System. This extends to the initial creation of the type along with the type effect, and any value restrictions that may apply. In subsequent sections, editing and deleting transaction types is discussed.

To create a new transaction type within Metrix, complete the following steps:

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

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

3. This will initialise a new transaction type and display a dialog box waiting for additional details.

4. From here, you will need to set the ‘Transaction Type Name’, the ‘Transaction Type Effect’, and the ‘Transaction Type Value Direction’ for the new type. See Finance Ledger Codes.

5. When you have finished defining the transaction type, click ‘Create’

Editing Transaction Types

In the Metrix Asset Management system, editing a transaction type is restricted to updating the value restriction only. Other properties including the name cannot be modified after initial creation.

To edit the value direction restriction on a transaction type, complete the following steps:

1. Navigate to the ‘Transaction Type’ management page (Assets Menu > Transaction Types).

2. This page renders every transaction type currently configured in the system. To edit a particular transaction type value restriction, click on the pencil ‘Edit’ icon on the right-hand side of the ‘Direction’ field in the corresponding row.

   

3. Set the new transaction type value restriction to either ‘Negative Only’, ‘Positive Only’, or ‘Any’.

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

Deleting Transaction Types

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

To delete a transaction type, follow these steps:

1. To begin deleting a transaction type, navigate to the ‘Transaction Type’ management page (Assets Menu > Transaction Types).

2. This page renders every transaction type currently configured in the system. To delete a particular transaction type, 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 transaction type cannot be deleted (see warning notes, above).

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

4. The transaction type will now be permanently deleted from the system.

Component Flags

Component flags are simple ways to toggle the expected requirements of a component group. Such flags include:

Conditioned:

The conditioned flag indicates if components assigned to the relative component group will typically require condition assessments to be conducted. Setting this flag to ‘off’ will mean that any assigned components do not contribute to any ‘missing condition’ counts or filters.

Depreciable:

The depreciable flag indicates if components assigned to the relative component group will typically require periodic depreciation charged against its carrying value. This can be useful for report generation as well as tracking the state of the organisations depreciation runs.

Carries value:

The carries value flag indicates if components assigned to the relative component group will typically be posted against in the financial transaction ledger. This would be set to ‘off’ for non-valued assets that are included for reference or other reasons.

Smart Attributes

Smart attributes can be defined to link an asset components attribute to the underlying spatial feature, and setting its value to the length or area of said geometry. Once an attribute has been defined as a smart attribute for a given classification, its value can no longer be set by end users. Rather, any changes to the underlying spatial feature will trigger an update of the fields value.

In order to be defined as a smart attribute, the form field must be marked as required.

Cost Unit Formulas

Cost unit formulas can be defined to calculate an asset components cost unit value according to a user defined algorithm based on the underlying attribute form and/or any defined smart attributes. When a cost unit formula is defined and in force, end users will be unable to manually set the ‘Cost Units’ value for asset components within that component group.

Classification Resources

In addition to linking resources for use throughout an asset portfolio, the classification configuration screen allows you to set other properties that control the behaviour of assets and their components throughout the Metrix Asset Management system.

This includes setting resources for both:

• Asset level classifications, and
• Component group level classifications.

All classification linked resources can be managed from the classification configuration screen (in addition to the link portals on the resource management page). This includes the following resource types:

Asset Level Resources

• Attribute Form (see Attribute Form for details)
• Task Types (see Task Types for details)

Component Level Resources

• Attribute Form (see Attribute Form for details)
• Task Types (see Task Types for details)
• Component Flags (see Component Flags for details)
• Smart Attributes (see Smart Attributes for details)
• Cost Unit Formulas (see Cost Unit Formulas for details)
• Intervention Treatments (see Intervention Treatments for details)
• Condition Functions (see Condition Functions for details)

Define Cost Unit Formula

This section covers the necessary steps involved in creating a new cost unit formula for a given classification within the Metrix Asset Management System.

To create a new cost unit formula definition within Metrix, complete the following steps:

1. Navigate to the component group within the asset classification using the ‘Classifications’ page. (Assets Menu > Classifications > Selected Classification > Selected Component Group).

2. Click on ‘Edit Configuration’ to enter allow editing the classification definition.

   

3. This will convert the view to an editing mode with some additional options. Make sure you have the desired component group selected before continuing.

4. Within the ‘Data’ section, click on the drop down menu under ‘Cost Units Formula’.

   Note

   If this is not available, it means that a valid form definition does not exist for setting smart attribute definitions.

5. To define a NEW cost unit formula, click on the ‘New Cost Unit Formula’ option in the drop down list.

6. A dialog will appear ready to define the cost unit formula.

7. First, set the Formula Name by entering it into the input box.

8. Then, to define a cost unit formula, you will need to build a valid algorithm using:

   • Valid attribute definitions,
   • Fixed numeric values, and/or,
   • Basic mathematical operators.
   Note

   Remember that only attributes matching the prerequisite definitions will be shown.

   Within the ‘Formula Builder’ section is three (3) menu options that allow users to choose the next input or operator for the cost unit formula. As you select inputs/operators, the algorithm expression preview will populate for you.

   To edit or remove a particular input or operator, simply click on that entry in the algorithm expression to see a list of options for edit or removal.

   

9. Before you can commit any new or revised cost unit formula, you must test it. This involves providing ‘dummy’ values for any attribute fields in the algorithm. Once the ‘dummy’ values are set, click ‘Evaluate Formula with Test Values’.

10. The server will evaluate the formula and return a response. Make sure you verify this result yourself before continuing.

11. Once complete, click ‘Save Formula’.

12. Important: The cost unit formula has now been defined and is available for use. In order to actually use it for the selected component group, ensure you select it from the ‘Cost Unit Formula’ drop down list.

    Info

    Cost Unit Formula definitions are stored against the underlying form definition (as this is where the input attribute fields are defined). Any component group assigned to a form definition with one or more defined cost unit formulas, can use that formula.

13. Once you have finished click ‘Save Config Changes’.

Define Smart Attributes

This section covers the necessary steps involved in creating a new smart attribute for a given classification within the Metrix Asset Management System.

To create a new smart attribute definition within Metrix, complete the following steps:

1. Navigate to the component group within the asset classification using the ‘Classifications’ page. (Assets Menu > Classifications > Selected Classification > Selected Component Group).

2. Click on ‘Edit Configuration’ to enter allow editing the classification definition.

   

3. This will convert the view to an editing mode with some additional options. Make sure you have the desired component group selected before continuing.

4. Within the ‘Data’ section, click on ‘Manage Smart Attribute(s)’.

   NOTE: If this is not available, it means that a valid form definition does not exist for setting smart attribute definitions.

5. A dialog will appear showing all of the configured field definitions that match the prerequisites for smart attributes.

   To set a smart attribute as linked to the underlying spatial feature’s Length, check the corresponding box in the ‘Set by Spatial Length’ column.

   To set a smart attribute as linked to the underlying spatial feature’s area, check the corresponding box in the ‘Set by Spatial Area’ column.

   

6. Once you have finished, click ‘Done’. Then, in the main window, click ‘Save Config Changes’.

   

Bulk Update Smart Attributes & Cost Units

This section covers the necessary steps involved in recalculating and applying the values for smart attribute and cost unit formulas, for a given range of classifications within the Metrix Asset Management System.

To recalculate and apply the values for smart attribute and cost unit formulas within Metrix, for a given range of classifications, complete the following steps:

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

2. Click on ‘Actions’ menu at the top of the Classifications page, and choose ‘Update Smart Attributes and Cost Unit Formulas’ to launch the bulk editing tool.

   

3. A dialog will appear and ask you to select the Classifications that you want to roll the update for. Once you have ticked/unticked the relevant Classification(s) to update, select ‘Fetch Components for Classifications’.

   

4. The dialog will fetch this information from the server and then advise you of how many components would be affected by the update. Clicking ‘Proceed’, will proceed to update any Smart Attributes and Cost Unit Formulas for the selected components.

   

Import/Export Classification Configurations

At any time when using the Metrix Asset Management System, users can opt to import and/or export their classification configurations. This can be useful if you are working with a provided training or test environment and wish to migrate configurations between the two.

Exporting Classification Configurations

1. To get started, navigate to the ‘Export Configurations’ page. (Assets Menu > Export Configuration).

2. The export system allows users to export resource definitions at one or more of the following levels:

   • Specific Classes: an entire asset class definition. For example: all of the ‘Transportation’ class.
   • Specific Classifications: a single asset classification definition. For example: just the ‘Local Road’ asset group.

3. Each of the above level selectors will render a different list of available checkboxes to include in the export. That is, if you choose ‘Specific Classes’, you will be presented with a list of checkboxes representing each asset class configured in your system. If you choose ‘Specific Classification’ each asset group will be rendered with a checkbox.

   Simply tick the checkboxes you wish to include in the export.

   

4. Then, on the right-hand side, simply confirm which resources you want to include in the export by checking/unchecking resource types.

5. When ready, click ‘Generate and Download’.

   This will download a .json file that can be used in the following instructions for ‘Importing Classification Configurations’. Make sure you save the file in a location that you can easily access.

Importing Classification Configurations

1. To get started, navigate to the ‘Import Configurations’ page. (Assets Menu > Import Configuration).

2. From this page you can either drag and drop a valid configuration file (see above) in to file dropper, or click ‘Select a File to Upload’ to choose a file from your system.

3. The system will parse the supplied file and validate the classifications and resources included therein. A preview of the found elements will be rendered when ready.

   

4. To confirm the import, click ‘Import Found Configurations’.

5. The imported configurations are now ready to use.

Classification Resource Management

When defining classification resources within the Metrix Asset Management System, users are provided with a means of assigning that new resource to specific asset and/or component classifications. This is very useful for when you are building a particular resource, say an intervention treatment, for one (1) target classification. However, from time to time it may be necessary to manage resource assignments in bulk for a given classification. This guide will instruct you on how to do this in the system.

To begin assigning classification resources from within a classification definition in Metrix, complete the following steps:

1. Navigate to the desired classification, or the component group within the asset classification, using the ‘Classifications’ page. (Assets Menu > Classifications > Selected Classification > (Selected Component Group)).

2. Click on ‘Edit Configuration’ to enter allow editing the classification definition.

   

3. For asset classification level resources, the following resources can be linked via the configuration screen:

   • Attribute Form: select the desired form definition from the drop down list.

   • Task Types: click on ‘Manage Task Type Link(s)’ and choose the desired task type definitions from the dialog box. When complete, click done.

     

4. For component classification level resources, the following resources can be linked via the configuration screen:

   • Component Flags: simply check or uncheck the desired component flags.

   • Attribute Form: select the desired form definition from the drop down list.

     Info

     If any smart attributes or cost unit formulas are linked to the component classification, this option will be disabled.

   • Smart Attributes: see Smart Attributes for details

   • Cost Unit Formula: see Cost Unit Formulas for details

   • Intervention Treatments: click on ‘Manage Treatment Link(s)’ and choose the desired treatment definitions the dialog box. When complete, click done.

   • Condition Functions: select the desired condition function from the drop down list.

   • Task Types: click on ‘Manage Task Type Link(s)’ and choose the desired task type definitions from the dialog box. When complete, click done.

5. When complete, click ‘Save Config Changes’.

   

Users

The User Account and Access Control implementation within the Metrix Asset Management system is underpinned by an industry leading cloud-based solution for authentication and authorisation; ensuring the security of your asset data. Each and every user account within your environment can be entirely managed by your own system administrators via the restricted-access system administrations portal in the Metrix Asset Management system. Through this portal, system administrators can:

• Create new user accounts,
• Add or Remove role-based permissions for users, and
• Disable access for user accounts.

The user account creation process is provided as a fully self-service management system for system administrators to extend the accessibility of their environment. When creating a new account, a secure short-lived password will be emailed to the new user along with an invite to complete their account setup. At that point, the user will be prompted to initialise their own password - which is required to meet various constraints, including:

• Minimum length of 8 characters
• No spaces
• At least one uppercase letter
• At least one lowercase letter
• t least one number
• At least one special characters (excluding + and -)

Permissions

User permissions are managed through various pre-configured roles designed to function at a user activity level. Within each role, representing an end user activity, users can be given simple read, write, and/or delete permissions. Examples of such activity roles include:

• Managing asset/component information,
• Configuring classifications,
• System configuration,
• and more.

Disabled Accounts

Through the user management portal within the Metrix Asset Management system, administrators are able to disable system access completely for any user account. This action will leave the user profile setup within the environment, but prevent that account from logging into Metrix from anywhere.

Administrators, in addition to disabling access, can also re-enable account access via the same portal.

Creating New Users

This section covers the necessary steps involved in creating a new user account within the Metrix Asset Management System.

To create a new user within the Metrix Asset Management system, navigate to the System Admin menu from the profile menu, and then follow the steps below:

1. Select the ‘Users’ sections from the left-hand side navigation pane within the System Admin page.

2. The list of current user accounts will be displayed. At the top of the list, beneath the page header, click ‘New User’.

3. The page will then display a portal to setup the new account details. Firstly, enter the new users name in the ‘Display Name’ text input box.

4. Next, enter the users email address. This is where the temporary password will be emailed upon completion.

5. Lastly, choose the user’s default permission roles from the list of displayed checkboxes. As a minimum, at least ‘Asset Reader’ or ‘Mobile User’ should be chosen. See the

6. To complete the account creation, click ‘Create User’ at the bottom of the portal.

Managing Permissions

This section covers the necessary steps involved in managing user permissions within the Metrix Asset Management System.

To manage existing user permissions within the Metrix Asset Management system, navigate to the System Admin menu from the profile menu, and then follow the steps below:

1. Select the ‘Users’ sections from the left-hand side navigation pane within the System Admin page.

2. The list of current user accounts will be displayed alphabetically. Locate the user you wish to modify and click that row.

3. The details of the selected user will be presented. At the bottom of the page, a list of permission roles are rendered with checkbox controls. To add a role, check the adjacent checkbox. To remove a role, uncheck the adjacent checkbox.

4. To commit your changes to the system, click ‘Save’ at the top of the page.

Disabling/Enabling Accounts

This section covers the necessary steps involved in disabling and enabling user accounts within the Metrix Asset Management System.

To enable or disable existing users within the Metrix Asset Management system, navigate to the System Admin menu from the profile menu, and then follow the steps below:

1. Select the ‘Users’ sections from the left-hand side navigation pane within the System Admin page.

2. The list of current user accounts will be displayed alphabetically. Locate the user you wish to modify and click that row.

3. The details of the selected user will be presented. Within the top section of the page, a checkbox is rendered that allows you to disable or enable the user account. Toggle this checkbox accordingly.

4. To commit your changes to the system, click ‘Save’ at the top of the page.

Financial Years

The management of Financial Years within the Metrix Asset Management System is a feature available to system administrators. The two core concepts to discuss when it comes to the management of your system’s current financial year:

• Locking a financial year, and,
• Reverting to a previously locked financial year.

A financial year runs for a year from July to June.

The current financial year is defined as the period following the most recently locked financial year. If there is no locked year, the current financial year is calculated from the period of the first entry into the Financial Transactions Ledger.

Locking a Financial Year

Locking a Financial Year protects the Financial Transactions Ledger from being altered in any way that would result in the system being unable to reflect reported financial figures from a point in time. This is typically done following the generation of periodic (usually annual) financial statements, and the subsequent successful audit of said statements.

When a system administrator performs a lock on a financial year, the following outcomes are triggered:

• All transactions that occurred within, or prior to the locked financial year are no longer editable. That is, they cannot be deleted or altered in any way.
• This also has the effect of preventing any Components with transactions within a locked financial year from being deleted from the system.
• No transactions can be posted to the locked financial year or to a date in time prior to the locked financial year.
• The minimum date value for certain date calendar picker controls will be restricted to dates greater than the locked financial year.

Reverting to a previously locked Financial Year

When a system administrator reverts their system to a previously locked financial year, they would typically do so for the following reasons:

• The financial year was locked in error, or
• Using a Metrix environment in production whilst backlog data is still being migrated to a previous financial year.

The impacts of reverting to a previously locked financial year is simply that the system will then begin to behave as if it was indeed in the (now) unlocked financial year. No impact is caused to any entries within the Financial Transactions Ledger.

Locking a Financial Year

To process the locking of a financial year, follow these steps:

1. Navigate to the Capital Financial Year page (Capital > EOY Processing).

2. A financial summary of your asset portfolio is presented, along with a number of steps that are generally performed throughout a financial year.

3. Ensure you are satisfied with the completion or otherwise of each these steps by clicking on the bubbles denoting each sequence.

4. To perform a rollover and lock the current financial year, navigate to step 4 - Rollover.

5. Click ‘Rollover & Lock the X Financial Year’ (X will be replaced with the current financial year label).

6. To confirm this action, you will be prompted to type the current financial year into a text box, and then click ‘Rollover’.

7. The financial year has now been locked, and the system has progressed to the next financial year.

Unlocking a Financial Year

To process the reverting / unlocking of a financial year, follow these steps:

1. Navigate to the Capital Settings page (Capital > Capital Settings).

2. This page displays the current financial year, as well as the most recently locked financial year (if any).

   Info

   The current financial year is defined as the period following the most recently locked financial year. If there is no locked year, the current financial year is calculated from the period of the first entry into the Financial Transactions Ledger.

3. To revert or unlock a previously locked financial year, simply click on the button labelled ‘Unlock for Finance Posting’ adjacent to the ‘Latest Lock Year’ label.

4. Confirm you decision in the popup dialog.

5. The financial year has now been reverted to the previously locked year.

Ageing Periods

A Component Ageing Event date is a pre-ordained time of the fiscal year when an asset undergoes an ageing event - it gets older. By default, Metrix environments are configured for annual (once per year) ageing. - however, this can be adjusted to suit the needs of the organisation to frequencies such as quarterly, monthly, or the like.

When a Component is first built, or renewed, it will receive a ‘Construction Date` and/or an ‘Intervention Date’. The Component Ageing Event relevant to this date is:

• the Initial Ageing Event. This is the date in which the Component will BEGIN ageing.

Throughout the Component’s life, two other Component Ageing Events are continuously relevant to the Component - the ‘Most Recent Ageing Event’ and the ‘Next Ageing Event’:

• the Most Recent Ageing Event is the most recent date in which the Component underwent an ageing event (last got older), and
• the Next Ageing Event is the next date in which the Component is scheduled to undergo an ageing event (next gets older).

All of the above Component Ageing Event dates are listed in the ‘Intervention Summary’ section of the Component info panel.

Managing Ageing Events

This section covers the necessary steps involved in managing Component Ageing Events within the Metrix Asset Management System.

To manage ageing events within the Metrix Asset Management system, navigate to the System Admin menu from the profile menu, and then follow the steps below:

1. Select the ‘Home’ section from the left-hand side navigation pane within the System Admin page.

2. On this page, there is a section title ‘Component Ageing Period(s)’. In it, a button is titled with a brief description of the current ageing event configurations. Click this button to view the detailed ageing event configurations.

3. A dialogue window will then appear, showing the months within a fiscal year, and indicating which months are currently selected as ageing periods. Months that are coloured green are selected.

4. To add/remove months from the selected list, simply click the corresponding button.

5. Once you have made the necessary changes, click ‘Save Changes’ to apply the changes.

6. A confirmation window will appear, requiring you to confirm the changes. If you are sure you wish to proceed, tick the checkbox to confirm, and then click ‘Confirm Changes’ to finalise the changes.

What is a Budget

Within the Metrix Asset Management system, a Budget is a means of grouping together one or more different budget buckets - which are used to track the budgeted and actual values of a specific asset or group of assets. Budgets act as an entry point for users to view and manage their budget buckets in a controlled and structured way.

Create a Budget

In order to create a budget, simply navigate to the ‘Capital’ section of the application and, from the top-right corner, click on the ‘Create New Budget’ button. Follow the steps below to create a budget:

1. Enter a name for the budget.
2. Click ‘Save’ to save the new budget.

The new budget will now appear in the list of budgets. You can commence adding budget buckets to this budget.

Edit a Budget

In order to edit an existing budget, simply navigate to the ‘Capital’ section of the application and locate the budget in the list of budgets shown. Once found, complete the following:

1. Select the budget you wish to rename.
2. Click the ‘Edit’ button to the right-hand side of the budget name.
3. A dialog will appear with the budget name.
4. Enter a new name, and click ‘Save’.

Delete a Budget

In order to delete a budget, simply navigate to the ‘Capital’ section of the application and locate the budget in the list of budgets shown. Once found, complete the following:

1. Select the budget you wish to delete.
2. In the ‘Bucket’ panel, to the right of the budget list, find the ‘Actions’ menu (denoted with three dots).
3. Choose ‘Delete Entire Budget’ from the menu.
4. A confirmation dialog will appear, asking you to confirm the deletion of the budget. Click ‘Delete’ to proceed with the deletion.

The budget will be removed from the list of budgets and will no longer be available in the system.

What is a Bucket

Within the Metrix Asset Management system, a Budget Bucket is the key working unit for managing groups of budgeted items. A budget bucket can be likened to the idea of a Capital Project. Examples include the annual reseals program, installation of a new traffic signal, or a new footpath program.

A single Budget can have one or more budget buckets. Each bucket manages their assigned items independently of each other.

What is the Bucket Limit

The bucket limit is the maximum amount of money that should be spent within a bucket. This limit is set by the user and can be adjusted at any time. The bucket limit is important because it helps to ensure that assignments of work to the bucket are not exceeding the expected cost of the project. In fact, when assigning items to a budget bucket, the Allocation Tracker will compare the current amount in the bucket to the limit.

By setting a limit, users can avoid over-funding a bucket and can ensure that their money is being allocated to the right places.

Bucket Descriptors

Each budget bucket can have three (3) separate descriptor values, including:

• Description - a short description of the bucket
• External Ref - an external reference to the bucket
• Comment - a comment about the bucket

There are no restrictions to the use of these fields, but they are intended to be used as follows:

• Description - a short description of the bucket, such as “Marketing” or “Travel”
• External Ref - an external reference to the bucket, such as a project code or work order number
• Comment - a comment about the bucket, such as “This is a test bucket” or “This is a long term bucket”

Capitalisation Shares

Each budget bucket can be controlled with optional capitalisation share settings. The capitalisation shares refer to:

• Renewal - works that improve the condition of the asset
• New - works that result in a new asset
• Upgrade - works that expand the capacity of the asset

When you specify capitalisation shares on a budget bucket, you are controlling how any capital expenditures within the bucket are capitalised against the underlying components. For example:

• If you specify 100% renewal, then all capital expenditures within the bucket will be capitalised as renewals of the underlying components.
• If you specify 100% new, then all capital expenditures within the bucket will be capitalised as new assets.

A single bucket can have multiple capitalisation shares. For example, you can have a bucket with 50% renewal and 50% upgrade. In this case, all capital expenditures within the bucket will be split 50% to renewals and 50% to the improvement of capacity of the same assets.

The total percentage share across the three (3) categories must equal 100%. For example, a project that is 50% Renewal, and 30% Upgrade, must be 20% New; or else have additional weighting directed towards Renewal or Upgrade. In most cases, the Capitalisation Shares will be set to 100% for a single category (such as 100% New), and not split across two or three categories.

Bucket Allocations

A budget bucket’s allocation refers to the calculated cost of works associated with all the component items assigned to the bucket. As you add component items to a bucket, the allocation will be updated to reflect the total cost of all items in the bucket.

The calculated cost of work is based upon the component’s selected budgeted method. See Budgeted Treatment Methods for more information

Bucket Status

The status of a budget bucket can be useful for understanding the current state of the bucket and its contents. The following status indicators are currently available for budget buckets:

• Draft: Bucket items are still under scrutiny and not yet approved.
• Long Term: This status can be useful for marking buckets as back-logs.
• Set and Ready: This status indicates that the bucket items are ready to commence works.
• Underway: This status indicates that the bucket items are currently in progress.
• On Hold: This status indicates that the bucket items are currently on hold for some reason.
• Work in Progress: This status indicates that the bucket is long term, and some works were completed in a prior period.
• Pending Finalisation: This status indicates that works are complete, but the bucket is pending capitalisation.
• Closed: This status indicates that the bucket is closed and no further works are to be completed.

Currently, the ‘Closed’ status is the only status that affects how the system treats the bucket. Any closed buckets can not be edited or modified in any way. The system will also not allow the user to assign any new items or spend items to a closed bucket.

Bucket Default Filter

When working with an asset portfolio across many different asset/component types, it can become tedious to constantly filter your available items to the specific type that the bucket is designed for. This is why the concept of a default filter was introduced.

The default filter is a filter that is applied to the map when the bucket is opened. The filter does NOT control the items that are assigned to the bucket, but rather, it controls the items that are displayed in the map when the bucket is opened.

Create a Budget Bucket

In order to create a budget bucket, you must first navigate to the budget that will contain the bucket. Once you have selected the target budget, simply click on the ‘Create New Bucket’ button located in the top-left corner of the budget card. A dialog will appear prompting you to complete the following steps:

1. Enter the Bucket Name. This field is mandatory.
2. Enter a Limit for the bucket.
3. Enter a Description for the bucket.
4. Enter an External Ref for the bucket.
5. Enter a Comment for the bucket.
6. Enter Capitalisation Shares for the bucket. Capitalisation Shares (renewal/upgrade/new) must sum to 100%.

Once your have filled out the above fields, click ‘Save’ to create the bucket. The new bucket will now be visible against the budget.

Edit details of a Budget Bucket

In order to edit an existing budget bucket, simply navigate to the ‘Capital’ section of the application and locate the budget bucket you wish to modify. Once found, complete the following:

1. Select the bucket you wish to modify.
2. From the ‘Action’ menu (denoted with three dots) on the left-hand side of the budget card, click ‘Edit Active Bucket’.
3. Modify the desired fields in the dialog that appears.
4. Click ‘Save’ to apply the changes.

Delete a Budget Bucket

In order to delete a budget bucket, simply navigate to the ‘Capital’ section of the application and locate the budget bucket within the parent budget. Once found, complete the following:

1. Select the bucket you wish to delete.
2. Choose ‘Delete Budget Bucket’ from the ‘Actions’ menu (denoted with three dots).
3. confirmation dialog will appear, asking you to confirm the deletion of the bucket. Click ‘Delete’ to proceed with the deletion.

The budget will be removed from the list of budgets and will no longer be available in the system.

Bucket Default Filter

In order to set the default filter for a given Budget Bucket, navigate to the ‘Capital’ section of the application and locate the budget bucket within the parent budget. Once found, complete the following:

1. Select the budget you wish to rename.
2. On the right hand side of the bucket row, click on the ‘Manage’ button.
3. You will be navigated to the bucket’s default management page (view mode)
4. As the default filter pertains to the visibility of assets & components when assigning items to the bucket, the screen where you can set the default filter is located in the ‘Assign Items’ tab. At the top of the page, click on the ‘Assign Items’ tab.
5. You will then be taken to the ‘Assign Items’ page. On the left-hand side of the page, you will see the standard Metrix filter panel. At the top of this filter, you will see the standard Filter selection box.
6. From the Filter selection box, select the filter you wish to set as the default filter for this bucket.
   Info

   If no saved filters exist, you will need to save one first.

7. Once you have selected the filter, toggle the ‘Set as Default’ switch to set the active filter as the default filter for the bucket.

What is a Budget Bucket Item

An item within a Metrix Assets Budget Bucket is an Asset Component that has been assigned to the bucket, setup with a proposed budgeted treatment method, and hence, a proposed budgeted cost. The allocation of a budget bucket is the sum of all the bucket items within it.

In order to be assigned to a bucket as a bucket item, an Asset Component should have the following properties:

• a Valid Construction Date or Intervention Date value
• a Valid Cost Units value

Whilst the above requirements to not preclude the assignment of an Asset Component to a bucket, they do mean that the allocation assumptions and/or the capacity for the bucket item costs to be capitalised may be limited. Below are some details pertaining to these issues:

• Missing Construction Date: If a bucket item does NOT have a valid construction date, then the system will disallow capital spends within the bucket. This is because, presently, Metrix does not allow the creation of capital valuation transactions against components with no construction date.
• Missing Cost Units value: If a bucket item does NOT have a valid cost units value, then the system will calculate a ZERO dollar cost for any non-fixed price budgeted treatment method. This is simply because any treatment based budgeted treatment method will leverage the cost units value to calculate the budgeted cost.

Budgeted Treatment Methods

A budgeted treatment method is the method used to calculate the cost of works for a component item in a budget bucket. A budgeted method is chosen by the user for each component item in the bucket and can include:

• Current Treatment: The cost of works will be calculated using the current intervention treatment assigned to the component.
• Next Treatment: The cost of works will be calculated using the next intervention treatment assigned to the component.
• Budget Override: The cost of works will be calculated using a custom override method that applies to the current bucket, for the current component item only.

Upon assigning an item to a budget bucket, the system will automate the selection of the budgeted method as per the following:

• If the component item has a ’next treatment’ available, the budgeted method will be set to ‘Next Treatment’.
• If the component item has a ‘current treatment’ available, the budgeted method will be set to ‘Current Treatment’.
• Otherwise, NO budgeted method will be set and the calculated cost of works will be zero.

It should be noted, that for ‘Next Treatment’ and ‘Budget Override’ specifications, the following options exist:

• Treatment with Percent of Cost Units:
  • An intervention treatment definition is assigned as the treatment method.
  • The user will specify a percentage value (more or less than 100% permissible) to be applied to the Component’s cost units (size) to calculate the cost of works.
• Treatment with Fixed Cost Units:
  • An intervention treatment definition is assigned as the treatment method.
  • The user will specify a fixed value to be applied to the Component’s cost units (size) to calculate the cost of works.
• Fixed Value:
  • This method is useful when a quotation or fixed cost is available for the works.
  • No intervention treatment definition is assigned.

Selecting Items for Assignment

The following is a generic guide on making a selection set for assigning items to (or unassigning items from) a Budget Bucket. The process remains the same regardless of whether you are assigning singularly or in bulk.

To assign/unassign Components to a Budget Bucket as an item, you will need to have navigated to the desired Budget Bucket in the Capital module. The entry point for any budget bucket is the ‘View Items’ tab; navigate, using the tabs, to the ‘Assign Items’ tab to enter assignment mode.

From here you should see a map containing ALL the Asset Components in your portfolio. In the case that a Default Filter has already been assigned to the Budget Bucket, you will see all the Asset Components relative to that filter.

The most common approach to assigning items to a Budget Bucket is a two-step approach:

1. First, design a filter that scopes the visible Asset Components down to a relevant set of items. This is done using the ‘Filter’ on the left-hand side of the map window. For help with filtering, see this section.

2. Once you have a relevant set of Asset Components visible on the map, you can select them using either:

   • the ‘Info/Pan’ tool: allows you select one item at a time by clicking on the map feature.
   • the ‘Select’ tool: allows you to select multiple items by clicking and dragging a box around them. Any intersected map features will be APPENDED to your selection set.
   • the ‘Deselect’ tool: allows you to remove items from your current selection set by clicking and dragging a box around them. Any intersected map features will be REMOVED from your selection set.

   All of the above tools are available in the top-left corner of the map window. The ‘Info/Pan’ tool is the default.

3. The above process will result in a ‘selection set’ of one or more Assets. That is, selections are ‘Asset based’ meaning that one (1) selection could pertain to multiple Component records related to the same parent Asset record.

4. Your ‘selection set’ will be displayed in an Info Panel on the right-hand side of the map window. If your selection set contains more than one (1) Asset, the Info Panel will display the list of selected Assets, rather than details about any single Asset. Clicking one of the listed Assets will narrow your selection set to that Asset.

Assign a Budget Item

To assign a Component as an Item to a Budget Bucket, you must have navigated to the desired Budget Bucket, and have selected the parent Asset or Assets of the Components you want to assign. See Selecting Items for detailed instructions on doing this.

To assign a Component as an Item to a Budget Bucket, follow these steps:

1. Select a single Asset from the map using the above-mentioned methods. You will know that you have a single selected Asset when the Asset is highlighted in blue on the map, and the Asset’s details are displayed in the right-hand Info Panel.

2. The Info Panel is split into three main sections:

   a. The top of the Info Panel has information pertaining to the selected Asset, such as its classification, ID, and description.

   b. Below this, on the left-hand side, is the Component Switcher, which allows you to select a particular Component of the Asset to view its details, and manage its assignment state.

   c. The right-hand side of the Info Panel contains the Component information pertaining to the selected Component above.

3. Isolate the single Component you wish to assign to the Budget Bucket by selecting it in the Component Switcher.

4. Click on ‘Assign to Bucket’ to assign the selected Component as an Item to the Budget Bucket.

The Component has now been assigned to the Budget Bucket as an Item. It will be configured automatically with a default budgeted treatment method, and if this treatment method amounts to a cost, the Buckets Allocation gauge will react accordingly.

Further to the above, any assigned Component Items will appear with an orange halo around their map feature in the map window.

Bulk Assign Budget Items