LCFS - Workflow / Timeline Builder Utility
- Dominant language
- Python
- Stars
- 6
- Forks
- 6
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 87
Description
Note: I have pitched this as a hackathon project, some prior investigation may be beneficial
### **Description**
Create a new internal feature that allows staff to build and manage customizable workflows or timelines.
This utility should support defining multi-step processes, assigning steps to users, tracking progress, attaching files, and optionally requiring sign-off.
Wireframe will be provided later.
### **Wireframe**
*([CI application tracker option](https://preview.uxpin.com/e0e2f15fc1b52987fd0287ad8c8103452dd16d60#/pages/217327399/simulate/sitemap))*
### **Purpose and benefit to user**
This feature enables staff to create structured, trackable workflows for processes that require multiple steps, coordinated actions, and clear accountability.
It provides visibility, improves consistency, and enables communication through notifications and comments throughout the lifecycle of a workflow.
### **Acceptance Criteria**
- [ ] Staff can create a new workflow/timeline.
- [ ] User can define any number of steps in the workflow.
- [ ] Each step can be named.
- [ ] For each step, user can set whether it is an **IDIR** or **BCeID** step.
- [ ] Users can configure whether the step is **visible** or hidden.
- [ ] Users can mark a step as **complete**.
- [ ] Each step supports a **completion date** field.
- [ ] Each step supports **Require sign-off (Y/N)**.
- [ ] Users can **add comments** to each step. (Y/N)
- [ ] Steps can allow **attachments (Y/N)**.
- [ ] Steps can be assigned (on the front-end) to a specific user or left for **self-assignment** (similar to Compliance reports)
- [ ] The system sends a **notification** when a step is completed. (Y/N)
- [ ] A **progress bar–style interface** visually indicates workflow progression.
- [ ] Each step has a unique **URL** linking to the step.
- [ ] All workflow data persists correctly and is editable by permitted users.
- [ ] The system enforces role-based visibility and permissions for IDIR vs. BCeID steps.
### **Development Checklist**
- [ ] Create backend data model for workflows and steps.
- [ ] Add APIs for creating, updating, assigning, and completing steps.
- [ ] Implement role-based visibility and assignment logic (IDIR/BCeID).
- [ ] Add notification hooks triggered on step completion.
- [ ] Implement comments and attachments functionality per step.
- [ ] Add sign-off mechanism for steps requiring approval.
- [ ] Create UI for workflow creation and editing (wireframe pending).
- [ ] Add progress bar component reflecting workflow status.
- [ ] Add optional URL field to steps.
- [ ] Add permissions for self-assignment and reassignment.
- [ ] Ensure accessibility and keyboard navigation standards.
### **Notes**
- Wireframe will define final layout and user flow.
- Consider future extensibility for templating workflows or duplicating existing ones.
- Consider versioning or archiving workflows after completion.
Contributor guide
Research direction
No files, tests, or entry points are named. Start by reviewing the existing Compliance reports assignment flow and the linked CI application tracker wireframe, then clarify the final wireframe and scope before implementation. Done means the listed workflow, step, assignment, permission, notification, comment, attachment, sign-off, URL, accessibility, and progress requirements are supported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- full-stack
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100