bcgov / bcgov/cas-reporting

Simple Report Workflow

Open
#484 3 comments 0 reactions 0 assignees View on GitHub
Backlog Refinement KEEP User Story
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

#### Description:
There may be situations where a Reporting or Regulated Operation will need to fill out a Simple Report instead of an Annual Report. This ticket is to capture the work required to build the simple report workflow.

[Simple Report Workflow Wireframes](https://www.figma.com/design/LsDmLDCdnJqI8UahyqvOD8/BCIERS-Designs?node-id=18885-5089&t=9EePik5cYAopZX3Y-4)

There is a separate ticket for the simple report's Final Review Page #400
#### Acceptance Criteria:

Given that I am an Industry User who needs to fill out a simple report
When I am on the Review Operation Information Page and select "Simple Report" for report type
Then I am shown the simple report workflow (see figma link above)

#### Development Checklist:

- [ ] Create report flows:
- [ ] `bciers/apps/reporting/src/app/components/taskList/reportingFlows/lfoSimpleReportFlow.ts`
- [ ] `bciers/apps/reporting/src/app/components/taskList/reportingFlows/sfoSimpleReportFlow.ts`
Example:
```
import { HeaderStep, ReportingFlowDescription, ReportingPage } from "../types";

export const simpleReportFlow: ReportingFlowDescription = {
[HeaderStep.OperationInformation]: [
ReportingPage.ReviewOperationInfo,
ReportingPage.PersonResponsible,
ReportingPage.ReviewFacilities,
],
[HeaderStep.EmissionsData]: [ReportingPage.EmissionsData],
[HeaderStep.SignOffSubmit]: [
ReportingPage.FinalReview,
ReportingPage.Attachments,
ReportingPage.SignOff,
],
};
```
- [ ] In `bciers/apps/reporting/src/app/components/taskList/reportingFlows.ts` add `lfoSimpleReportFlow` and `sfoSimpleReportFlow`
- [ ] In `bciers/apps/reporting/src/app/components/taskList/reportingFlows.ts` add condition based on const reportType = reportOperationData.operation_report_type;

- [ ] Add routing rules in `bciers/apps/reporting/src/middlewares/withRuleHasReportRouteAccess.ts`
- [ ] Checklist item
- [ ] Meets the DOD

#### Definition of Ready (Note: If any of these points are not applicable, mark N/A)

- [ ] User story is included
- [ ] User role and type are identified
- [ ] Acceptance criteria are included
- [ ] Wireframes are included (if required)
- [ ] Design / Solution is accepted by Product Owner
- [ ] Dependencies are identified (technical, business, regulatory/policy)
- [ ] Story has been estimated (under 13 pts)

#### Definition of Done (Note: If any of these points are not applicable, mark N/A)

- [ ] Acceptance criteria are tested by the CI pipeline
- [ ] UI meets accessibility requirements
- [ ] Configuration changes are documented, documentation and designs are updated
- [ ] Passes code peer-review
- [ ] Passes QA of Acceptance Criteria with verification in Dev and Test
- [ ] Ticket is ready to be merged to main branch
- [ ] Can be demoed in Sprint Review
- [ ] Bugs or future work cards are identified and created
- [ ] Reviewed and approved by Product Owner

#### Blocked By/Blocking

#### Notes:

-

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the existing flows in bciers/apps/reporting/src/app/components/taskList/reportingFlows/ and reportingFlows.ts, then inspect withRuleHasReportRouteAccess.ts and the linked wireframes. Implement the two simple-report flow entries, select them from operation_report_type, and add the required route access rules. Done means the acceptance scenario is covered and the listed files and checklist items are complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.