Differences

This shows you the differences between two versions of the page.

--- integration:nhlmis [2026/03/04 18:08] – [Other setup] Gary Willetts
+++ integration:nhlmis [2026/07/22 16:00] (current) – Gary Willetts
@@ Line 11: / Line 11: @@
 <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.
+</WRAP>
+<WRAP info center round 90%>
+The NHLMIS API detail is here: http://field-api-docs.s3-website.eu-central-1.amazonaws.com/
 </WRAP>
@@ Line 41: / Line 45: @@
 **Send shipments preferences**
-  * **Send shipments checkbox:** If this is checked then mSupply will send shipments to NHLMIS. If it is unchecked then no sipments will be sent.
+  * **Send shipments checkbox:** If this is checked then mSupply will send shipments to NHLMIS. If it is unchecked then no shipments will be sent.
   * **No. times to retry sends:** The maximum number of times to try resending shipments that failed to reach NHLMIS.
   * **Minutes between retries:** The number of minutes to leave between attempting to resend shipments that failed to reach NHLMIS.
@@ Line 66: / Line 70: @@
   * **Donors:** make sure all donors representing NHLMIS funders are created and visible in all stores selected in the **Stores to send stock and receive requisitions for** table in the //File > Preferences > NHLMIS// tab as described above. The code of the donor must match the funder name in NHLMIS. e.g. ''funder:pepfar'' must be a donor with its code set to ''pepfar'' in mSupply.
   * **Item properties**: add a property with the type ''NHLMISChild'' and any value (not an item code) to any item. See the  page [[items:item_basics:tab_reporting#item_properties|4.01.15. Items - Reporting tab]] for details on how to do this.
+  * **Users**: add a user with the name "NHLMIS Interface". Make it active but give it no permissions (except being able to login to the dashboard) and do not allow it to login to any stores. mSupply will set this user as the creator of transactions generated by the interface.
@@ Line 103: / Line 108: @@
 ==== Synchronising items ====
-A GET call is made to the ''/products'' endpoint for all NHLMIS services. If an item code returned from these calls exists in mSupply already then it is ignored. If it does not exist in mSupply already then:
+A GET call is made to the ''/products'' endpoint for all NHLMIS services. If an item code returned from these calls exists in mSupply already or if it does not have genericParent or genericFactor properties then it is ignored. If it does not exist in mSupply and it does have genericParent and genericFactor properties then:
-  * if it doesn't have a Generic parent ID or the Generic parent ID is the same as its ID then it is created as a normal item.
+  * if it has a Generic parent ID which is the same as its ID then it is created as a normal item.
   * if it has a Generic parent ID which is different from its ID then it is created as an NHLMISChild property of the parent item (as long as it doesn't already exist as this property!) with a value of "//item code//,pack_//pack size//" e.g. "ghsc-mal0004,pack_100".
-In addition, new items will be added to master lists that have tags matching the item's program name (master list tag format is "NHLMISProgram://program name//"). If the master list does not exist then it will be crerated by mSupply.
+In addition, new items will be added to master lists that have tags matching the item's program name (master list tag format is "NHLMISProgram://program name//"). If the master list does not exist then it will be created by mSupply. The master list can then be used to make the item visible in the correct stores (either manually or automatically if the preference to manage item visibility by master lists is turned on and the program master lists are already assigned to the correct stores).
 The pack size sent with an item is set as its default pack size.