Merge branch 'staging'

msupply-foundation · Aug 22, 2024 · be46883 · be46883
2 parents be30005 + a7faa92
commit be46883
Show file tree

Hide file tree

Showing 133 changed files with 560 additions and 163 deletions.
diff --git a/content/.DS_Store b/content/.DS_Store
diff --git a/content/docs/getting_started/images/_index.md b/content/docs/getting_started/images/_index.md
@@ -0,0 +1,10 @@
++++
+title = "Getting started"
+description = "Get started with Open mSupply"
+date = 2025-05-01T18:00:00+00:00
+updated = 2021-05-01T18:00:00+00:00
+template = "docs/section.html"
+sort_by = "weight"
+weight = 6
+draft = false
++++
diff --git a/content/docs/getting_started/images/export_button.png b/content/docs/getting_started/images/export_button.png
diff --git a/content/docs/getting_started/images/goto_report.png b/content/docs/getting_started/images/goto_report.png
diff --git a/content/docs/getting_started/images/goto_stock_status.png b/content/docs/getting_started/images/goto_stock_status.png
diff --git a/content/docs/getting_started/images/print_button.png b/content/docs/getting_started/images/print_button.png
diff --git a/content/docs/getting_started/images/report_detail.gif b/content/docs/getting_started/images/report_detail.gif
diff --git a/content/docs/getting_started/images/report_filter.png b/content/docs/getting_started/images/report_filter.png
diff --git a/content/docs/getting_started/images/report_list_view.png b/content/docs/getting_started/images/report_list_view.png
diff --git a/content/docs/getting_started/images/report_preferences.gif b/content/docs/getting_started/images/report_preferences.gif
diff --git a/content/docs/getting_started/report.md b/content/docs/getting_started/report.md
@@ -0,0 +1,79 @@
++++
+title = "Reports"
+description = "Open mSupply Reports."
+date = 2022-03-19T18:20:00+00:00
+updated = 2022-03-19T18:20:00+00:00
+draft = false
+weight = 31
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+toc = true
++++
+
+The reports page gives you an overview of the reports available in Open mSupply.
+You can access the reports page by clicking on the `Reports` menu item.
+![goto_report](/docs/getting_started/images/goto_report.png)
+
+You will be presented with a list of reports that you can generate. The reports
+listed below are the standard reports and will already be set up for you. If
+you need a custom report, please contact mSupply support at [[email protected]](mailto:[email protected]).
+
+![report list](/docs/getting_started/images/report_list_view.png)
+
+The reports are generated based on preferences which are set up in the mSupply
+central server. See [report
+preferences](https://docs.msupply.org.nz/other_stuff:virtual_stores?s[]=threshold&s[]=overstock#notification_preferences)
+for more information about what these preferences are and how to set them up.
+
+You can view these preferences by clicking on the `More` button.
+
+![report preferences](/docs/getting_started/images/report_preferences.gif)
+
+## Generating reports
+
+Click on the report you want to generate. For this example, we will generate the
+`Stock Status` report.
+
+Click on the `Stock Status` report.
+![stock status](/docs/getting_started/images/goto_stock_status.png)
+
+You will be presented with a form where you can edit the filter criteria used by the report. Leave unchanged to display all items for the report.
+
+For the `Stock Status` report, you can filter the report based on the following criteria:
+
+- `Item Name`
+- `Item Code`
+
+If you enter values for both the code and name, the items shown would have to match **both** criteria i.e. entering a code of `01` and a name of `am` would only show items with a code that contains `01` and a name that contains `am`.
+
+The form also display which preferences the report is based on.
+
+![stock status filter](/docs/getting_started/images/report_filter.png)
+
+Click `Ok` to generate the report. If you find that you would like to narrow
+down the report while viewing it, you can click on the `Filter` button on the
+top right corner of the report which will open up the filter form again.
+
+![report detail](/docs/getting_started/images/report_detail.gif)
+
+### Printing a report
+
+To print a report, click on the `Print` button on the top right corner of the
+report.
+
+![print button](/docs/getting_started/images/print_button.png)
+
+A print preview window will open showing you what will be printed and allowing
+you to select the printer. This can then be printed using your browser by clicking print or
+using `control`+`P` (if using windows) or `cmd`+`P` keys on your keyboard (if
+using a mac).
+
+### Exporting a report
+
+To export a report to excel, click on the `Export` button on the top right corner of the report.
+
+![export button](/docs/getting_started/images/export_button.png)
+
+The report will be downloaded as an excel file.
diff --git a/content/docs/introduction/requirements.md b/content/docs/introduction/requirements.md
@@ -166,6 +166,7 @@ The table below shows which versions of mSupply and Open mSupply Central you wil
 | 1.4.00+             | 7.09.00+        | N/A                  |
 | 2.0.00+             | 7.14.04+        | 2.0.00+              |
 | 2.1.00+             | 7.14.04+        | 2.1.00+              |
+| 2.2.00+             | 7.14.04+        | 2.2.00+              |
 
 If you attempt to connect to an incompatible server you'll get an error message like this:
 

diff --git a/content/docs/replenishment/images/add_rnr.png b/content/docs/replenishment/images/add_rnr.png
diff --git a/content/docs/replenishment/images/add_rnr_empty.png b/content/docs/replenishment/images/add_rnr_empty.png
diff --git a/content/docs/replenishment/images/add_rnr_error_finalise.png b/content/docs/replenishment/images/add_rnr_error_finalise.png
diff --git a/content/docs/replenishment/images/add_rnr_error_no_periods.png b/content/docs/replenishment/images/add_rnr_error_no_periods.png
diff --git a/content/docs/replenishment/images/add_rnr_selected_period.png b/content/docs/replenishment/images/add_rnr_selected_period.png
diff --git a/content/docs/replenishment/images/goto_rnr.png b/content/docs/replenishment/images/goto_rnr.png
diff --git a/content/docs/replenishment/images/rnr_add_button.png b/content/docs/replenishment/images/rnr_add_button.png
diff --git a/content/docs/replenishment/images/rnr_detail.png b/content/docs/replenishment/images/rnr_detail.png
diff --git a/content/docs/replenishment/images/rnr_edit_line.gif b/content/docs/replenishment/images/rnr_edit_line.gif
diff --git a/content/docs/replenishment/images/rnr_finalise.png b/content/docs/replenishment/images/rnr_finalise.png
diff --git a/content/docs/replenishment/images/rnr_list.png b/content/docs/replenishment/images/rnr_list.png
diff --git a/content/docs/replenishment/images/rnr_print_and_export.png b/content/docs/replenishment/images/rnr_print_and_export.png
diff --git a/content/docs/replenishment/r-and-r-forms.md b/content/docs/replenishment/r-and-r-forms.md
@@ -0,0 +1,126 @@
++++
+title = "R&R Forms"
+description = "Introduction to R&R Forms"
+date = 2024-08-06T00:00:00+00:00
+updated = 2024-08-06T00:00:00+00:00
+draft = false
+weight = 46
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+lead = "Report and Requisition (R&R) Forms are used to report on item usage and request stock from suppliers. They help to ensure that you have enough stock on hand to meet the needs of your patients."
+toc = true
+top = false
++++
+
+## Setup
+
+To use R&R Forms, ensure that you enable the store preference for `Open mSupply: Uses program module`.
+
+![Store preference](/docs/programs/images/program_pref.png)
+
+You'll also need a program configured and visible in your store, and the program will need a period schedule associated with it.
+
+Start with configuring [periods and schedules](https://docs.msupply.org.nz/admin:schedules_periods), then create a program and associate the schedule.
+
+See the [mSupply docs](https://docs.msupply.org.nz/items:programs) for configuring programs - note though that you'll only need the start of this process, which is to create a program and associate a schedule. For R&R forms, the other program configuration aspects aren't used yet.
+
+## R&R Forms - List View
+
+Go to `Replenishment` > `R&R Forms` to view the list of R&R Forms.
+
+![R&R Navigation](/docs/replenishment/images/goto_rnr.png)
+
+You can click the column headers to sort the list by that column.
+
+![R&R List](/docs/replenishment/images/rnr_list.png)
+
+Clicking on an R&R form will take you to the details page.
+
+### Add an R&R Form
+
+To add an R&R Form, click the `Add Form` button on the top right corner of the screen.
+
+![Add Button](/docs/replenishment/images/rnr_add_button.png)
+
+A window will open for you to select the program, schedule, period and supplier for the R&R form.
+
+![Add R&R: empty](/docs/replenishment/images/add_rnr_empty.png)
+
+The first time you create an R&R form, you will need to select each of these options. After that, the inputs will be pre-filled with the previous period's data.
+
+<div class="imagetitle">Our most recent R&R form was from April 2024, for Program Tb. The same program, schedule and supplier are selected, and the next period is chosen automatically.</div>
+
+![Add R&R: pre-filled](/docs/replenishment/images/add_rnr.png)
+
+The first time you create an R&R form, you can select any available period. After that, you will only be able to select the next period in the sequence.
+
+<div class="imagetitle">The previous R&R form was for the APR 24 period</div>
+
+![Add R&R: pre-selected period](/docs/replenishment/images/add_rnr_selected_period.png)
+
+Note that you cannot create the next R&R form until the previous one is finalised:
+
+![Warning: need to finalise previous](/docs/replenishment/images/add_rnr_error_finalise.png)
+
+Once you are happy with your inputs, click `OK` to generate the form. You will be redirected to the R&R form details page.
+
+## Detail View
+
+![R&R Detail view](/docs/replenishment/images/rnr_detail.png)
+
+The R&R form contains the following columns. Calculated/non-editable columns are greyed out. Columns marked with an asterisk (\*) below are editable.
+
+| Column                   | Description                                                                                                                                                                                                   |
+| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **Code**                 | Item code                                                                                                                                                                                                     |
+| **Name**                 | Item name                                                                                                                                                                                                     |
+| **Strength**             | Strength of the item                                                                                                                                                                                          |
+| **Unit**                 | Unit of measure for the item                                                                                                                                                                                  |
+| **VEN**                  | Item VEN category: Vital (V), Essential (E), Non-essential (N)                                                                                                                                                |
+| **Initial balance\***    | Stock on hand for this item at the start of the period. Uses the final balance from the previous R&R form (if it exists), or attempts to calculate the balance based on any transaction data in Open mSupply. |
+| **Received\***           | Quantity of this item received during the period. Populated by quantities received through Inbound Shipments.                                                                                                 |
+| **Consumed\***           | Quantity of this item consumed during the period. Populated by quantities distributed through Outbound Shipments or Prescriptions.                                                                            |
+| **Adjusted consumption** | Consumption, adjusted for any days out of stock. Calculation is <code>Consumed x Days in period / Days in stock</code>                                                                                        |
+| **Adjustments\***        | Losses/adjustments made for this item during the period. Can be positive or negative. Populated by data from Stocktakes or Inventory Adjustments.                                                             |
+| **Stock out duration\*** | Number of days in the period where stock on hand for the item was 0.                                                                                                                                          |
+| **Final balance**        | Stock on hand for the item at the end of the period. Calculation is <code>Initial balance + Received - Consumed + Adjustments</code>                                                                          |
+| **AMC**                  | Average monthly consumption over the last 3 periods                                                                                                                                                           |
+| **Maximum**              | <code>AMC x 2</code>                                                                                                                                                                                          |
+| **Expiry\***             | Expiry date of the earliest expiring available batch of this item                                                                                                                                             |
+| **Requested\***          | Quantity to be requested in the requisition. Calculated as <code>Maximum - Final balance</code>                                                                                                               |
+| **Comment\***            | You can add any comments to the line as needed                                                                                                                                                                |
+| **Confirmed\***          | Use this column to keep track of which lines are complete. Acts as the save button for changes to a line.                                                                                                     |
+
+### Editing the R&R Form
+
+You can make changes to the usage data for each item in the R&R form, as well as the quantity to request from the supplier.
+
+Once you are happy with the information for an item, click the `Confirmed` checkbox to save the data.
+
+![Edit line](/docs/replenishment/images/rnr_edit_line.gif)
+
+### Print and Export
+
+You can print or export the R&R form by clicking the `Print` or `Export` buttons in the top right corner of the screen.
+
+![Print and export buttons](/docs/replenishment/images/rnr_print_and_export.png)
+
+- The `Print` button will open your browser's print window. You can also save the report as a PDF from here.
+- The `Export` button will download the R&R form as an Excel file.
+
+<div class="note">
+In order to print or export, you will need an R&R Form report configured. Please contact support for assistance.
+</div>
+
+### Finalising an R&R Form
+
+![Finalise](/docs/replenishment/images/rnr_finalise.png)
+
+When you are ready to finalise the R&R form, click the `Finalise` button at the bottom right of the screen. At this point:
+
+- The R&R form will no longer be editable
+- An Internal Order will be created and sent to the selected supplier. The values entered against each item in the R&R form are used to populate the Internal Order, so check the `Requested` value before confirming!
+
+You can also click the `Close` button at any time to return to the list view.
diff --git a/content/health-supply-hub/images/activate_user_account.png b/content/health-supply-hub/images/activate_user_account.png
diff --git a/content/health-supply-hub/images/air_sea_2.png b/content/health-supply-hub/images/air_sea_2.png
diff --git a/content/health-supply-hub/images/dashboard_naviation.png b/content/health-supply-hub/images/dashboard_naviation.png
diff --git a/content/health-supply-hub/images/edit_user_modal.png b/content/health-supply-hub/images/edit_user_modal.png
diff --git a/content/health-supply-hub/images/footer_quote_status.png b/content/health-supply-hub/images/footer_quote_status.png
diff --git a/content/health-supply-hub/images/hsh_email_header.png b/content/health-supply-hub/images/hsh_email_header.png
diff --git a/content/health-supply-hub/images/invited_email.png b/content/health-supply-hub/images/invited_email.png
diff --git a/content/health-supply-hub/introduction.md b/content/health-supply-hub/introduction.md
@@ -20,7 +20,7 @@ Traditional tender processes are often very time consuming and prone to errors.
 
 Health Supply Hub is a platform that assists in the tender process by extending the functionality of the mSupply Tender module through its web-based tender management platform. It facilitates the easy upload and management of tenders created within mSupply and allows for efficient communication and transparency among suppliers.
 
-Purchasers create tenders on mSupply and upload the tender to Health Supply Hub. Suppliers view these tenders and upload their quotes for items they wish to bid on. They are also able to ask questions and obtain clarification with the purchaser. Once quotes have been uploaded by the supplier, this is downloaded back to the mSupply Tender module where it evaluation can be completed by the purchaser and successful bidders chosen.
+Purchasers create tenders on mSupply and upload the tender to Health Supply Hub. Suppliers view these tenders and upload their quotes for items they wish to bid on. They are also able to ask questions and obtain clarification with the purchaser. Once quotes have been uploaded by the supplier, this is downloaded back to the mSupply Tender module where it can be reviewed by the purchaser and successful bidders chosen.
 
 [Health Supply Hub (HSH)](https://health-supply-hub.msupply.org/) is a web-based platform to facilitate procurement of medical supplies.
 

diff --git a/content/health-supply-hub/purchaser/getting_started.md b/content/health-supply-hub/purchaser/getting_started.md
@@ -12,12 +12,12 @@ toc = true
 top = false
 +++
 
-To begin using Health Supply Hub, the [mSupply Support Team](mailto:[email protected]) will assist with integrating your mSupply program with Health Supply Hub. They will also set up the main user who will be able to manage other users that are going to be involved in the procurement process on Health Supply Hub.
+To begin using Health Supply Hub, the [Health Supply Hub Support Team](mailto:[email protected]) will assist with integrating your mSupply program with Health Supply Hub. They will also set up the main user who will be able to manage other users that are going to be involved in the procurement process on Health Supply Hub.
 
-#### Logging in
+### Logging in
 
 <p align="center">
-<img src="/health-supply-hub/images/login_screen.png" width="750" height="420" >
+<img src="/health-supply-hub/purchaser/images/login_screen.png" width="750" height="420" >
 </p>
 
 Use your email address or username that has been set up for you on Health Supply Hub to login. This will have been set up for you by the Health Supply Hub support team
@@ -27,16 +27,16 @@ If you have forgotten your password, select the “Forgot Password?” button. T
 You will then be directed to the Health Supply Hub main screen.
 
 <p align="center">
-<img src="/health-supply-hub/images/customer_dashboard.png" width="750" height="420" >
+<img src="/health-supply-hub/purchaser/images/customer_dashboard.png" width="750" height="420" >
 </p>
 
-#### Help & Support
+### Help & Support
 
-![image](/health-supply-hub/images/docs_button.png)
+![image](/health-supply-hub/purchaser/images/docs_button.png)
 
 For any queries, there is a “Docs” icon on the sidebar menu of Health Supply Hub which will open up the Help Page for the page you are viewing. If this does not help to answer your query, please do not hesitate to [contact the Health Supply Hub Support Team via email](mailto:[email protected]).
 
-#### Useful Tips
+### Tips
 
 Save the following emails to your safe sender list to avoid HSH emails going into your junk or spam folders: