Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The changes proposed to res.csv are to do with how we use the metadata in the file. 

The metadata fields are: Field, Units, ScenarioName, ScenarioInputSetName, Name, Site, ElementName, WaterFeatureType, ElementType, Structure, Custom

Note: Units In File version 1: When saving, units has moved to the second column, directly after "Field" for ease of finding it. In order to do this, the metadata fields can now be read in any order and it depends on the metadata headings to map the metadata to the correct field. See attached example.res.csv.

When exporting

Populates as many metadata fields as possible, including name.

When exporting from Data Sources, we no longer append the input set name (Corresponding with the Data Source Group) to the Name metadata.

Above the data (See image belowArrow pointing to the row described, ), each header will be a "key". The key is aiming to uniquely identify each column but also retain some information of the column metadata to make it more user friendly. The key is made up of two parts, the "Field" metadata (unique within the res.csv file) and a descriptive part (not necessarily unique within the res.csv file). The metadata should be referenced via the field when distinguishing the differences between each column. The key will always start with the "Field" metadata to make it unique, but to descriptive part depends on where it is exported from:

...

From Data Sources or any place that DOESN'T have all the metadata it will be: Field > Name

 

Image Added

When importing

The metadata will be loaded into the domain object, but will for the most part be hidden from the UI. The We have chosen not to strip any of the metadata in attempt to be able to round trip as close to the original file and the UI will determine how the data is displayed.

...

When the res.csv doesn't contain all the required metadata (such as, importing a csv than exporting as a res.csv) it will appear to flatten the data.

Reading into Data Sources

...

The name chosen for display will be "Site > Structure" if the metadata exists, otherwise the "Name" Field will be used. However, as names need to be unique, we will append the Field metadata to this name for any non unique columns

...