Custom Workqueues

[rikukissa]

Description

This feature provides the ability to create custom views of records for each system user type - available as menu options in the left hand sidebar.

Implements country config configurable workqueues leveraging advanced searches search parameters

Reasoning

We currently have hardcoded workqueues (left hand side menu options eg. In Progress, ready for review...)
Countries want greater control over what each of their custom system users can see and do

Enables:


• Adds custom workqueues for each custom system user role

• Each custom view is pre-filtered to support a countries business process flows. eg. event type, record status, time period since last action etc
• Adds an Assigned to you workqueue - that lists all assigned records
• Adds Drafts as a workqueue based on a user having a declare scope
• Adds a Recent workqueue as default in country-config

https://opencrvsworkspace.slack.com/archives/GHCFF9M6X/p1717000313286379

Dev tasks

• In case you need to work with Redux: familiarize yourself with redux-toolkit and start using it instead of writing the default boilerplate. Before moving state to Redux, consider whether Apollo's cache is sufficient!
• Cleanup: deprecate and remove everything related to EXTERNAL_VALIDATION_WORKQUEUE and related UI
  • Also remove registrationHome query completely from the frontend
• Create documentation around how to create / edit / remove workqueues

[naftis]

@jpye-finch

Currently we fetch all workqueues at the same time when the app is loaded.

Is there value in that or could we load each of them dynamically when that workqueue page is opened? This could simplify the workqueue loading, just an thought at this point though. If you don't have internet you can see the workqueues you have opened earlier.

[jpye-finch]

Yes it could work. Would the experience not be same as we have to day? When you navigate between workqueues after login and initial load. You see the latest state of the workqueue whilst we check for changes.

As long as you can still see your assigned records so you can work offline. We are good imo

[euanmillar]

This is also functional and based on experiment ascertain estimate.

[naftis]

@jpye-finch flagging this for ideation and design:

Frontend code logic - partly because of the current UX - around the downloaded records and fetched workqueues is confusing at points, as we want to keep the workqueues updated after a record leaves the outbox. There is no clear way to see which workqueue received the record other than understanding the backend business flow.

Could there be a concept of having a separate workqueue similar to Outbox for "My records". By default the records you've created are also downloaded and saved there? Then the workqueues themselves could be (purely?) online-dependent, while you could still work on your offline-workqueues Outbox and My records.

[jpye-finch]

@naftis thanks for this.

I did have an 'Assigned to you' workqueue in the current epic description.
https://www.figma.com/board/kbRxrSeitNzGahyojbdLM5/OpenCRVS-Roadmap?node-id=235-3617&t=Q3hnASzRS1WJvdAT-4

[jpye-finch]

@naftis
Outbox and Assigned to you conditional on the user having at least one of these scopes:

record.declare-{event}
record.declaration-send-for-approval
record.declaration-submit-for-updates
record.review-duplicates
record.register
record.declaration-archive
record.registration-reinstate
record.registration-revoke
record.print&issue-certified-copies
record.registration-correct
record.registration-request-correction

[jpye-finch]

@naftis I don't see in the dev tasks here to allow the icon of the workqueue to be configurable. Allowing you to set the icon from the Phosphor Icons library

[jpye-finch]

@naftis
Also in this version will workqueues be based on scopes? Then we refactor so you can specify the custom users who have the workqueue?

users: ["Healthcare Worker", "Police Officer", "Registrar"]
instead of
requiredScopes": ["view-in-progress-records"],

[rikukissa]

@naftis Also in this version will workqueues be based on scopes? Then we refactor so you can specify the custom users who have the workqueue?

users: ["Healthcare Worker", "Police Officer", "Registrar"] instead of requiredScopes": ["view-in-progress-records"],

@jpye-finch good question.. My knee jerk reaction is that we should define as much as we can with just raw scopes. "User types" would remain as a very thin light layer for labeling different user scope sets but wouldn't otherwise be referred to anywhere in configuration.
This would make the workqueue driven by "you have access to feature X, thus you see this workqueue" and less "you are a Police officer, so you see this workqueue".

I do see an issue here though as the workqueues are effectively just different types of advanced searches and not fully connected always to a functionality / scope. Makes me think a country should be able to specify a scope for a workqueue like custom:view-childs-with-letter-a which they could then also add to a user type they want.

[rikukissa]

@naftis this starts to look very good! One topic I'd still want you to consider – what's the upgrade story for countries upgrading from 1.6? In the custom scopes PR you might remember I had this script.

Is it necessary as we know every country just has the basic set? Maybe we just add the code to CC and countries get it when they pull?

Feel free to mark as Ready to build after @jpye-finch signs it off. @Zangetsu101 I think someone can start working on this even before the scopes PR is merged, right? Just using the scopes we have today. Might require some ingenuity but still :)

[naftis]

@rikukissa I'd say we add the code to CC and the countries get it when they pull. I know there are custom workqueues implemented in some countries: we need documentation over how the workqueues can be configured after the technical work is done.

[rikukissa]

@naftis btw, I remember you started doing some exploration for this task – if you have any branches etc open, good to link them to the task description

[naftis]

Not really - the design became different as we decided to load all of the work queues' first pages simultaneously.

[anninawersun]

Uganda requirement: #6270 Senior Registration Officer user required

A Registrar plus:

Can review correction requests (if senior approval required)
Can review revoke and reinstatement requests (after review from the ED and Legal)