NREL / NEB-Tool

A user friendly, graphical, open-source application (Web/Mac/Windows) of the multiple benefits framework for non-energy benefits, incorporating additional aspects to make the tool effective for use in the United States.
Other
0 stars 0 forks source link

Data validation requirement collection/clarification #113

Open RLiNREL opened 3 weeks ago

RLiNREL commented 3 weeks ago

Objective: requirement collection and clarifications for the input form validation.

RLiNREL commented 3 weeks ago

Attaching a table for clarification about input field validations. This will be shared through email and individual meetings to ensure agreements across the team. NEB-tool_Input_Form_Validation_Clarification_Table_06-07.xlsx

RLiNREL commented 3 weeks ago

Kristina's comment:

For the input field:

For the required option (two -tier):

For display results:

RLiNREL commented 3 weeks ago

Jordan's comment:

  • The underlying code base should support Latin1, Double-Byte and any other character sets that will make it possible to be translated in other languages than English.
  • Support UTF-8 (Latin1, Double-Byte, other languages)

The NEB tool shall have fields for each KPI in which qualitative and/or historical information, e.g., past energy audits and results, can be entered. Each field should have enough character space to accommodate up to 500 words.

  • No limit for qualitative and/or historical information. "Google says that text contains on average 5 characters per word, so we’re talking 2500 characters minimum. Let’s be safe and go with ~10,000 characters. I would advocate to not impose any arbitrary limit other than those necessary for UI or performance reasons."
RLiNREL commented 3 weeks ago

Sarah's comment:

To add validation for ROI calculations and other inputs to quantify NEBs later

RLiNREL commented 3 weeks ago

Changes 06-10-24

  1. Removed max length for notes input field
  2. Updated string input fields length, 1-100 for short text (company name, team member name, etc.) and 1-255 for longer text (street name, email, etc.)
  3. Removed decimal places limit for number input type
  4. Updated phone number pattern for US and international
  5. Added a suggested column for inputs that are not required/unavailable at the beginning (default=0) but should be updated for accurate evaluation/reporting, such as costs and savings