docs: [DHIS2-18603] add Bulk data entry Plugin developer portal docs #4066
Conversation
…ta & use invalidateQueries & store only configKey in IndexBD
| id: introduction | ||
| --- | ||
|
|
||
| The Bulk Data Entry Plugin is a powerful feature in the DHIS2 Capture app that enables users to perform bulk operations on multiple tracked entities or event records simultaneously. This plugin significantly improves efficiency when working with large datasets by allowing users to perform actions on multiple records at once, reducing the time spent on repetitive data entry tasks. |
There was a problem hiding this comment.
bulk operations on multiple tracked entities or event records simultaneously.
I feel this overlaps with the bulk operation feature we already have in the working list. Was it intentional? I don't have a strong alternative suggestion yet. Let me think about it.
There was a problem hiding this comment.
I used the bulk operation docs as a starting point, which is probably why they ended up looking quite similar. Do you have any suggestion on how to reword it?
| id: introduction | ||
| --- | ||
|
|
||
| The Bulk Data Entry Plugin is a powerful feature in the DHIS2 Capture app that enables users to perform bulk operations on multiple tracked entities or event records simultaneously. This plugin significantly improves efficiency when working with large datasets by allowing users to perform actions on multiple records at once, reducing the time spent on repetitive data entry tasks. |
There was a problem hiding this comment.
In the introduction, I'd recommend showing some visuals of what can be made with the plugin here, to give readers a sense of what the plugins are exactly before going into the configuration details -- something like "For a program with one or more configured Bulk Data Entry plugins, links will appear [here, here, and here] that lead to a full-page plugin view that could look like [this]"
The screenshots in the "Selecting a Plugin Configuration" section in manual-setup look good for this, for example! 🙂
KaiVandivier
left a comment
KaiVandivier
left a comment
There was a problem hiding this comment.
Content looks good! 🙂
I made a plugin and noticed a few discrepancies though, like the one mentioned in another comment (so I also couldn't test the trackedEntities prop on the plugin)
I also noticed the size of the plugin was a little short; I haven't looked closely, but more recent versions of @dhis2/app-runtime for the Capture app and @dhis2/cli-app-scripts for plugins might help
|
Hi @KaiVandivier,
The
We're aware that the plugin height can be improved. Our plan is to adjust it once the first iteration of the Plugin is ready and we have a clearer idea of the final UX design. I’ll keep your suggestions in mind. Thank you for the review! |
| id: introduction | ||
| --- | ||
|
|
||
| The Bulk Data Entry Plugin is a powerful feature in the DHIS2 Capture app that enables users to perform bulk operations on multiple tracked entities or event records simultaneously. This plugin significantly improves efficiency when working with large datasets by allowing users to perform actions on multiple records at once, reducing the time spent on repetitive data entry tasks. |
There was a problem hiding this comment.
"The Bulk Data Entry Plugin is a powerful feature in the DHIS2 Capture app that enables developers to create and configure plugins that can process tracked entities or event records in bulk. This plugin point enables extending the Capture App to tailor bulk data operations as per a specific use-case. For example: You can create a Plugin that allows users to add an event on multiple tracked entities in a program at once, reducing the time spent on repetitive data entry tasks."
Thinking out loud here. My main thinking is, we should talk more about the plugin point, and only give less detailed examples of the actual plugin. Let me know what others think @karolinelien @JoakimSM @simonadomnisoru
There was a problem hiding this comment.
"The Bulk Data Entry Plugin is an extension point that can be accessed through the Search page or Working list page in Capture app. This extension point enables developers to create and configure plugins for custom bulk operations on tracked entities carried over from the working list page or added manually in the plugin itself.
The main reason for developing this extension point in the DHIS2 Capture app was to support a plugin for bulk data entry in a grid form, adding new events to all tracked entities in a list, including applying same values for a column or copy and pasting values from a row to another. The aim is to reduce time spent on data entry, for example secondary from paper forms."
I am having a hard time talking about the extension point without mentioning the main usecase that is the reaosn behind it, so don't think my rewrite is any better in that sense... :D
There was a problem hiding this comment.
You're right, it's difficult to explain without mentioning the main use case. Your rewrite sounds better to me, so let's go with that.
karolinelien
left a comment
karolinelien
left a comment
There was a problem hiding this comment.
I am having a hard time rewriting this without talking too much about the main use case of bulk data entry. But have a look at my comments :)
| id: introduction | ||
| --- | ||
|
|
||
| The Bulk Data Entry Plugin is a powerful feature in the DHIS2 Capture app that enables users to perform bulk operations on multiple tracked entities or event records simultaneously. This plugin significantly improves efficiency when working with large datasets by allowing users to perform actions on multiple records at once, reducing the time spent on repetitive data entry tasks. |
There was a problem hiding this comment.
"The Bulk Data Entry Plugin is an extension point that can be accessed through the Search page or Working list page in Capture app. This extension point enables developers to create and configure plugins for custom bulk operations on tracked entities carried over from the working list page or added manually in the plugin itself.
The main reason for developing this extension point in the DHIS2 Capture app was to support a plugin for bulk data entry in a grid form, adding new events to all tracked entities in a list, including applying same values for a column or copy and pasting values from a row to another. The aim is to reduce time spent on data entry, for example secondary from paper forms."
I am having a hard time talking about the extension point without mentioning the main usecase that is the reaosn behind it, so don't think my rewrite is any better in that sense... :D
| The Bulk Data Entry Plugin is a powerful feature in the DHIS2 Capture app that enables users to perform bulk operations on multiple tracked entities or event records simultaneously. This plugin significantly improves efficiency when working with large datasets by allowing users to perform actions on multiple records at once, reducing the time spent on repetitive data entry tasks. | ||
|
|
||
| Some use cases include: | ||
|
|
||
| 1. Enter data for multiple tracked entities at the same time | ||
| 2. Validate and update data across multiple tracked entity records simultaneously | ||
| 3. Update the status of multiple events in one go | ||
| 4. Whatever bulk operations you can imagine! |
There was a problem hiding this comment.
"Some plugin use cases for the extension point can include:
- Enter data for multiple tracked entities at the same time (Forthcoming core Capture plugin)
- Validate and update data across multiple tracked entity records simultaneously
- Update the status of multiple events in one go
- Merging or deduplicating tracked entities
- Any other custom bulk operations or changes your workflow might require"
I think we are just suggesting some things the extension point can be used for and specifying which one we are working on. Is that too specific..?
|
|
🚀 Deployed on https://deploy-preview-4066.capture.netlify.dhis2.org |
karolinelien
left a comment
karolinelien
left a comment
There was a problem hiding this comment.
The recent updates is based on my comments, so this looks good for me. But what does @ameenhere and @JoakimSM think, is it still to specific to the bulk data entry usecase?
|
🎉 This PR is included in version 104.1.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Developer portal documentation for the DHIS2-18603 epic