Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
integration:nhlmis [2023/01/16 11:58] – [23.06. NHLMIS] Gary Willetts | integration:nhlmis [2023/01/17 09:47] (current) – Gary Willetts | ||
---|---|---|---|
Line 1: | Line 1: | ||
{{indexmenu_n> | {{indexmenu_n> | ||
- | ====== 23.06. NHLMIS ====== | + | ====== 23.06. NHLMIS |
- | mSupply has an interface with the Nigeria Health Logistics Informaiton System. The interface alloows | + | <WRAP important center round 90%> |
+ | Before you turn on the NHLMIS integration two important setup steps must be taken: | ||
+ | - All store, item, customer and supplier codes must match those used in NHLMIS. If this step is not taken; | ||
+ | - stock data you send will be rejected by NHLMIS because | ||
+ | - requisitions (orders) you receive | ||
+ | - NHLMIS | ||
+ | </ | ||
- | The preferences that define how this interface works are managed on the //NHLMIS// tab of the //File > Preferences// | + | <WRAP important center round 90%> |
+ | Currently, there is no functionality to show the program a particular order is for or to force the selection | ||
+ | </WRAP> | ||
- | Information | + | mSupply has an interface with the Nigeria Health Logistics |
+ | The preferences that define how this interface works are managed on the //NHLMIS// tab of the //File > Preferences// | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | **General preferences** | ||
+ | * **Server URL:** The URL of the NHLMIS interface. Enter everything without the resource to be called and the final "/" | ||
+ | * **API key:** The authentication key for your organisation. This will be provided by the NHLMIS team. | ||
+ | * **Error email:** The email address for error emails to be sent to. Separate multiple email addresses with a semicolon ('';'' | ||
+ | * **Stores to send stock and receive requisitions for table:** This table contains a row for every store in the datafile. Check the checkbox in the //Send stock & Fetch requisitions// | ||
+ | |||
+ | **Send stock preferences** | ||
+ | * **Send current stock to NHLMIS checkbox:** If this is checked then mSupply will automatically send the current stock stock in each of the stores selected in the **Stores to send stock and receive requisitions for** table. If it is unchecked then no current stock is sent to NHLMIS. | ||
+ | * **No. of days between sends:** The number of days to leave between each send of stock. If set to 0 then current stock is not sent to NHLMIS. | ||
+ | * **Time to send:** The time of day to send the stock. Enter the value in 12 hour clock format and select whether it is AM or PM in the drop down list. | ||
+ | * **Manufacturer to use if none:** By default, if the stock doesn' | ||
+ | * **Send now button:** If this is clicked, the current stock in the stores selected in the **Stores to send stock and receive requisitions for** table will be sent to NHLMIS immediately. This will be an " | ||
+ | |||
+ | **Fetch requisitions preferences** | ||
+ | * **Fetch requisitions from NHLMIS checkbox:** If checked then mSupply will fetch all outstanding requisitions (NHLMIS orders) from NHLMIS. The stores they are received for depends on settings in NHLMIS (this is tied to the API key which identifies who is requesting the requisitions/ | ||
+ | * **No. of minutes between fetches:** The number of minutes to leave between fetching requisitions from NHLMIS | ||
+ | * **Set " | ||
+ | * **Order ID text box and Fetch now button:** These are used to fetch a single order. Enter the NHLMIS order ID in the **Order ID** text box and click on the **Fetch now** button to fetch it immediately form NHLMIS. A progress indicator will show how the fetch is progressing. | ||
+ | |||
+ | Click on the **OK** button to save any settings you have changed; changes will not be put into effect until they are saved by clicking this button | ||
+ | |||
+ | ===== What it does ===== | ||
+ | ==== Sending stock ==== | ||
+ | The current stock in each store selected in the **Stores to send stock and receive requisitions for** table is sent to NHLMIS automatically on the schedule defined by the **No. of days between sends** and **Time to send** field. | ||
+ | |||
+ | Each time a send is made the following is done in this order, one store at a time: | ||
+ | - all the batches in stock (i.e. where available stock is more than 0) are sent to NHLMIS by calling the ''/ | ||
+ | - all current stock lines (i.e. where available stock is more than 0) are sent to NHLMIS by calling the ''/ | ||
+ | - The success or failure of each send for each store is logged. | ||
+ | |||
+ | |||
+ | ==== Fetching requisitions ==== | ||
+ | All the outstanding orders (which become requisitions in mSupply) for this mSupply installation which have become outstanding since the last "since marker" | ||
+ | |||
+ | If there are more than 50 outstanding orders then mSupply will automatically ask NHLMIS to send the next 50 until all outstanding orders have been retrieved. | ||
+ | |||
+ | Each time orders are successfully retrieved, the " | ||
+ | |||
+ | Each order received from NHLMIS is saved as a requisition in the appropriate store in mSupply. The NHLMIs order ID is stored in the **Their ref** field of each requisition. | ||
+ | |||
+ | Any orders that have already been received from NHLMIS and saved in mSupply are not saved again, they are ignored. | ||
+ | |||
+ | |||
+ | ===== Errors ===== | ||
+ | If errors are encountered during the sending of stock or fetching orders then information about the error is saved in the log (see the [[admin: | ||
\\ | \\ |