-
Notifications
You must be signed in to change notification settings - Fork 2
User Flows Checklist
Pierre Bastianelli edited this page Jun 4, 2021
·
24 revisions
These can be used as a checklist for manual QA, or to help qualify the surface area that may be affected by proposed changes. See the linked documentation for more details about the views referenced.
- Request access to an operation
- view status of access request
- automated emails:
- received by CAS when access to an operation is requested
- received by reporter when access has been approved
- "View Facilities" for an operation
- Use call to action buttons to view or start a CIIP application for an individual facility and reporting year:
- Apply for CIIP for this facility
- Resume CIIP application
- View submitted application
- Interacting with the list of facilities
- SearchTable shared component
- sort list by column attributes
- search list by various factors (+ clear search/filter results):
- operator name
- facility name
- facility type
- BC GHG ID
- reporting period of last SWRS report
- application status
- application #(ID)
- select Reporting Year for which applications are listed
- navigate through multiple pages of facilities results (for operations with many facilities)
- Click “Apply for CIIP for this facility” on facilities page
- [view warning dialog if proceeding before their SWRS report has been imported]
- Cancel
- Begin Application Anyway
- [view warning dialog if proceeding before their SWRS report has been imported]
- View the new application disclaimer interstitial page
- Consent and Continue
- automated email received by reporter
- Consent and Continue
Completing the CIIP Application (multi-page form)
- Administration tab:
- typing results in feedback (top right of form) that input has been saved / is saving
- input validation with relevant error messages shown on clicking "Save and Continue"
- fields may vary in their specific validation constraints
- Validation errors halt the "Save and Continue" navigation to the next form tab
- Validation errors do not halt navigation directly to next form tab at the top
- Any form tab: "Add a comment" opens a textarea for notes which can be saved and edited
- text shows up under the "comments" fields in the application summary (for everyone who views the application)
- Emission tab:
- one "Report a Problem" widget per fuel/product
- typing in the "Tonnes" input populates the "Tonnes (CO2e)" column on right based on the multiplier
- "Hide/Show gases with no reported emissions" collapses/expands the data inputs for those fields
- Fuel tab:
- one "Report a Problem" feature per fuel/product
- search or scroll dropdown to select Fuel Name
- Production tab:
- selecting a product or service
- products that have been added may be removed
- search or scroll dropdown to select Product or Service
- products are listed alphabetically in the dropdown
- only products associated with selected NAICS code are shown in the dropdown
- Summary tab:
-
Form input validation: if form validation errors still present, "Override and Justify" interface is presented
- submission for certification is blocked until either a justification is completed, or error fixed
- click to expand textarea, type explanation, and Save/Edit/Delete
-
Application data validation: if failed, a number of messages will appear in a warning box
- carbon-taxed fuels reported must match data from SWRS
- total emissions reported must match data from SWRS
- emissions reported must have a matching fuel reported in the same emission category
- all mandatory products for the application's NAICS code must have been reported
- at least one CIIP-eligible product must has been reported
- shows all data entered in each form tab, under headings
- form sections/headings are collapsible
- includes text entered under "Add a comment" as "comments" for each section/emission/fuel
- has section at bottom of page that prompts next steps for the application submission
- "Before you submit" disclaimer
- Submit button
- automated emails upon submission:
- received by reporter, confirming submission
- received by admins, notifying of new submission
- automated emails upon submission:
-
Form input validation: if form validation errors still present, "Override and Justify" interface is presented
- Allocation of emissions is required:
- if "yes", the reporter will see an input where they have to type the allocated emissions in tCO2e
- if "no", the reporter will not see that input, and the Additions/Subtractions to/from facility emissions will be used to calculate the incentive. This setting is only supported if the reporter reports one CIIP (benchmarked) product
- CIIP (benchmarked) product: if "yes", the product will appear in the incentive table when reviewing a submitted application, otherwise it will not
- Production amount needs to be reported: this setting should be "yes" for any CIIP product. If set to "no", the reporter will not see any input to enter a production amount.
-
[Purchased electricity | Purchased heat | Emissions from EIOs] is added to facility emissions:
- if set to "yes":
- if this product is reported in a CIIP application, but [Purchased electricity | Purchased heat | Emissions from EIOs] is not, a warning will be displayed in the Production and Summary tabs to the reporter
- if this product does not require allocation of emissions, the app will add the reported [Purchased electricity | Purchased heat | Emissions from EIOs] CO2e to the facility emissions prior to calculating the product's Emission Intensity
- if set to "no":
- the reporter may report [Purchased electricity | Purchased heat | Emissions from EIOs] or not without any impact on warning messages or incentive calculations
- if set to "yes":
-
[Generated electricity | Sold electricity | Generated heat | Sold heat] is subtracted from facility emissions:
- if set to "yes":
- if this product is reported in a CIIP application, but [Generated electricity | Sold electricity | Generated heat | Sold heat] is not, a warning will be displayed in the Production and Summary tabs to the reporter
- if this product does not require allocation of emissions, the app will subtract the reported [Generated electricity | Sold electricity | Generated heat | Sold heat] CO2e from the facility emissions prior to calculating the product's Emission Intensity
- if set to "no":
- the reporter may report [Generated electricity | Sold electricity | Generated heat | Sold heat] or not without any impact on warning messages or incentive calculations
- if set to "yes":
- Program Administration
- Submitted applications
- Data Insights (Metabase)
- Reporting operations
- Access Requests
- Operators
- Facilities
- Click on Report a problem
- Opens email to [email protected]
- Click “Help” button
- opens a bubble with options:
- email [email protected]
- view help documentation
- opens a bubble with options:
- Click “Program Administration > Submitted Applications” on the dash
- Interacting with the list of applications
- sort list by column attributes
- search list by various factors (+ clear search/filter results):
- application ID
- operator name
- facility name
- reporting year
- submission date
- status
- navigate through multiple pages of applications results
- Use button to view an individual CIIP application:
- View application
- Click “Reporting Operations > Access Requests” on the dash
- Interacting with the list of access requests
- sort list by column attributes
- search list by various factors (+ clear search/filter results):
- user ID
- first name
- last name
- operator
- status
- View operator access requests
- automated emails:
- received by reporter when access has been approved
- Pending status will show approve and reject buttons
- Approved status will show a Reject button
- Rejected status will show a Reset button
- automated emails:
- Click “Reporting Operations > Operators” on the dash
- Search for an operator:
- Click “Find Operator” and search or scroll dropdown to select operator
- view operator information table
- operator name
- trade name
- CRA business number
- SWRS Report ID
- Add operator
- Click “Add operator”
- Enter operator information
- all fields should be required for submission
- Save
- Close
- Click “Reporting Operations > Facilities” on the dash
- Search for a facility:
- Click “Find Facility” and search or scroll dropdown to select facility
- view facility information table
- operator name
- facility name
- facility type
- BCGHG ID
- SWRS Report ID
- Add a new facility
- Click “Add a new facility”
- Enter facility information
- all fields should be required for submission
- Save
- Close
- Program Administration
- Review Submitted applications
- Review Data Insights (Metabase)
- Products and Benchmarks
- Reporting Periods
- Reporting operations
- Manage Access Requests
- Manage Operators
- Manage Facilities
-
Form Configuration
- NAICS Codes
- Allowable Products
-
Users
- View all users
- Report a problem
- Opens email to [email protected]
Complete all of the user flows listed for Analysts [include a link to that doc section], plus the following:
- Click “Program Administration > Products and Benchmarks” on the dash
- Interacting with the list of products and benchmarks
- sort list by column attributes
- search list by various factors (+ clear search/filter results):
- product
- settings
- modified (y/m/d)
- benchmark
- eligibility threshold
- allocation of emissions
- CIIP benchmarked
- status
- navigate through multiple pages of products results
- Adding a new product
- Use New Product button
- Enter basic information
- Radio buttons automatically on "yes" under Basic information
- Radio buttons automatically on "no" under Additions to facility emissions
- Radio buttons automatically on "no" under Subtractions from facility emissions section
- input validation with relevant error messages shown on clicking "Add Product"
- "Please fill out this field"
- Once published the fields should not be editable
- If still in draft the fields should still be editable
- Enter basic information
- Managing product details* (note: changing these settings changes how validation of the reporter-facing application form works)
- Click Settings dropdown for a product (gear icon)
- Product details
- When selected, modal window with Product information appears
- Fields cannot be edited if published
- If still in draft the fields should still be editable
- Archive product
- Once archived the fields should not be editable nor can this action be reversed
- Verify expected effects in the reporter application form of these settings
- Benchmark
- When selected, modal window with Benchmark information appears
- Fields can be edited
- Past benchmarks table. Blank if there aren't any past benchmarks
- Save button to save edits and/or close window
- Linked products (Obsolete)
- When selected, modal window with Product associations appears
- type or search for product to link
- click “+ Link Product” to add it as a product association. This linkage should be immediately saved.
- Product will be added to table below
- click “-” button to remove association
- Close button to close window
- After linking products, a reporter should see product associations enforced
- “Resume application > Production tab”
- Select product with associations
- yellow message will appear indicating required products to add
- yellow messages should disappear once required products are added
- When selected, modal window with Product associations appears
- Product details
- Click Settings dropdown for a product (gear icon)
- Click “Program Administration > Reporting Periods” on the dash
- Interacting with the list of Reporting periods
- Edit button to edit the reporting period
- All fields should be required
- Save reporting year button will save and close the window
- Edit button to edit the reporting period
- Adding a new reporting year
- Use New reporting year button
- All fields should be required
- Save reporting year button will save and close the window
- Click “Form Configuration > NAICS Codes” on the dash
- Click “New NAICS Code"
- all fields except Sector should be required
- input validation with relevant error messages shown on clicking "Submit"
- 'x' to close window
- Click “Delete” for one of the NAICS codes
- modal dialog should appear, showing the specific NAICS code to delete
- Confirm delete
- Cancel
- NAICS codes cannot be edited. To change a NAICS code's data, that code should be deleted & recreated.
- The added NAICS code is available for reporters to select, in the 'Administrative Data' tab
- Click “Form Configuration > Allowed Products” on the dash
- Select Industry NAICS code in left sidebar
- search or scroll dropdown to select Product
- select "add as mandatory" will add Product to table with "yes" under "Mandatory" column
- select "add as optional" will add Product to table with "no" under "Mandatory" column
- "delete" button will have a warning modal showing the specific NAICS code to delete
- Confirm Delete
- Cancel
- Select another NAICS code in left sidebar
- should populate new allowable product details on the right
- "Manage Industry (NAICS) Codes" link navigates to list of NAICS codes
- "Manage Products" link navigates to the Manage Products and Benchmarks page
- Resuming an application as a reporter shows the product/NAICS configuration as per these points
- View user account details
- Edit user account details
- View user account details
- Edit user account details
- View static content
- homepage
- every view listed directly under
pages/
andpages/resources
; or see docs to discover.
- Register or Sign in
- automated email received by reporter on signup
- Log in as an analyst/admin
- Log in using IDIR
- analyst access granted in Keycloak by admin
- Log in as a reporter
- Log in with username and password
- Enter user profile information and submit
Custom Footer