Document the simple Requisition-Stock connection

Description

Part of https://openlmis.atlassian.net/wiki/spaces/OP/pages/114234797/Connecting+Stock+Management+and+Requisition+Services Phase 1.

With completion of the sequence of Phase 1 steps, we have now completed the "Simple" Requisition-Stock connection. We need to document that now using Requisition service requires using the Stock service (on the server), but does not require users to do any part of the stock UI. This connection just 'passively' collects stock data while users conduct their requisition workflow. It is critical to point out the limitations of this simple connection: it does not collect Lot data (it records all inventories and adjustments for the lot-less stock cards for the relevant product); it records all adjustments as of the same date (does not collect different dates for each adjustment row); it does not collect sources/destinations for ad-hoc issue/receive transfers.

Later in a future phase described on that wiki page we expect to build an advanced connection with toggles to switch between simple and advanced for any program's requisition template. The advanced version will allow that additional data to be collected.

QAlity Plus - Test Management

Checklists

Activity

Show:
Sam Im
September 8, 2017 at 8:15 PM

I made a few formatting edits to the Implementer/Admin page, but otherwise no changes. Looks good, moving to done.

Brandon Bowersox-Johnson
September 7, 2017 at 10:47 PM
Brandon Bowersox-Johnson
September 6, 2017 at 11:13 PM
(edited)

Per discussion with Mary Jo, there are 3 possible areas of documentation and we will consider 2 of the 3:

  • Configuration Guide for Implementer/Admin page: update the place that talks about loading in Reasons to be clear they are loaded into Stock Management (not ReferenceData) and they are by program and facility type, and UUIDs/reasons can be shared across programs which helps with reporting across programs consistently

  • Functional Documentation in wiki: add text for a technical audience to explain why the 2 micro-services are both needed or how they divide up their responsibilities

  • User Documentation: decided this is not currently in scope for this ticket; talked about documentation to explain how to turn on and start using Stock Management, but we have a video demo and showing this differently would be a separate ticket/initiative

Next Steps: Draft the two parts that are in scope, have Sam Im review.

Sam Im
August 14, 2017 at 8:03 PM

& I've added the label ConfigGuide, as a reminder to myself that this needs to be added to the config guide

Brandon Bowersox-Johnson
August 14, 2017 at 7:46 PM

Can you suggest where this documentation should live and what format it should be? The previous tickets already put messages into the CHANGELOGs of the services. But this ticket needs Acceptance Criteria so we know what kind of documentation we really want. Also, is this documentation that Team ILL or Team Parrot should write? (We should update the Grooming page with that so we assign this properly.)

Done
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Labels

Story Points

Sprint

None

Priority

Time Assistant

Created July 11, 2017 at 1:33 AM
Updated September 8, 2017 at 8:15 PM
Resolved September 8, 2017 at 8:15 PM