Merge pull request #118 from msupply-foundation/manual-requisition

Manual requisition

content/docs/distribution/outbound_shipments.md

@@ -166,7 +166,7 @@ You can close by tapping on the `X Close` button, on the top right corner of the
 In the **Additional Info** section, you can:
 
 - See who created the Outbound Shipment (name of the user)
-- View and edit the Outbound Shipment color. To edit the color, tap on the coloured circle and select a color from the pop-up
+- View and edit the Outbound Shipment color. To edit the color, tap on the colored circle and select a color from the pop-up
 - Write or edit a comment
 
 #### Related Documents

content/docs/distribution/requisitions.md

@@ -78,7 +78,25 @@ The list of Requisitions can be exported to a comma separated file (csv). Simply
 
 ![Export button](/docs/distribution/images/export.png)
 
-and the file will be downloaded. The export function will download all Requisitions, not just the current page, if you have more than 20 of them.
+and the file will be downloaded. The export function will download all
+Requisitions, not just the current page.
+
+### Delete a Requisition
+
+You can delete a requisition from the Requisition list.
+
+1. Select the requisition that you want to delete by checking the box on the
+   left end of the list. You can select more than one requisition to be deleted.
+   You can even select them all by using the master checkbox in the header.
+2. Open the `Actions` dropdown menu at the top right corner (above the list) and
+   select `Delete selected lines`.
+3. A confirmation window will appear, asking you to confirm the number of
+   requisitions to be deleted.
+4. After clicking `OK`, a notification will appear in the bottom left corner, confirming that the selected requisitions were deleted.
+
+<div class="note">
+You cannot delete requisitions that have been created from an Internal Order, or have had a shipment created from them.
+</div>
 
 ### Viewing a Requisition
 
@@ -87,6 +105,60 @@ You will then see the detail view of the requisition:
 
 ![Requisition Detail](/docs/distribution/images/requisition-detail.png)
 
+#### Enter a Customer Reference
+
+The customer reference is automatically generated when the customer creates an
+Internal Order, but you can also enter a customer reference manually.
+
+#### View or edit the Requisition Information Panel
+
+The information Panel allows you to see or edit information about the
+Requisition. It is divided into three sections:
+
+- Additional Info
+- Related documents
+- Actions
+
+We are planning to add more sections in the future as Open mSupply grows.
+
+##### How to open and close the information Panel?
+
+To open the Information Panel, you can tap on the `More` button, located in the
+top right corner of the Requisition page.
+
+You can close the Information Panel by tapping on the `X Close` button on the
+top right corner of the information panel.
+
+![Open and close the Information
+Panel](/docs/distribution/images/requisition_infopanel_openclose.gif)
+
+##### Additional Info
+
+In the **Additional Info** section you can:
+
+- See who created the Requisition (name of the user)
+- See when the Requisition was created
+- View and edit the Requisition color. To edit the color, tap on the colored
+  circle and select a color from the pop-up
+- Write or edit a comment
+
+##### Related Documents
+
+In the **Related Documents** section you can see other related transactions for
+the Requisition.
+
+If you have created shipments for the Requisition, the shipment numbers will
+appear in this section along with a link to view the shipment.
+
+##### Actions
+
+**Copy to clipboard**: You can tap on the `Copy to Clipboard` button to copy
+the Requisition details to the clipboard.
+
+#### Requisition Detail
+
+![Requisition Detail](/docs/distribution/images/requisition-detail.png)
+
 | Column        | Description                                                                                                                                                                     |
 | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | **Code**      | Code of the item                                                                                                                                                                |
@@ -99,43 +171,85 @@ You will then see the detail view of the requisition:
 | **Issued**    | The quantity that has already been issued in `Outbound Shipments`                                                                                                               |
 | **Remaining** | The quantity remaining to be supplied to the customer. The calculation is 'Supply - Issued'. This quantity will be re-calculated after an `Outbound Shipment` has been created. |
 
-Clicking on an individual item in this view, will then show you details of the particular item. Here you can adjust the quantity to supply:
+One way to adjust the supply quantity, is to click the button `Supply requested`
+at the top of the page. This will automatically set the supply quantity to be
+that of the quantity requested for each item.
 
-![Requisition Detail](/docs/distribution/images/requisition-item-detail.png)
+![Supply Requested button](/docs/distribution/images/requisition_supply_requested_button.png)
 
-The requested quantity is also shown, along with the stock item details.
+Click the button and you are asked
+for confirmation before the adjustment happens:
 
-The `My Store` tab indicates if the store have enough stock to meet the customer's requested quantity as well as the requested quantities from other customers. The two bars show the following:
+![Supply Requested
+Prompt](/docs/distribution/images/requisition-supply-to-requested.png)
 
-_The first bar:_
+The other way to adjust the supply quantity is to click on the item line in the
+table. This will open the line details page where you will see information about
+the item such as your stock on hand, and the requested quantity.
 
-- Your stock on hand for this item
-- Any incoming stock for this item that has been `Shipped`, but not yet `Delivered`
-- The quantity being requested for this item in any `Internal Orders`
+![Requisition Detail](/docs/distribution/images/requisition_line_edit_page.png)
+
+Once the `Quantity to supply` field is entered, a green tick will appear next to the item name, to help you track your progress.
+
+![Tick](/docs/distribution/images/requisition_line_tick.png)
+
+You can navigate between different items by:
+
+- Clicking on the item name in the list to the left of the screen
+- Using the `Previous` and `Next` buttons at the bottom of the screen
+
+![Requisition
+Navigation](/docs/distribution/images/requisition_line_navigation.gif)
+
+##### Customer Store Stats
+
+Clicking on the `Graph Icon` next to the `Requested quantity` field will open a
+graph showing you the details of the stock at the customer's store.
+
+<div class="note">The request quantity charts will only show if the Requisition was created from an Internal Order.</div>
+
+- The customer's _Target Quantity_ for this item. This is calculated as: Target MOS x AMC
+- The customer's stock on hand for this item
+
+![Requisition Customer Stats](/docs/distribution/images/customer_store_stats.png)
+
+##### Your Store Stats
+
+Clicking on the `Graph Icon` next to the `Quantity to Supply` field will open a
+graph showing you the details of the stock at your store.
 
 <div class="imagetitle">
 This message will be displayed if your store currently doesn't have any stock available.
 </div>
 
 ![](/docs/distribution/images/req-no-available-stock-message.png)
 
+_The first bar:_
+
+- Your stock on hand for this item
+- Any incoming stock for this item that has been `Shipped`, but not yet `Delivered`
+- The quantity being requested for this item in any `Internal Orders`
+
 _The second bar:_
 
 - The quantity being requested for this item in this Requisition
 - The quantity being requested in other Requisitions
 
-![Requisition Detail](/docs/distribution/images/requisition-item-detail-customer-tab.png)
+![Requisition Store Stats](/docs/distribution/images/response_store_stats.png)
 
-The `Customer` tab shows the customer's stock situation for this item:
+To go back to the Requisition view, tap on the `Close` button at the top right
+corner of the screen or click on the `Requisition Number` at the top left of the
+screen.
+![Close Requisition
+Line](/docs/distribution/images/close_requisition_line_edit.png)
 
-- The customer's _Target Quantity_ for this item. This is calculated as: Target MOS x AMC
-- The customer's stock on hand for this item
-
-Another way to adjust the supply quantity, is to click the button `Supply requested` at the top of the page. This will automatically set the supply quantity to be that of the quantity requested for that item. Click the button and you are asked for confirmation before the adjustment happens:
+#### Creating an Outbound Shipment from a Requisition
 
-![Supply Requested Prompt](/docs/distribution/images/requisition-supply-to-requested.png)
+Once you are happy with the supply quantities, you can create an `Outbound
+Shipment` which will supply the items requested by going back to the Requisition
+Detail page.
 
-To create an Outbound Shipment which will supply the items requested, click on the `Create Shipment` button. This will create a shipment, add all of the items which are not fully supplied, and then, open that shipment in a new tab. Before doing so, you are prompted to confirm:
+Click on the `Create Shipment` button. This will create a shipment, add all of the items which are not fully supplied, and then, open that shipment in a new tab. Before doing so, you are prompted to confirm:
 
 ![Create Shipment Prompt](/docs/distribution/images/requisition-create-shipment.png)
 
@@ -144,3 +258,54 @@ If the supply quantity is changed for any item/s in the requisition after a ship
 ![Create Shipment Detail](/docs/distribution/images/requisition-create-shipment.gif)
 
 After creating the shipment, you will see the shipment number, along with a link to view it, in the `Related documents` section of the additional details panel on the right of the screen.
+
+Clicking an item line in the table will redirect you to the line details page. Here you can adjust the
+quantity to supply and add a comment:
+
+### Manual Requisition
+
+Usually, Requisitions will be sent to you by your Customers. However, if they aren't using mSupply, you can create a Requisition manually.
+
+#### Creating a Manual Requisition
+
+1. Go to `Distribution` > `Requisition`
+2. Press the `Create Requisition` button at the top right of the page
+
+![New Requisition](/docs/distribution/images/click_new_requisition.png)
+
+3. A new window will appear where you can select the customer for whom you want
+   to create the requisition. You can search for the customer by typing their
+   name or code in the search bar or by scrolling through the list of customers.
+
+![Select Customer](/docs/distribution/images/requisition_customer_modal.png)
+
+4. Once you have selected the customer, you will be taken to the requisition
+   detail page where you can add items to the requisition.
+
+<div class="note">
+You cannot change the customer name after the requisition has been created. If you have made a mistake in selecting the customer, you will need to delete the requisition and create a new one.
+</div>
+
+#### Adding lines to a Requisition
+
+Tap on the `Add Item` button (top right corner).
+
+A new `Add Item` window will open. 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
+requested quantity. You can also enter how much you are going to supply to the
+customer and any comments. The values are saved automatically.
+
+![Requisition Line Edit](/docs/distribution/images/requisition_line_edit_page.png)
+
+After this, the workflow will follow the [same steps](#viewing-a-requisition)
+as for a requisition created from an Internal Order.

content/docs/programs/requisitions.md

@@ -73,6 +73,59 @@ The list view has gained some additional columns, showing the program related da
 - **Order type**: the name of the order type ( typically, a normal or emergency order )
 - **Period**: the name of the period selected
 
-And the detail view also has program information shown:
+#### Manual Program Requisitions
+
+Program Requisitions can also be created manually. This would typically be for customers who do not use mSupply, or in exceptional circumstances.
+
+See the configuration steps above, and also the [Customer
+tag](https://docs.msupply.org.nz/names:adding_and_editing#tags_tab)
+documentation to find out how to set up programs and add tags to customers.
+
+On the Requisitions page, click on the `New Requisition` button (top right
+corner).
+
+![New Requisition](/docs/programs/images/add_requisition_button.png)
+
+If you have programs set up, you'll see a different modal to the usual one:
+
+![New Program Requisition](/docs/programs/images/add_program_requisition.png)
+
+From the `Program` tab, you can create a Program Requisition by selecting the:
+
+- Program
+- Customer
+- Order Type
+- Period
+
+Only when you have selected all of the above, can you click `Create`.
+
+You will now be redirected to the Requisition detail page. The lines will be
+pre-populated with the items from the program; this means that you cannot add
+items manually to the Requisition.
+
+![Program Requisition Detail
+View](/docs/programs/images/program_requisition_detail_view.gif)
+
+The line edit page will also contain the extra columns as well:
+
+| 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 supply quantity and the requested quantity |
+
+![Program Requisition Line
+Edit](/docs/programs/images/program_requisition_line_edit.png)
+
+An additional section will be visible in the side panel showing the program
+information.
 
 ![Requisition: detail](/docs/programs/images/requisition-detail.png)