search

msupply-foundation / open-msupply

Open mSupply represents our most recent advancement in the Logistics Management Information System (LMIS), expanding on more than two decades of development inherited from the well-established legacy of the original mSupply.
https://msupply.foundation/open-msupply/
Other
23 stars 14 forks source link

Feature: Basic Reports #3880

Closed lache-melvin closed 3 months ago

lache-melvin commented 6 months ago

Basic Reports

Spec Document

Tasks

Summary

An area in omSupply for reports:

Additional context 💌

How we use report already ?

Export to excel ?

How do we keep report working (backwards compatibility) ?

Extra tools to speed up report display (like seeing to arguments etc..)

Meeting 25-06 > Should still have custom 'branding' on reports, which means the 'data' part of the report should be identified, so it can be displayed as a table in omSupply. > > Filter detail view is designs is a swipe detail view on the right, this for v1 could just be normal details view (like shipments etc) > > There needs to be a button on filters to apply filter (generate report). Starting point for a report could be blank page with just the filter detail view. > > Need to also export to excel, though we could just export data to csv, but would require a mapping between html result and something, it's probably good to make this something a starting point for future extensions (thus to use some excel library rather then csv), although would also be good to check how excel xml is structure and if there is more direct mapping between html and xml > > Preference button from report view would show the configurations from this issue: https://github.com/msupply-foundation/open-msupply/issues/3882 > > Program reports to be consolidated into the same report page > > Should display the table of data before printing, for now just render output html (the data bit of it), no pagenation > > Reports page should have some filter at some stage (cause could have a lot of reports) > > Can get styles from Figma

Permissions ?

Tests

We will try to write full set of tests and setup instructions in this epic. As we submit PRs the test will be updated here and referenced in the PR. This will allow QA team to build test templates by referencing one set of test instructions

  1. The following store preferences sync correctly and are displayed in the Detail Panel of the Reports ListView page:

Screenshot 2024-07-12 at 4 53 14 PM

Screenshot 2024-07-29 at 9 29 35 AM

  1. When omSupply is migrated from version < 2.2, store preference should be updated to include values configured in mSupply (configure in mSupply before upgrade, sync store preference changes before upgrade, these preferences should be shows after upgrade to omSupply)

  2. Download reports from report repository, upload them to OG with subcontext: StockAndItems or Expiring. Sync. The reports should now show up on the report page.

  3. Click on one of the reports on the report page and ensure that it shows the correct report

  4. Try using the filters (Note: There is a bug if you type to fast when filtering, will be looked at)

  5. For item usage, generate report base analysis on whatever months you have your lookback_months set to

  6. Check the print button is working

  7. Check the export button downloads and opens in excel

Moneyworks Jobcode 🧰

OMS:REPT

Material

Report Menu

Screenshot 2024-07-08 at 5 31 27 PM

andreievg commented 4 months ago

https://github.com/msupply-foundation/msupply/issues/14465

andreievg commented 3 months ago

We had issue with Pagination in graphql in reports config, should spend some time thinking about how to make report more resilient to paginations in the future

roxy-dao commented 3 months ago

Carry over in #4668

marthakeezy commented 1 month ago

Basic Reports were tested in V2.3.0 Release testing, so moving to Done since there is a new issue linked above for carryover issues ✅