bcgov / cthub

Apache License 2.0
2 stars 5 forks source link

CTHUB - Implementation of File Requirements #402

Open Lalita-Lala opened 1 month ago

Lalita-Lala commented 1 month ago

Describe the task Implement a file requirements feature that will be visible to users after a program has been selected. This feature will provide users with specific guidelines on how to prepare their dataset to meet system expectations, ensuring proper formatting and structure before file upload.

Mockups Prototype - https://www.figma.com/proto/K7gNHRnlYuG27w8XGVquY5/Warnings%2FErrors?page-id=0%3A1&node-id=563-275&node-type=frame&viewport=1489%2C-616%2C0.09&t=dyOi09ahQ34TwtGe-1&scaling=scale-down-width&content-scaling=fixed&starting-point-node-id=563%3A275 Mockups - https://www.figma.com/design/K7gNHRnlYuG27w8XGVquY5/Warnings%2FErrors?node-id=567-799&t=D1b6xL7cuq7xDBsp-1

Purpose To guide users in preparing their datasets according to the necessary criteria, avoiding errors and ensuring a smoother upload process. The file requirements will offer detailed instructions about the sheet name, required columns, and file format, which users must follow.

  1. Sheet Name: • The sheet name must be included in the dataset and will correspond to the selected program. • For instance, if the user selects Go Electric Rebates Program, the sheet name will reflect that program “Distribution List - Master”. If the program changes, the sheet name will automatically update to the new program’s requirement.
  2. Column Names: • All required column names must exactly match those provided in the template. This ensures consistency and proper alignment with the system’s expectations.
  3. File Format: • The required file format will be clearly specified, ensuring users understand the acceptable formats (e.g., .xlsx).
  4. Persistent Visibility: • The file requirements will remain visible on every subsequent screen after the program is selected, ensuring that users have continuous access to the necessary information as they navigate through the flow. • This section will not disappear or change position, providing ongoing guidance throughout the process.

Acceptance Criteria