Update Existing Components

This document provides even more information as well as suggestions around importing data to update existing components
in the Metrix Asset Management system. It is broken into a number of sub-sections to assist readers in being able to focus on different asset management data contexts separately. These include:

Component Identity Data Fields

The following fields pertain to information that will be stored against each component in relation to the components identifying attributes.

Component ID
Required

The component record ID field links the incoming component update with the existing component record in the system.

This field is the unique ID of the component throughout the system.

  • Header label: component_record_id
  • This value is case sensitive and should be copied from the component info panel directly.

See also Component info panel ↗

Component Description
Required

This field provides a description of the component.

  • Header label: component_description
  • This value will be displayed in the ‘Identification’ section within the component info panel.
  • Users typically implement location and/or type based descriptors of their components.

See also Component info panel ↗

Component Intervention Fields

The following fields pertain to information that will be stored against each component in relation to the components intervention attributes.

Construction Date
Recommended

This field reflects the original date of construction/commission for the component.

  • Header label: construction_date
  • If the component carries value, the construction date must be supplied.
  • If setting the component’s useful life, the construction date must be supplied.
  • If the value is not known, it can be derived from the component’s residual life and/or depreciation.
  • Don’t forget that date values should be formatted ‘DD/MM/YYYY’.
Intervention Date
Recommended

This field reflects the date of the most recent capital intervention (renewal) for the component.

  • Header label: intervention_date
  • If the value is not known, it can be derived from the component’s construction date.
  • Don’t forget that date values should be formatted ‘DD/MM/YYYY’.
Condition
Recommended

This field sets the condition of the component at a 1-5 value.

  • Header label: condition
  • A condition of 1 is considered excellent, and a condition of 5 is considered ver poor.
  • Condition is required for some types of financial reports.
Condition Date
Recommended

This field sets the date that the condition of the component was captured (if known).

  • Header label: condition_date
  • This value will default to ’today’ if not set.
Useful Life
Recommended

This field reflects the expected lifespan, in years, of the component.

  • Header label: intervention_useful_life
  • If the component carries value, the useful life must be supplied.
  • If setting this value, make sure either ‘Construction Date’ or ‘Intervention Date’ exists.
  • If the value is not known, it can be derived from recent Annual Depreciation charges.
Treatment ID
Recommended

This field sets the current intervention treatment for the component.

  • Header label: treatment_id
  • The treatment ID can be copied from the treatment configuration page.
  • Configuring and assigning treatments will add great value to your experience of the Metrix Asset Management system.

See also Treatment definition ID

Cost Units
Recommended

The cost unit value for the component in accordance with any treatment definition that has been applied.

  • Header label: cost_units
  • This value will be ignored if the component classification has been configured with a cost unit formula.
  • If supplied, this must be a positive number to a maximum precision of 4 decimal places.
  • Ensure you check any Unit of Measure assigned to the component treatment when setting this value.
Residual Life
Optional

By default, residual life (remaining useful life) is calculated by the Metrix Asset Management date using the intervention useful life, the intervention date, and the end of the current financial period. Supply this field if your data has residual life values that are known, and/or specified differently.

  • Header label: intervention_residual_life
  • If setting this value, also supply an effective date value for the import row that baselines when the residual life assertion is valid from.
  • If the value is not known, exclude it and allow the system to calculate a value.
Effective Date
Optional

This field provides context to your imported data and will set the ‘modified’ date of the components to the supplied value, instead of the current date/time.

  • Header label: effective_date
  • This field is recommended if setting the residual life value as it provides the baseline from when the residual life assertion is founded.
  • If the value is not known, the date/time of when you import the file will be used.

Other Fields

The following fields, whilst not typical in a data import template, are also supported.

Report Categories
Optional

This is one or more - separated by semi-colons (;) - unique report category ID values that may pertain to the asset component.

  • Header label: reporting
  • To supply more than one report category tag, use a semi-colon. I.e. category1-option; category2-option.
  • The report category IDs can be copied from the report categories configuration page.
  • Users often use report category tags to note import anomalies that will be ‘cleaned up’ later in the system.

See also Report Category ID

Next Treatment Fields
Optional

The following fields can be included in an import sheet to set parameters around the component’s next intervention treatment plans. Although discussed as a single entity, each of the following should be distinct columns in your CSV file. The required/optional fields are only relevant if importing this information - otherwise, all fields are optional.

Next Treatment Description - next_treatment_description (required)

  • A short description of the treatment.

Next Treatment Reason - next_treatment_reason (required)

  • A brief reasoning for implementing the treatment.

Next Treatment ID - next_treatment_id (optional):

  • The unique treatment id of the treatment definition that is being set as the next intervention for the component.
  • This can be ignored if the next treatment is defined with a ‘Fixed Value’.

Next Treatment Cost Units - next_treatment_cost_units (optional):

  • An override option to the component’s cost units value for the next treatment.
  • This will be set if the next treatment only pertains to a known quantity subset of the component.

Next Treatment Cost Unit Factor (%) - next_treatment_cost_unit_factor (optional)

  • This is another override option to the component’s cost units value for the next treatment.
  • Instead of a known quantity, this value will set a cost unit value relative to the component cost unit value.
  • This is typically 100% for standard renewal plans.

Next Treatment Fixed Value - next_treatment_fixed_value (optional)

  • Set this value - in lieu of the above three (3) fields - if the next treatment is defined by a fixed/quoted price.

Next Treatment Date - next_treatment_expected_date (optional)

  • An estimated date that the next treatment should occur.

See also Treatment ID