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 16:11] – [23.06. NHLMIS integration] Gary Willetts | integration:nhlmis [2023/01/17 09:47] (current) – Gary Willetts | ||
---|---|---|---|
Line 7: | Line 7: | ||
- requisitions (orders) you receive from NHLMIS will not be added because the customer or items are not recognised by mSupply | - requisitions (orders) you receive from NHLMIS will not be added because the customer or items are not recognised by mSupply | ||
- NHLMIS must be configured so that the API key relates to the correct stores in your mSupply installation. | - NHLMIS must be configured so that the API key relates to the correct stores in your mSupply installation. | ||
+ | </ | ||
+ | |||
+ | <WRAP important center round 90%> | ||
+ | Currently, there is no functionality to show the program a particular order is for or to force the selection of stock that belongs to the correct program. This might be added in a future upgrade. | ||
</ | </ | ||
Line 18: | Line 22: | ||
* **Server URL:** The URL of the NHLMIS interface. Enter everything without the resource to be called and the final "/" | * **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. | * **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. | + | * **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// | * **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// | ||
Line 29: | Line 33: | ||
**Fetch requisitions preferences** | **Fetch requisitions preferences** | ||
- | * **Fetch requisitions from NHLMIS checkbox: | + | * **Fetch requisitions from NHLMIS checkbox: |
- | * **No. of minutes between fetches: | + | * **No. of minutes between fetches: |
- | * **Set " | + | * **Set " |
- | * **Order ID text box and Fetch now button:** | + | * **Order ID text box and Fetch now button: |
+ | 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 happens | + | ===== 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" | ||
- | ===== Errors ===== | + | 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: | ||
\\ | \\ |