integration:elmis_interface

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
integration:elmis_interface [2019/09/19 09:43] – [Error file format] louintegration:elmis_interface [2022/03/15 10:26] (current) – Gary Willetts
Line 1: Line 1:
 {{indexmenu_n>30}} {{indexmenu_n>30}}
-====== 19.03. The mSupply eLMIS interface ====== +====== 23.03. mSupply eLMIS interface ====== 
- +eLMIS stands for **E**lectronic **L**ogistics **M**anagement and **I**nformation **S**ystem and is a version of OpenLMIS developed under the USAID Deliver project. mSupply has an interface for receiving orders from eLMIS and sending shipment details back to it.\\ \\ Because eLMIS does not have an API, the mSupply interface uses files stored in a commonly accessible location to share information.
- +
-This is a work in progress - will be completed soon! +
- +
-eLMIS stands for **E**lectronic **L**ogistics **M**anagement **S**ystem and is a piece of software developed under the USAID Deliver project. mSupply has an interface for receiving orders from eLMIS and sending shipment details back to it. Because eLMIS does not have an API, the interface uses files stored in a commonly accessible location to share information.+
  
 ===== Setup ===== ===== Setup =====
Line 20: Line 16:
  
 ==== 2. Enter the setup information into mSupply ==== ==== 2. Enter the setup information into mSupply ====
-Go to the eLMIS tab of //File > Preferences// and enter the settings for the interface there. You can find instructions for that [[preferences:general#elmis|here]]. +Go to the mSupply Special > Preferences window and select the eLMIS tab. Please see the [[preferences:general]] > [[preferences:general#elmis_tab]] section in this user guide for information on these settings. 
 + 
 +==== 3. Setup the customer budgets in mSupply ==== 
 +The interface assigns the incoming orders (turned into customer invoices in mSupply - see below) to the correct annual budget period for customers. The budget year is assumed to start on 1st July. So, create a budget period starting on the 1st July in the current budget year and assign that budget period to all the customers you will be importing orders for via this interface. See the [[issuing_goods:customer_budgets|]] page for details on doing that.
  
-==== 3. Setup eLMIS ====+==== 4. Setup eLMIS ====
   - Set eLMIS to export its order files to the //main folder///Order/Incoming folder when orders are created.   - Set eLMIS to export its order files to the //main folder///Order/Incoming folder when orders are created.
   - Set eLMIS to look for incoming shipment files in the //main folder///Shipment/Incoming folder on a regular basis.   - Set eLMIS to look for incoming shipment files in the //main folder///Shipment/Incoming folder on a regular basis.
Line 44: Line 43:
 If the order is successfully converted into a customer invoice the eLMIS order file is moved from //main folder///Order/Incoming to //main folder///Order/Processed. If the order is successfully converted into a customer invoice the eLMIS order file is moved from //main folder///Order/Incoming to //main folder///Order/Processed.
  
-If there is a problem and the order file is not converted into a customer invoice then the order file is moved to //main folder///Order/Error. In addition, an error file is created and is also placed in //main folder///Order/Error. The error file has the name "//XXXX//-YYYY-MM-DD-HH-MM.err.csv" where //XXXX// is the order file's filename without its extension. See the Error file format section below for the format of the error file. An error email with the error file attached will also be sent to the error email address set in the [[preferences:general#elmis|mSupply preferences]].+If there is a problem and the order file is not converted into a customer invoice then the order file is moved to //main folder///Order/Error. In addition, an error file is created and is also placed in //main folder///Order/Error. The error file has the name "//XXXX//-YYYY-MM-DD-HH-MM.err.csv" where //XXXX// is the order file's filename without its extension. See the Error file format section below for the format of the error file. An error email with the error file attached will also be sent to the error email address set in the [[preferences:general#elmis_tab|mSupply preferences]].
  
 ==== 2. Creates eLMIS shipment files for confirmed customer invoices ==== ==== 2. Creates eLMIS shipment files for confirmed customer invoices ====
Line 57: Line 56:
 Well, the good news is that day-to-day you don't have to do anything. The interface will continue running quietly in the background processing order files and creating shipment files as the customer invoices are confirmed. Well, the good news is that day-to-day you don't have to do anything. The interface will continue running quietly in the background processing order files and creating shipment files as the customer invoices are confirmed.
  
-Periodically you should check the error email address set in the [[preferences:general#elmis|mSupply preferences]] for messages about errors. Remember the order files that have caused errors can be found on the //main folder///Order/Error folder. Note that mSupply does not put anything in the //main folder///Shipment/Error folder - eLMIS only uses that folder when processing the shipment files.+Periodically you should check the error email address set in the [[preferences:general#elmis_tab|eLMIS preferences]] for messages about errors. Remember the order files that have caused errors can be found on the //main folder///Order/Error folder. Note that mSupply does not put anything in the //main folder///Shipment/Error folder - eLMIS only uses that folder when processing the shipment files.
  
 The only other time you will hear anything from the interface is if mSupply detects an item on a customer invoice that wasn't in the original eLMIS order. This will happen if one of the item placeholder lines was replaced with a different item (e.g. because of low stock or a preferred item is to be used). In this case, mSupply will show a window and ask you to tell it which item on the original order you replaced with the item in question. Once you have selected the item that has been replaced mSupply will continue creating the shipment file. The only other time you will hear anything from the interface is if mSupply detects an item on a customer invoice that wasn't in the original eLMIS order. This will happen if one of the item placeholder lines was replaced with a different item (e.g. because of low stock or a preferred item is to be used). In this case, mSupply will show a window and ask you to tell it which item on the original order you replaced with the item in question. Once you have selected the item that has been replaced mSupply will continue creating the shipment file.
Line 88: Line 87:
 \\ \\
 \\ \\
-|  //  Previous:  **[[integration:frontlinesms_integration:|19.02. FrontlineSMS integration]]** | | Next: **[[integration:moneyworks|19.04. Moneyworks Integration]]** //  |+|  //  Previous:  **[[integration:frontlinesms_integration:]]** | | Next: **[[integration:moneyworks]]** //  |
  
  
 ---- struct data ---- ---- struct data ----
 +pagestatus.status    : 
 ---- ----
  
  • Last modified: 2019/09/19 09:43
  • by lou