The Metrix Asset Management system was designed with data interoperability at the forefront. This means
there is a big focus on making it easy to get your asset data out, as well as getting new and updated asset
data into the system. This section covers the various methods available to bring external data into the
system, including:
Importing new assets and components,
Updating existing data, and
Importing financial ledger transactions
Info
IMPORTANT
When importing data into your environment (for either creating new asset components or updating them), it is important
to remember that each row of your import CSV relates to one (1) component record.
This is of particular importance when importing assets containing multi component records assigned to it (e.g. a road segment with earthworks, base, and surface components). In
these cases, each row still relates to one (1) component and the asset information on each row is be simply repeated
over and over for each component that relates to this asset.
Subsections of Importing Data
About
This section provides background context to a number of concepts and requirements of the Data Import process. Including:
For data imports, the required file type for data is CSV - that is, comma separated value files that can
be generated from Microsoft Excel or Google Sheets. See Creating CSV Files for details on this. There are also a number of other restrictions and requirements
for data imported via these CSV channels. These include;
Date Format
Within your CSV file, any date values must be formatted as DD/MM/YYYY. For example; 24/10/2023 represents the 24th of
October, 2023. It should be noted that the time of day will always be set to 00:00AM for imported data.
Spatial Format
The supported spatial format is ‘WKT’ (Well Known Text). This is a text string that represents a valid geometry definition.
See Create WKT Geometries using QGIS for
more details on this.
File Size
The maximum support CSV file size is 20MB. If your CSV file exceeds this limit, consider splitting it into two or more
smaller CSV files.
Header Row
The header row of the csv file must be restricted to row 1 of the file. Also, the header row must not contain any spaces
or special characters (such as carriage returns, or line feeds). The header row is mandatory.
Blank Cells
Throughout the CSV file, if any data row cells are blank, they will be ignored by the importer. This means that, when updating
existing data, setting a CSV cell to blank will NOT delete the corresponding data from the system.
Effective Date
Where supported, users can include the effective_date column to stipulate when the new record, or updated data, should be
considered effective from. This can be useful in setting a residual life value as at a particular point in time.
Avoid Special Characters
When constructing your CSV file, avoid special characters in both your header row and data rows. These include, but are not
limited to:
Commas within a cell’s content
Carriage returns or Line feeds
Other non-ascii characters that are not part of a standard keyboard layout.
CSV Files do not support Formulas
When using a product such as Microsoft Excel or Google Sheets, the program will allow you to utilise cell formulas whilst
working on your data. As soon as you save and close the file however, the formulas will disappear, and only the results will
be saved.
Creating CSV Files
This page provides guidance on how to create a CSV file from within Microsoft Excel and Google Sheets on a
Windows based machine. As these are 3rd party programs, screenshots and processes are subject to change without
notice. However, is is anticipated that the basic flow should remain the same.
Create CSV file in Microsoft Excel
To create a CSV file from your data in Microsoft Excel, you will need to ‘Save-As’ the data with the ‘CSV’
file extension enabled. To do this:
Click File > Save As.
Below the ‘File Name’ input box, where it says ‘Excel Workbook (.xlsx)’, use the drop down control to select
‘CSV UTF-8 (Comma Delimited) (.csv)’.
Give the file a name in the ‘File Name’ input and choose a location to save the new file.
Click ‘Save’ to finish.
Create CSV file in Google Sheets
To create a CSV file from your data in Google Sheets, you will need to ‘Download’ the data with the ‘CSV’
file type set. To do this:
A file dialog will appear asking you where you wish to save the CSV file. Save the file in a known location and
click ‘Save’ to finish.
Info
CSV files do not support multiple worksheets. If your workbook contains multiple worksheets, the CSV export
will be created from the currently active worksheet only.
Multi-Component Assets
When you are importing assets with more than one (1) component - such as a road asset with earthworks, base, and surface - you
will need to have a csv row for each of the components being imported. To tie the rows together, so the system knows they are
of the same asset, rather than distinct asset entries, set an identical asset_import_ref for each row.
Below is a video that demonstrates this practice.
WKT Geometries in QGIS
QGIS, an open source and free Spatial Data creation & editing tool, has the ability to export data in CSV format.
Within these files, the geometry data can be represented as WKT (Well Known Text). This is the supported spatial type
for importing data into the Metrix Asset Management system using CSV files. To do this, follow the steps below:
In the ‘Layer Browser’, right click on the spatial layer that you want to export.
From the menu, click on Export > Save Feature As…
A dialog box will appear. Firstly, set the ‘Format’ drop down box at the top to ‘Comma Separated Value (CSV)’.
Next, click on the 3 dots (…) on the right-hand side of the ‘File Name’ input control.
A file browser will appear. Give your export a file name in a known location, and click ‘Save’.
Then, back in the QGIS dialog, move down to the ‘Layer Options’ section of the export dialog and set the ‘GEOMETRY’
drop down to ‘AS_WKT’.
Lastly, uncheck ‘Add saved file to map’ and click ‘OK’.
You now have a valid CSV file with a WKT Geometry Column, as well as any other data attributes that were in the spatial
file from QGIS. Below is a video guide of the above steps.
How To Guides
The section contains How To guides for performing various data imports in the Metrix Asset Management system. Including:
Creating New Assets and Components
Appending New Components to Existing Assets
Updating Existing Component Data
Updating Existing Spatial Features
Creating New Financial Ledger Transactions
Viewing Import History
Subsections of How To Guides
Importing CSV Data
This document covers the workflow involved in importing data as:
Creating New Assets and Components
Appending New Components to Existing Assets
Updating Existing Component Data
Updating Existing Spatial Features
Creating New Financial Ledger Transactions
To process one of the above imports via a CSV file, complete the following steps:
Prepare your CSV file - see the relevant Checklist for guidance on this:
Navigate to the Import page (Assets Menu > Import Data) and then click on the ‘Start Import’ option within the
relevant page section. For example, to create new assets and components, click on ‘Start Import’ in the ‘New Assets and
Components Import’ section.
Info
To append components to existing assets, use the ‘New Assets and Components Import’ section.
The first step of the process simply provides advice on preparing your import file. This can be useful to revisit if you
are unsure on any specific columns of data. On the right-hand side of this page, click ‘I have my data prepared’ to
continue.
You will now be presented with a file upload control where you can choose to either:
a. Drag and drop your prepared CSV file into the control bounds, or
b. Click ‘Select file for Upload’ and choose the file from a browser dialog.
The system will then analyse your CSV file - conducting preliminary checks on the validity of your proposed import.
If any errors are detected during this stage, the page will itemise them for you. Review these and update your CSV file
to fix the issue(s). To reupload, you can click ‘Restart’.
When no errors are found, the page will continue to a confirmation stage.
Review the confirmation summary, and when satisfied, click ‘Continue with Import’. Your new data will then be imported and the
asset/component records will be created/updated.
This next step can take quite some time depending on the amount of data you are importing. Feel free to refresh your browser to
check on the process. Once finished, a completion summary will display with links out to the newly created/updated data.
View Import History
At any time, users are able to see the details around past imports that they have run. To do so,
follow these steps:
Navigate to the Import page (Assets Menu > Import Data) and then click on the ‘Import History’ button at the top of
the page.
This will take you to a page that lists the history of Data Imports for your Metrix environment.
For each row, users can click on the ‘View’ option to see additional information about the import.
For jobs that are still in the preview phase, you can see if it is in an error state, or ready to process.
For completed jobs, the view portal will take you to the final summary page for that job, with links
through to the associated resources.
Checklists
The section contains Checklists / Cheat Sheets for performing various data imports in the Metrix Asset Management system. Including:
This document provides even more information as well as suggestions around importing data to create new assets and
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:
Asset Data Fields
The following fields pertain to information that will be stored against the parent asset of the imported components.
Remember, if you are importing an asset with multiple components ↗,
the information in these columns will need to be repeated for each row, constituted by each child component.
Asset Import Reference
Required
This is a value from your import CSV that will tie the imported record back (in system) back to that CSV entry.
Header label: asset_import_ref
For an asset with multi components, this value must remain constant for each row relating to that asset.
Aside from the above case regarding assets with multi components, this value must be unique per row to ensure each
component row is created on a unique asset record.
The asset import reference is generally not visible inside the Metrix Asset Management system, however, it is
able to be included in data exports such as the ‘Component Data Export’.
Users typically set this to the ID value (i.e. asset id) from their legacy system, if unique.
The following fields pertain to information that will be stored against each component in relation to the components
identifying attributes.
Component Import Reference
Required
This should be set to a value from you import CSV that will tie the imported record (in system) back to that CSV entry.
Header label: component_import_ref
The component import reference is generally not visible inside the Metrix Asset Management system, however, it is
able to be included in data exports such as the ‘Component Data Export’.
Users typically set this to the ID value (i.e. component id) from their legacy system, if unique.
Component Group ID
Required
This is the unique ID of the component group within the asset classification that the component will be assigned to.
Header label: component
You must create and configure your asset classification and component groups prior to importing data.
The ID can be copied from the component classification configuration page.
The following fields enable users to define the spatial features representing the newly created asset components. It should be noted
that the required/recommended/optional flags for each field are conditional to the import scenario (hence the asterisk). Please read
each of the field notes carefully to determine if the field is required in your circumstances.
Shape WKT
Required *
The WKT stands for Well Known Text ↗ which is a method of writing simple geometry features into a standard text string.
This field allows users to define such a geometry as the spatial feature representing the component.
Header label: shape_wkt
A valid spatial feature is a mandatory element of the system.
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.
Financial Ledger Transactions
The following fields enable users to set the initial financial transactions ledger value for the newly created asset
components. Please note, the optional flag is set to reflect that transaction posting is optional. If value exists on
the assets being imported, then these fields are indeed required.
Finance Category
Optional *
This is the unique ID of the finance category that the imported transactions will be assigned to.
Header label: finance_category
The finance category ID can be copied from the finance categories configuration page.
If a component carries value, and transaction postings are being imported, this is a REQUIRED field.
If a component carries value,
and transaction postings are being imported, this is a REQUIRED field.
This is the unique ID of the transaction type - with the type effect stripped - that the transaction value is being initialised with.
Header label: transaction_type
If the component carries value, and transaction postings are being imported, this is a REQUIRED field.
The transaction type ID can be derived from the transaction type configuration page. Simply remove the -gross or -accumulated_depreciation
tags from the ID to strip the type effect. The reason for this is that, in this import process, the transaction type effect is mandated by the
column origin of the data - being either ‘gross_value’ or ‘accumulated_depreciation’ below.
Users typically set this value to ‘recognition’, which is a built in transaction type for value initialisation.
This is the date in which the transactions should be recognised in the financial ledger.
Header label: posting_date
Don’t forget that date values should be formatted ‘DD/MM/YYYY’.
If the data import is for a site initialisation, users typically set this value to the end of the last financial
reporting period - i.e. 30/06/2023 for the 2023 EOY.
If the component carries value, and transaction postings are being imported, this is a REQUIRED field.
Gross Value
Optional *
The current replacement value of the asset component according to the organisations financial statements.
Header label: gross_value
If provided, this must be a positive number up to a maximum precision of 4 decimal places.
This value has many pseudonyms including ‘Current Replacement Cost’, ‘Fair Value’, and ‘Market Value’
Depreciation Value
Optional *
The current value of the life-to-date depreciation accumulated against the component according to the organisations financial statements.
Header label: accumulated_depreciation
If provided, this must be a negative number (or zero) up to a maximum precision of 4 decimal places.
Sometimes, this value needs to be derived from financial statements. It is the difference between ‘Gross Value’ and
the components ‘Carrying Value’ (AKA ‘Written Down Value’, and ‘Closing Value’).
Don’t forget that this value must be provided as a negative figure - simply multiply by -1
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.
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.
The following fields allow users to define two financial settings for components. 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.
Depreciable Value is the subset value of the component’s gross value that is depreciable. System default is 100%.
If setting a depreciable value for the component, this is a required field.
Set this value to fixed or variable.
Fixed means that the depreciable value you supply will be a fixed dollar value.
Variable means that the depreciable value of the component as a percentage of the component gross value.
Depreciable Value - depreciable_value (required)
The value as defined by the depreciable method chosen above.
Period Depreciation Method - period_depreciation_method (required)
Period Depreciation Value details how much value is depreciated per financial period. System default is calculated by
the component’s residual life and carrying value.
If setting a period depreciable value for the component, this is a required field.
Set this value to fixed or variable.
Fixed means that the period depreciation value you supply will be a fixed dollar value.
Variable means that the period depreciation value you supply will be a percentage of the component gross value.
Period Depreciation Value - period_depreciation_value (required)
The value as defined by the period depreciation method chosen above.
New Components (Existing Assets)
This document provides even more information as well as suggestions around importing data to create new components against
existing assets 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:
Asset Data Fields
Although this import pertains to Component data, there is still a requirement for some asset related information
to be provided for the import to function correctly.
Parent Asset ID
Required
The parent asset record ID field is used to link the incoming new component records with an existing asset record
from the system.
Header label: parent_asset_record_id
This value is case sensitive and should be copied from the parent asset info panel directly.
The following fields pertain to information that will be stored against each component in relation to the components
identifying attributes.
Component Import Reference
Required
This should be set to a value from you import CSV that will tie the imported record (in system) back to that CSV entry.
Header label: component_import_ref
The component import reference is generally not visible inside the Metrix Asset Management system, however, it is
able to be included in data exports such as the ‘Component Data Export’.
Users typically set this to the ID value (i.e. component id) from their legacy system, if unique.
Component Group ID
Required
This is the unique ID of the component group within the asset classification that the component will be assigned to.
Header label: component
You must create and configure your asset classification and component groups prior to importing data.
The ID can be copied from the component classification configuration page.
The following fields enable users to define the spatial features representing the newly created components. It should be noted
that the required/recommended/optional flags for each field are conditional to the import scenario (hence the asterisk). Please read
each of the field notes carefully to determine if the field is required in your circumstances.
Shape WKT
Required *
The WKT stands for Well Known Text ↗ which is a method of writing simple geometry features into a standard text string.
This field allows users to define such a geometry as the spatial feature representing the component.
Header label: shape_wkt
A valid spatial feature is a mandatory element of the system.
Set this value (instead of the ‘Shape WKT’) to link the new component’s spatial feature to an existing spatial definition
that exists on the target asset’s components.
Header label: shape_id
Spatial features CANNOT be shared across different assets.
The shape ID can be copied from the ‘Spatial’ section of the Component info panel.
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.
Financial Ledger Transactions
The following fields enable users to set the initial financial transactions ledger value for the newly created
components. Please note, the optional flag is set to reflect that transaction posting is optional. If value exists on
the assets being imported, then these fields are indeed required.
Finance Category
Optional *
This is the unique ID of the finance category that the imported transactions will be assigned to.
Header label: finance_category
The finance category ID can be copied from the finance categories configuration page.
If a component carries value, and transaction postings are being imported, this is a REQUIRED field.
If a component carries value,
and transaction postings are being imported, this is a REQUIRED field.
This is the unique ID of the transaction type - with the type effect stripped - that the transaction value is being initialised with.
Header label: transaction_type
If the component carries value, and transaction postings are being imported, this is a REQUIRED field.
The transaction type ID can be derived from the transaction type configuration page. Simply remove the -gross or -accumulated_depreciation
tags from the ID to strip the type effect. The reason for this is that, in this import process, the transaction type effect is mandated by the
column origin of the data - being either ‘gross_value’ or ‘accumulated_depreciation’ below.
Users typically set this value to ‘recognition’, which is a built in transaction type for value initialisation.
This is the date in which the transactions should be recognised in the financial ledger.
Header label: posting_date
Don’t forget that date values should be formatted ‘DD/MM/YYYY’.
If the data import is for a site initialisation, users typically set this value to the end of the last financial
reporting period - i.e. 30/06/2023 for the 2023 EOY.
If the component carries value, and transaction postings are being imported, this is a REQUIRED field.
Gross Value
Optional *
The current replacement value of the asset component according to the organisations financial statements.
Header label: gross_value
If provided, this must be a positive number up to a maximum precision of 4 decimal places.
This value has many pseudonyms including ‘Current Replacement Cost’, ‘Fair Value’, and ‘Market Value’
Depreciation Value
Optional *
The current value of the life-to-date depreciation accumulated against the component according to the organisations financial statements.
Header label: accumulated_depreciation
If provided, this must be a negative number (or zero) up to a maximum precision of 4 decimal places.
Sometimes, this value needs to be derived from financial statements. It is the difference between ‘Gross Value’ and
the components ‘Carrying Value’ (AKA ‘Written Down Value’, and ‘Closing Value’).
Don’t forget that this value must be provided as a negative figure - simply multiply by -1
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.
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.
The following fields allow users to define two financial settings for components. 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.
Depreciable Value is the subset value of the component’s gross value that is depreciable. System default is 100%.
If setting a depreciable value for the component, this is a required field.
Set this value to fixed or variable.
Fixed means that the depreciable value you supply will be a fixed dollar value.
Variable means that the depreciable value of the component as a percentage of the component gross value.
Depreciable Value - depreciable_value (required)
The value as defined by the depreciable method chosen above.
Period Depreciation Method - period_depreciation_method (required)
Period Depreciation Value details how much value is depreciated per financial period. System default is calculated by
the component’s residual life and carrying value.
If setting a period depreciable value for the component, this is a required field.
Set this value to fixed or variable.
Fixed means that the period depreciation value you supply will be a fixed dollar value.
Variable means that the period depreciation value you supply will be a percentage of the component gross value.
Period Depreciation Value - period_depreciation_value (required)
The value as defined by the period depreciation method chosen above.
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.
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.
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.
This document provides even more information as well as suggestions around importing data to update existing spatial features
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:
Spatial Definition Fields
The following fields enable users to update existing spatial features, by ‘Shape ID’, using a WKT spatial definition.
Shape WKT
Required
The WKT stands for Well Known Text ↗ which is a method of writing simple geometry features into a standard text string.
This field allows users to define such a geometry as the spatial feature representing the component.
Header label: shape_wkt
A valid spatial feature is a mandatory element of the system.
This document provides even more information as well as suggestions around importing data to create financial ledger transaction entries
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:
Fixed Transaction Fields
The following fields form the basis of the transaction import.
Component ID
Required
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.
This is the date in which the transactions should be recognised in the financial ledger.
Header label: posting_date
Don’t forget that date values should be formatted ‘DD/MM/YYYY’.
If the data import is for a site initialisation, users typically set this value to the end of the last financial
reporting period - i.e. 30/06/2023 for the 2023 EOY.
Finance Category ID
Required *
This is the unique ID of the finance category that the imported transactions will be assigned to.
Header label: finance_category
The finance category ID can be copied from the finance categories configuration page.
If a component carries value, and transaction postings are being imported, this is a REQUIRED field.
If a component has no current
transaction postings, this is a REQUIRED field.
Transaction Type Headers
Following the above fixed columns, the next set of columns to include are for transaction types and their corresponding
transaction value.
For each ‘Transaction Type’ with a corresponding value for a row’s component, the
transaction type ID ↗ must be used
as the header value, and the transaction value constitutes the cell value for each row.
Example
Consider a simple, 3 row import sheet - targeting transaction imports for three (3) component records.
component_record_id
posting_date
finance_category
recognition-gross
recognition-accumulated_depreciation
C-7569020
30/06/2023
roads
152564.25
-53255.25
C-7569021
30/06/2023
roads
986123.46
C-7569022
30/06/2023
roads
8955.25
-7425.98
The above example import sheet is going to import a total of five (5) transactions - (2 for row 1, 1 for row 2, and
2 for row 3). In row 2, the accumulated depreciation value has been excluded, and thus will not be imported.
