from e1440cb938e3682cf392491b4a1f9cc4774c42c6

msupply-foundation · Oct 22, 2024 · f59ead0 · f59ead0
1 parent 8e514de
commit f59ead0
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 22 deletions.
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_full_screen.gif b/content/docs/replenishment/images/rnr_full_screen.gif
diff --git a/content/docs/replenishment/images/rnr_more_info.png b/content/docs/replenishment/images/rnr_more_info.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
@@ -26,6 +26,8 @@ Start with configuring [periods and schedules](https://docs.msupply.org.nz/admin
 
 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.
 
+Make sure you have the correct thresholds set up for understock and overstock in your [store preferences](https://docs.msupply.org.nz/other_stuff:virtual_stores?s%5B%5D=threshold&s%5B%5D=overstock#notification_preferences). These are used to calculate the minimum and maximum stock levels for each item.
+
 ## R&R Forms - List View
 
 Go to `Replenishment` > `R&R Forms` to view the list of R&R Forms.
@@ -72,28 +74,30 @@ Once you are happy with your inputs, click `OK` to generate the form. You will b
 
 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/distributed\***            | Quantity of this item consumed during the period. Populated by quantities distributed through Outbound Shipments or Prescriptions.                                                                            |
-| **Adjusted consumption/distribution** | 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/AMD**                           | Average monthly consumption (distribution) over the last 3 periods                                                                                                                                            |
-| **Maximum**                           | Ideal amount of stock to have on hand, requested quantity could be any amount up to this value. Calculated as <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>                                                                                                               |
-| **Low stock**                         | Warning indicator if your final balance is low in comparison to the ideal stock level. Will show `!` when `Final balance` is less than half of `Maximum`, and `!!` when less than quarter                     |
-| **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.                                                                                                     |
-| **Approved Quantity**                 | Once the R&R Form is finalised, this column will show the quantity approved by the authoriser (if authorisation is configured)                                                                                |
+| 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/distributed\*** | Quantity of this item consumed during the period. Populated by quantities distributed through Outbound Shipments or Prescriptions.                                                                            |
+| **Adjusted**               | Consumption/distribution, adjusted for any days out of stock. Calculation is <code>Consumed/distributed x Days in period / Days in stock</code>                                                               |
+| **Losses\***               | Losses recorded for this item during the period. Manually entered.                                                                                                                                            |
+| **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/AMD**                | Average monthly consumption (distribution) over the last 3 periods                                                                                                                                            |
+| **Minimum**                | Minimum amount of stock to have on hand, requested quantity should ensure stock won't drop below this value. Calculated as <code>AMC x Threshold for understock</code> (store preference)                     |
+| **Maximum**                | Ideal amount of stock to have on hand, requested quantity could be any amount up to this value. Calculated as <code>AMC x Threshold for overstock</code> (store preference)                                   |
+| **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>                                                                                                               |
+| **Low stock**              | Warning indicator if your final balance is low in comparison to the ideal stock level. Will show `!` when `Final balance` is less than half of `Maximum`, and `!!` when less than quarter                     |
+| **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.                                                                                                     |
+| **Approved Quantity**      | Once the R&R Form is finalised, this column will show the quantity approved by the authoriser (if authorisation is configured)                                                                                |
 
 ### Editing the R&R Form
 
@@ -116,6 +120,22 @@ You can print or export the R&R form by clicking the `Print` or `Export` buttons
 In order to print or export, you will need an R&R Form report configured. Please contact support for assistance.
 </div>
 
+### Detail Panel
+
+The `More` button in the top right corner of the screen will open the detail panel. Here you can see addition information about the R&R form, such as the program name and the supplier.
+
+![R&R detail panel](/docs/replenishment/images/rnr_more_info.png)
+
+You can also set a reference, which will be included in the Internal Order sent to the supplier.
+
+### Full Screen Mode
+
+There's a lot of information on the R&R form, and sometimes it can be hard to see everything at once. Click the `Full Screen` button in the top right corner of the screen to expand the view.
+
+![R&R full screen](/docs/replenishment/images/rnr_full_screen.gif)
+
+Click the `Exit` button in the top right corner of the screen to return to the normal view, or you can use the `Escape` key if you are using a keyboard.
+
 ### Finalising an R&R Form
 
 ![Finalise](/docs/replenishment/images/rnr_finalise.png)