integration:ivedix

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:ivedix [2024/10/17 15:01] – Gary Willettsintegration:ivedix [2026/01/29 13:09] (current) – [Store preferences] Gary Willetts
Line 3: Line 3:
 mSupply has an interface with the iVEDiX reporting API. The interface allows the automatic sending of batch and transaction information to the iVEDiX reporting platform. mSupply has an interface with the iVEDiX reporting API. The interface allows the automatic sending of batch and transaction information to the iVEDiX reporting platform.
  
 +
 +===== Set up =====
 +==== Preferences ====
 The preferences that define how this interface works are managed on the //iVEDiX// tab of the //File > Preferences// menu. The tab looks like this: The preferences that define how this interface works are managed on the //iVEDiX// tab of the //File > Preferences// menu. The tab looks like this:
  
Line 15: Line 18:
   * **Send now button:** If this is clicked, all information waiting in the failed queue to be sent to the iVEDiX API is sent immediately.   * **Send now button:** If this is clicked, all information waiting in the failed queue to be sent to the iVEDiX API is sent immediately.
   * **Number of times to retry sending:** The maximum number of times to retry sending information to iVEDiX. Once a piece of information has failed to be sent this number of times, the failure becomes permanent: it is removed from the send queue and the final failure is logged.   * **Number of times to retry sending:** The maximum number of times to retry sending information to iVEDiX. Once a piece of information has failed to be sent this number of times, the failure becomes permanent: it is removed from the send queue and the final failure is logged.
-  * **Send errors to this email address:** All errors sending information to the iVEDiX platform are sent to this email address.+  * **Send errors to this email address:** All errors sending information to the iVEDiX platform are sent to this email address. You can enter multiple email addresses in here by entering them one after another separated with a semicolon ('';'').
  
 +==== Store preferences ====
 +You must also tell mSupply which stores to send information to iVEDiX for. This is done by adding a "pushToIvedix" custom field to a store. Set it to "true" in all stores that you want to send information to iVEDiX like this:
 +
 +{{ .:pasted:20260129-130754.png?650 }}
 +
 +Details on how to set these custom fields ina store's details window can be found on the [[other_stuff:virtual_stores#custom_fields_tab page|26.07. Virtual stores]].
  
 ===== What it does ===== ===== What it does =====
Line 37: Line 46:
   * transactionDate: the transaction's confirmed date in ISO date format.   * transactionDate: the transaction's confirmed date in ISO date format.
   * warehouse: the store code; WH0004, 6 or 7 and the corresponding Malaria stores take the corresponding main store code.   * warehouse: the store code; WH0004, 6 or 7 and the corresponding Malaria stores take the corresponding main store code.
-  * donor: the transactino category of the transaction.+  * donor: the transaction category of the transaction.
   * productCode: the item code.   * productCode: the item code.
   * batchNumber: the batch of the stock.   * batchNumber: the batch of the stock.
Line 44: Line 53:
   * quantity: pack size x number of packs for this transaction line.   * quantity: pack size x number of packs for this transaction line.
  
 +There are actually two schedulers running to control sending transactions to iVEDiX: one picks up all new transactions and sends them for the first time. The other picks up all the failed transactions and sends them again until they have reached the maximum number of retries before permanent failure.
 ===== Errors ===== ===== Errors =====
-If errors are encountered during either of the sending processes then the information to be sent is entered into a queue. All pices of information (batches or transactions) in that queu are attempted to be resent after the number of minutes stored in the **Interval between retries** field. When a piece of informaiton is successfully sent it is removed from the queue. If a piece of information is not sent successfully after the number of retries in the **Number of times to retry sending** field then it is removed from the queue, the final failure is logged (see the [[admin:the_log]] page for details on how to view the log) and an email giving details of the error is sent to the email address stored in the **Send errors ro this email address** field. +If errors are encountered during either of the sending processes then the information to be sent is entered into a queue. All pices of information (batches or transactions) in that queu are attempted to be resent after the number of minutes stored in the **Interval between retries** field. When a piece of informaiton is successfully sent it is removed from the queue. If a piece of information is not sent successfully after the number of retries in the **Number of times to retry sending** field then it is removed from the queue, the final failure is logged (see the [[admin:the_log]] page for details on how to view the log) and an email giving details of the error is sent to the email address stored in the **Send errors to this email address** field. 
  
 \\ \\
 \\ \\
-|  //  Previous:  **[[integration:hl7_integration]]** | | Next: **[[tables_fields:]]** //  |+|  //  Previous:  **[[integration:hl7_integration]]** | | Next: **[[integration:siglofa]]** //  |
  
 ---- struct data ---- ---- struct data ----
  • Last modified: 2024/10/17 15:01
  • by Gary Willetts