SEED-platform / seed

Standard Energy Efficiency Data (SEED) Platform™ is a web-based application that helps organizations easily manage data on the energy performance of large groups of buildings.
Other
111 stars 54 forks source link

AH: Don't allow data import if the AH levels are not properly defined #4530

Open RDmitchell opened 9 months ago

RDmitchell commented 9 months ago

instance: dev2 SHA: d30082bbc Org: LBNL 406

I was allowed to import a file into a SEED org where the AH wasn't properly defined for the data file. Seems like the program shouldn't have let me continue through all the import steps, only to result in now records imported.

I have the following access levels defined -- only one county, ie, Contra Costa image

But my data has 2 counties defined, Contra Costa and Alameda image

When I import the data, the Mapping Review screen has an error saying there is "Missing/Incomplete Access Level Column". image

When I click the Save Mappings button, I would have expected the program to put up an error message saying that the data couldn't be imported, and to fix the AH definitions, and try again.

However, the program went through all the steps of matching and merging, including reporting that there were New properties errors: 13 I guess I should have noticed this, but it wasn't particularly prominent, and I don't think the program should have ever gotten that far. image

And when I click on View Properties, there are no properties displayed. image

RDmitchell commented 9 months ago

I thought I had fixed the AH levels, in the UI (not by reimporting the AH definitions file), so that now it has both Contra Costa and Alameda Counties and the cities defined for each. Image

But when I import the spreadsheet (shown above) with the Alameda County records, I am still getting errors in Mapping Review Image

Any idea what I am doing wrong in trying to fix the AH levels?

RDmitchell commented 9 months ago

Imported files can be found here, if that is useful https://drive.google.com/drive/folders/1qIl5MzWhGind1ofZwn1aH0x_I7pfaCcR?usp=drive_link

kflemin commented 9 months ago

@RDmitchell, I think something slightly different is happening here. First, I think the import file's for level is "LBNL 406", but from the hierarchy tree in your screenshot, I think you actually defined level 1 as "LBNL 406 Root", so either the header in the spreadsheet should be renamed to match, or you can map it to 'LBNL 406 Root' during the mapping phase of import.

That should modify the Mapping Review screenshot to have information in the AH columns in blue, instead of the "missing/incomplete access level column" message.

I don't think this will take care of your error entirely, but could you try to rename the header to match first and see what the import screens look like then?

RDmitchell commented 9 months ago

@kflemin -- right, I thought maybe it was something I wasn't catching. I will do as you suggest, and hopefully that will fix things ! Thx !!

RDmitchell commented 9 months ago

@kflemin -- yup, that fixed it !! image

I am wondering if it is possible to give the user some clues about what is wrong with their file, ie, in this case a message saying that one of my fields in the file didn't match the defined AH levels.

Not sure how hard it would be, and might need to be moved to another quarter's work, but because the AH world is fairly complex, it might be nice to do something like that for the uninitiated user !

RDmitchell commented 9 months ago

@kflemin -- should I leave this issue open, ie, don't go through all the steps of importing a file if it's actually not going to work because the AH fields are not properly defined?

It seems like the program should have told me at somewhere in the mapping steps that the file wasn't properly defined and that I needed to fix it and reimport it.

What do you think?

kflemin commented 9 months ago

@RDmitchell, the error message was shown in this screenshot:

304920545-3303be9d-1c4d-494f-af05-523897463f3e

The tricky part is that it is a potential error message. If the user has previously imported this data, then it will import eventually. (either it will merge w/ an existing record or link to an existing record across cycles). The problem is that we don't know what will happen at the of mapping (screenshot above). Perhaps we can revise the message to be more specific (and maybe add a little ! icon and orange text). Maybe say something like:

"!! Warning: Access Level Information was not found in the import file for this record. If you have previously imported the record, this is not a requirement and your record should import successfully. If not, ensure that your import file contains the appropriate access level names and instances."

It's very long and we don't have that much space in the column to display all the text...maybe we can add all that text before the table and then just use icons to flag the rows in the table...

let me know if you have other ideas

RDmitchell commented 9 months ago

@kflemin -- maybe add some text on the STEP 2: Review Your Data Mappings tab to explain about the AH world, and add the help text above there, possibly with a screenshot (?) of the mapping review screen with the error message?

Seems like that would be good enough for now.

Once users start to really use the AH, we may want to refine things more, but I think for now, just adding some help text here and there is probably good enough.

github-actions[bot] commented 7 months ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.