| elem_index | treatment | period_calendar | treatment_qty | treatment_comment | treatment_reason |
|---|---|---|---|---|---|
| 73 | ChipSeal_P | 2025 | 2018.40000 | committed | committed |
| 78 | ChipSeal_P | 2026 | 459.90000 | committed | committed |
| 93 | PreSeal | 2026 | 129.60000 | committed | committed |
| 134 | ThinAC_H | 2026 | 37214.60000 | committed | committed |
| 135 | PreSeal | 2026 | 159.10000 | committed | committed |
| 138 | ChipSeal_P | 2025 | 1032.00000 | committed | committed |
| 139 | ChipSeal_P | 2025 | 2575.60000 | committed | committed |
| 140 | ChipSeal_P | 2025 | 338.40000 | committed | committed |
| 162 | ChipSeal_P | 2025 | 2079.00000 | committed | committed |
| 194 | ChipSeal_P | 2025 | 1608.00000 | committed | committed |
| 205 | ChipSeal_P | 2026 | 1869.30000 | committed | committed |
| 206 | PreSeal | 2026 | 83.70001 | committed | committed |
| 225 | ChipSeal_P | 2026 | 7034.30000 | committed | committed |
| 6970 | Rehab_AC_UH | 2028 | 4501.20000 | committed | committed |
| 6969 | Rehab_AC_UH | 2028 | 1489.60000 | committed | committed |
| 6702 | Rehab_CS_UH | 2028 | 1080.00000 | committed | committed |
| 1293 | Rehab_CS_UH | 2028 | 6019.00000 | committed | committed |
| 807 | Rehab_CS_UM | 2028 | 3094.00000 | committed | committed |
| 809 | Rehab_CS_UM | 2028 | 364.00000 | committed | committed |
| 1294 | Rehab_CS_UH | 2028 | 455.00000 | committed | committed |
| 1295 | Rehab_CS_UH | 2028 | 264.00000 | committed | committed |
| 1297 | Rehab_CS_UH | 2028 | 1896.00000 | committed | committed |
| 2008 | Rehab_CS_UH | 2028 | 1476.80000 | committed | committed |
| 6250 | Rehab_CS_UH | 2028 | 588.00000 | committed | committed |
Committed Treatments
Overview
Committed Treatments form an imporant part of most modelling analyses. To specify where and when committed treatments need to be applied, you need to prepare a Committed Treatments template file. This page describes the key aspects of the Committed Treatments template.
You can download an example template for specifying your Committed Treatments by clicking the button below.
Template Format
Columns required to be present in the template are explained below:
elem_index
This column specifies the zero-based index of the element in the input file to which the committed treatment needs to be applied. Thus, if a committed treatment needs to be applied to the first (topmost) element of your input file, then the element index value specified in column elem_index should be 0. If the treatment needs to be applied to the second element in the input file, then the element index specified should be 1, and so forth.
Important
For your committed treatments to be applied to the correct network elements, you should take special care to ensure that the element indexes specified in column elem_index are correct. Specifically, you should note that if you re-order or modify your input file, then you should update the element indexes for your committed treatments accordingly.
treatment
This column holds the name of the committed treatment type to be applied. The names specified in this column should map to the names of your domain model treatments as specified in the treatments sheet of the domain model setup file.
Treatment names are case-sensitive, so take special care to ensure you specify the treatment names correctly. If you specify a name in this column that is not defined for your domain model, a run-time error will be thrown to notify you of this.
period_calendar
This column should hold the calendar period in which each committed treatment needs to be applied. Calendar periods have values such as ‘2024’, ‘2025’, etc., while modelling periods (or just ‘periods’) have values such as 0,1,2, etc.
The framework model only works with periods. Thus, when the model initialises, the specified calendar periods will be converted to periods using the Initial Calendar Epoch specified in the model configuration in your work bench file.
treatment_qty
This column should specify the treatment quantity as related to the Treatment Unit Rate specified in the treatments sheet of the domain model setup file.
The actual cost of the committed treatment will be calculated at run-time using the treatment quantity in this column, multiplied with the associated unit rate for the specified treatment type. This cost will then be adjusted based on the inflation rate, discount rate and modelling period before it is logged and subtracted from the available budget constraints.
Note
Why not just specify cost directly? The reason for using treatment quantity as opposed to treatment cost is to maintain congruence between the cost of treatments and the unit rate for the treatment type.
Often, clients will have more detailed cost calculations for committed treatments which do not exactly match element quantity multiplied with unit rate. However, the framework model always calculates costs at runtime based on treatment quantity and unit rate (adjusted for inflation and discount rate).
To work within this framework, the way in which custom treatment costs are handled is to modify the treatment quantity for committed treatments where needed such that the total cost will be correct when the value in column treatment_qty is multiplied by the unit rate for the Treatment Type. Thus, by modifying the effective treatment quantity, variations in treatment costs can be accommodated while still adhering to the specified unit rate for the treatment.
treatment_comment
This column holds a comment related to the treatment. The comment will be exported with the treatments and spending data. You can enter any comment here to clarify aspects of each committed treatment. It is recommended that you start your comment with the word ‘committed’ for each searching of output data related to committed treatments.
If you do not have a specific comment for any committed treatments, simply specify the word ‘committed’ in this column for all rows.
treatment_reason
This column holds a reason for the treatment, if there is any. The reason provided will be exported with the treatments and spending data. You can enter any text value here to clarify aspects of each committed treatment. It is recommended that you start your text with the word ‘committed’ for each searching of output data related to committed treatments.
If you do not have a specific reason for any committed treatments, simply specify the word ‘committed’ in this column for all rows.
Template Example
The table below shows an example of a Committed Treatments template:
Note
You can change the order of the columns in the template, and also add additional columns to the .CSV file. For example, if you have columns with the information to identify the elements in each row, you can add such columns into your template. However, the columns shown above must be present with column names exactly as shown (case-sensitive).