Merge pull request #138 from msupply-foundation/IO-docs-update

IO docs

content/docs/catalogue/items.md

@@ -98,6 +98,33 @@ There are two tabs in the bottom part of the screen:
 This tab lists the Master Lists associated with this item.
 ![Item detail headers](/docs/catalogue/images/cat_itemmasterlists.png)
 
+### Ledger
+
+The item ledger tab shows a history of transactions in this store for the item.
+
+![](/docs/catalogue/images/item_ledger.png)
+
+The ledger is divided into 16 columns:
+
+| Column               | Description                                                      |
+| :------------------- | :--------------------------------------------------------------- |
+| **Type**             | The type of the transaction                                      |
+| **Date**             | The date of the transaction was confirmed                        |
+| **Time**             | The time of the transaction was confirmed                        |
+| **Invoice Number**   | The invoice (shipment) number of the transaction                 |
+| **Name**             | The name of the customer or supplier                             |
+| **Status**           | The status of the transaction                                    |
+| **Expiry**           | The expiry date of the stock line                                |
+| **Batch**            | The batch number of the stock line                               |
+| **Pack Size**        | The pack size                                                    |
+| **Number of packs**  | The number of packs in the transaction                           |
+| **Unit Qty**         | The quantity that was assigned to the transaction in units       |
+| **Balance**          | The balance of the stock line                                    |
+| **Pack cost price**  | The cost price of the pack                                       |
+| **Pack sell price**  | The sell price of the pack                                       |
+| **Total before tax** | The total cost of the transaction before tax (in local currency) |
+| **Reason**           | The reason for the adjustment (if required)                      |
+
 ## Item Variants
 
 On the [Open mSupply Central Server](/docs/getting_started/central), a third tab, Item Variants, is available. This tab allows you to configure variations of the item, such as different manufacturers or packaging sizes.

content/docs/distribution/requisitions.md

@@ -290,18 +290,15 @@ You cannot change the customer name after the requisition has been created. If y
 
 Tap on the `Add Item` button (top right corner).
 
-A new `Add Item` window will open. You can look up an item by:
+You will be redirected to the edit page. You can look up an item by:
 
 - Reading through the list of available items
 - or by typing some or all of the item name
 - or by typing some or all of an item code
 
 Once your item is highlighted, tap on the name or press `Enter`.
 
-![Add Item](/docs/distribution/images/requisition_add_item.gif)
-
-Once the item has been selected, you will be redirected to the line edit page.
-Here you can enter the customer's stock on hand, average monthly consumption and
+Once an item has been selected, you will be redirected to the item edit page. Here you can enter the customer's stock on hand, average monthly consumption and
 requested quantity. You can also enter how much you are going to supply to the
 customer and any comments. The values are saved automatically.
 

content/docs/programs/program_indicators.md

@@ -18,7 +18,39 @@ The term 'Program Indicators' refers to a set of configurable survey questions w
 
 ## Enabling Program Indicators
 
-Program Indicators are configured on the mSupply central server, following the documentation [here](https://docs.msupply.org.nz/items:programs#adding_indicators_to_a_program).
+Program Indicators are configured on the mSupply central server. See
+documentation
+[here](https://docs.msupply.org.nz/items:programs#adding_indicators_to_a_program).
+
+## Internal Orders
+
+1. Create a [program Internal
+   Order](/docs/programs/requisitions/#creating-a-program-internal-order).
+2. Click on the Indicators tab
+
+![Indicators tab](/docs/programs/images/internal_order_indicator_tab.png)
+
+<div class='note'>
+HIV is only available on Programs where "HIV" has been enabled.
+</div>
+
+3. Click on one of the Program Indicator buttons (if more than one is available)
+
+![Indicators edit](/docs/programs/images/internal_order_indicator_edit.png)
+
+From here you can enter in the data, as configured for each indicator of this
+program.
+
+If your store is a supplying store and the store preference `Use consumption &
+stock from customers for internal orders` is enabled
+
+![Use consumption & stock from customers for internal orders](/docs/programs/images/consumption_data_pref.png)
+
+then you will also see a table showing summarised indicator data from your customer stores for the period.
+![Indicator info](/docs/programs/images/indicator_info_table.png)
+
+The previous and next buttons at the bottom allows you to navigate between the
+indicators.
 
 ## Manual Customer Requisitions
 
@@ -32,10 +64,6 @@ The process of entering program indicators is as follows:
 
 ![Indicators tab](/docs/programs/images/indicators.png)
 
-<div class='note'>
-HIV is only available on Programs where "HIV" has been enabled.
-</div>
-
 3. Click on one of the Program Indicator buttons
 
 ![Indicators edit](/docs/programs/images/indicators_edit.png)

content/docs/programs/requisitions.md

@@ -61,7 +61,64 @@ There are several areas where you'll see additional information when using a pro
 
 1. The `Add item` and `Add from master list` buttons are disabled. Items in a program based Internal Order are configured by the program.
 2. A message explaining that you also cannot edit the target and reorder threshold MOS values on a program based Internal Order. These values are configured by the program.
-3. Additional information telling you which program, order type and period this Internal Order is for. This detail panel can be opened by clicking the `More` button in the top right of the page.
+3. Additional information telling you which program, order type and period this
+   Internal Order is for. This detail panel can be opened by clicking the `More`
+   button in the top right of the page.
+
+#### Extra Requisition Fields
+
+In Internal Orders, it is possible to display additional columns of data for
+reporting and forcing purposes. These columns are calculated and are not
+editable. To enable these columns you need to configure store preferences to
+enable these extra columns as described in the [mSupply Desktop
+documentation](https://docs.msupply.org.nz/other_stuff:virtual_stores#preferences_tab).
+
+![Show extra fields on requisitions preference](/docs/programs/images/show_extra_fields_on_requisitions.png)
+
+Enabling the preference will show the extra columns on the requisition list page:
+
+<!-- TODO: Calculations (currently aren't calculated)  -->
+
+| Column                    | Description                                                                                                  |
+| :------------------------ | :----------------------------------------------------------------------------------------------------------- |
+| **Initial stock on hand** | The customer's stock on hand at the start of the program period                                              |
+| **Incoming**              | The customer's incoming stock in units for this item                                                         |
+| **Outgoing**              | The customer's outgoing stock in units for this item                                                         |
+| **Losses**                | Inventory Adjustment                                                                                         |
+| **Additions**             | Inventory Adjustment                                                                                         |
+| **Available**             | Initial stock on hand + incoming stock +/- inventory adjustment - outgoing stock                             |
+| **Short Expiry**          | Sum of available stock for the item which has an expiry date after the program end date                      |
+| **Days out of stock**     | (Target MOS \* AMC) - available stock                                                                        |
+| **AMC**                   | The customer's average monthly consumption for this item                                                     |
+| **MOS**                   | Months of stock for the item                                                                                 |
+| **Reason**                | A reason will be provided if their is a difference between the suggested quantity and the requested quantity |
+
+The line edit page will also contain the extra columns.
+
+![Program Requisition Line
+Edit](/docs/programs/images/internal_order_extra_fields_edit.png)
+
+If your store has the store preference `Use consumption &
+stock from customers for internal orders` enabled
+
+![Use consumption & stock from customers for internal
+orders](/docs/programs/images/consumption_data_pref.png)
+
+Then you will see an extra table underneath the input fields which shows the
+customer's data based on their program requisitions for that period.
+
+![](/docs/programs/images/internal_order_item_info.png)
+
+The table has 6 columns:
+
+| Column          | Description                                                                                                                                  |
+| :-------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Name**        | The customer's name or the current store name                                                                                                |
+| **AMC**         | The customer's average monthly consumption. For the currently logged in store, this will be the sum of all customer AMC                      |
+| **Unit Qty**    | Stock on hand at the end of the program period                                                                                               |
+| **Adjustments** | Calculated using the following calculation for the item. Delivered inbound shipments - picked outbound shipments +- any inventory adjuments. |
+| **Outgoing**    | Quantity of item in picked outbound shipments                                                                                                |
+| **Date range**  | The end date of the program period                                                                                                           |
 
 ### Requisitions
 
@@ -105,17 +162,11 @@ items manually to the Requisition.
 
 #### Extra Requisition Fields
 
-In manual requisitions it is possible to collect many additional columns of data for reporting and forecasting purposes. To enable these columns you need to configure store preferences to enable these extra columns as described in the [mSupply Desktop documentation](https://docs.msupply.org.nz/other_stuff:virtual_stores#preferences_tab).
-
-For quick reference this is the preference your logged-in store requires:
-![Show extra fields on requisitions preference](/docs/programs/images/show_extra_fields_on_requisitions.png)
-
-This is how the extra columns look within a requisition:
+In manual requisitions it is possible to collect many additional columns of data
+for reporting and forecasting purposes. You will need the `Show extra fields on
+requisitions` store preference. See above for details.
 
-![Program Requisition Detail
-View](/docs/programs/images/program_requisition_detail_view.gif)
-
-The line edit page will also contain the extra columns as well:
+Enabling the preference will show the extra columns on the requisition list page:
 
 | Column                    | Description                                                                                                  |
 | :------------------------ | :----------------------------------------------------------------------------------------------------------- |
@@ -131,6 +182,8 @@ The line edit page will also contain the extra columns as well:
 | **MOS**                   | Months of stock for the item                                                                                 |
 | **Reason**                | A reason will be provided if their is a difference between the suggested quantity and the requested quantity |
 
+The line edit page will also contain the extra columns as well.
+
 ![Program Requisition Line
 Edit](/docs/programs/images/program_requisition_line_edit.png)
 

content/docs/replenishment/internal_orders.md

@@ -82,24 +82,29 @@ This can be done before or after adding items to your order.
 
 ### Adding a single item
 
-Tap on `Add Item` to add a single item to your order. A new window opens:
+Tap on `Add Item` to add a single item to your order. You will be redirected to
+a new page.
 
 ![Internal Order: add item](/docs/replenishment/images/intord_additem2.png)
 
 First select the item you want to add to your order. You can also type some or all of an item name (or code) to look for a specific item.
 
-Once item is selected, you should see the following information on the window:
+Once item is selected, you should see the following information on the page:
 
-- **Item Code** and **Item Name**
-- **Units/Packs toggle**: this allows you to switch between ordering in units or packs
-- **Unit**: the default unit used for this item (_eg. Tablet, Vial_)
-- **AMC**: Average Monthly Consumption. How much stock your store uses each month on average (based on a configurable number of months, default is set to 3 months)
+- **Item Name**
 - **SOH**: Stock on Hand. How much stock the store currently has available
+- **AMC**: Average Monthly Consumption. How much stock your store uses each month on average (based on a configurable number of months, default is set to 3 months)
+- **Units/Packs toggle**: this allows you to switch between ordering in units or packs
 - **Default pack size**: the default pack size of the item
-- **Suggested Quantity**: how much stock mSupply suggests that your order to reach your stock target quantity
 - **Requested quantity**: the quantity of units that you request from your supplier
+- **Default pack size**: the default pack size of the item
+- **Suggested Quantity**: how much stock mSupply suggests that your order to reach your stock target quantity
+- **Comments**: any comments you want to add to the order
+
+You should also see the following charts if you click the bar graph icon next to
+requested quantity:
 
-You should also see the following charts:
+![](/docs/replenishment/images/io_bar_graph_icon.png)
 
 - **Target Quantity**: In this chart, you will see the following information:
   - The _Target Quantity_ for the item. This is calculated as: Target MOS x AMC.