Configuration Examples
Report Template Configuration Parameters
The following outlines the required configuration parameters for some of the most commonly used report templates within the Metrix Asset Management system. For any report templates not listed below, please contact our support team.
If a report you wish to generate is not listed here, please reach out to our support team and we will help you and update these notes accordingly.
Component Data Export
Template ID: RTO_E3MWCDP
The Component Data Export report template allows you to export a comprehensive dataset containing information about all of your assets and their components. The report takes the following configuration parameters:
selected_date: the date for which you want to run the report for. This should be in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ) and specified at UTC. Being a date, users can also leverage the dynamic keyword${end-of-day}for this configuration parameter.filter: a string value that references the filter to apply to your asset network when running this report. This can either be the ID of a valid filter you have defined, or set to one of the following:$DEFAULT: this is the standard default filter that includes all asset types, but excludes disposed and proposed assets.$ALL_ASSETS: this is the same as default, but includes disposed and proposed assets as well.
append_asset_data: a boolean value indicating whether you want the report to include asset-level custom attribute data. This option is currently only available when thefilterconfiguration parameter is NOT set to$DEFAULT.append_component_data: a boolean value indicating whether you want the report to include component-level custom attribute data.fields_to_include: an array of string values that specify which standard fields you want to include in the report output. The full list of available fields is as follows:- component_id,
- asset_id,
- component_description,
- asset_description,
- asset_barcode_value,
- barcode_value,
- asset_class,
- asset_type,
- asset_subtype,
- asset_group,
- comp_group,
- depreciable,
- carries_value,
- requires_condition,
- finance_category,
- gross_value,
- depreciable_value,
- designated_period_depreciation,
- accumulated_depreciation_value,
- carrying_value,
- estimated_annual_depreciation,
- last_depreciation_date,
- construction_date,
- intervention_date,
- latest_condition,
- latest_condition_date,
- intervention_treatment,
- intervention_useful_life,
- intervention_residual_life,
- residual_life_offset,
- expected_residual_life,
- cost_units,
- intervention_cost_rate,
- intervention_cost_method,
- next_treatment,
- next_treatment_rate,
- next_treatment_cost_units,
- next_treatment_description,
- next_treatment_reason,
- next_treatment_expected_date,
- status,
- effective_date,
- shape_id,
- shape_wkt,
- shape_x,
- shape_y,
- shape_projection,
- shape_longitude,
- shape_latitude,
- shape_source,
- shape_source_text,
- shape_confidence,
- component_import_reference,
- asset_import_reference,
- asset_record_id,
- component_record_id (automatically injected, need not specify),
- mod_user,
- mod_date
selected_report_categories: an array of string values that specify which report categories you want to include in the report output. The string value to use will be the Report Category label as defined for your site. E.g. “Special Schedule 7”.
Raw Finance Data Export
Template ID: RTB_EFYWCDPP
The Raw Finance Data Export report template allows you to export a dataset containing complete dump of financial transactions from your environment. The report takes the following configuration parameters:
selected_date: the date for which you want to run the report for. This should be in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ) and specified at UTC. Being a date, users can also leverage the dynamic keyword${end-of-day}for this configuration parameter.
Asset Data Export
Template ID: REP_A75909GJD
The Asset Data Export provides a comprehensive dataset with one asset per row. Each component is fanned out to columns
of the same row. The report takes the following configuration parameters:
fields_to_include: an array of string values that specify which standard fields you want to include in the report output.
The full list of available fields is as follows:
- Construction_Date,
- Intervention_Date,
- Useful_Life,
- Residual_Life,
- Cost_Units,
- Condition,
- Condition_Date,
- Treatment,
- Treatment_Unit_Rate,
- Treatment_UOM
append_custom_data: a boolean value indicating whether you want the report to include asset-level custom attribute data.selected_report_categories: an array of string values that specify which report categories you want to include in the report output. The string value to use will be the Report Category label as defined for your site. E.g. “Special Schedule 7”.filter: a string value that references the filter to apply to your asset network when running this report. This can either be the ID of a valid filter you have defined, or set to one of the following: $DEFAULT: this is the standard default filter that includes all asset types, but excludes disposed and proposed assets.$ALL_ASSETS: this is the same as default, but includes disposed and proposed assets as well.