23.09. iVEDiX integration

mSupply has an interface with the iVEDiX reporting API. The interface allows the automatic sending of batch and transaction informaiton to the iVEDiX reporting platform.

The preferences that define how this interface works are managed on the iVEDiX tab of the File > Preferences menu. The tab looks like this:

• Send information to iVEDiX checkbox: If this is checked then mSupply will automatically send information about transactions and new batches to the iVEDiX platform. If it is unchecked then no information is sent to iVEDiX.
• iVEDiX API URL: The URL of the iVEDiX API to send information to.
• iVEDiX API key: The authentication key to be sent to authorise communictaion with the API.
• Interval between retries: The number of minutes to wait between attempts to resend information that fails to reach the iVEDiX API for any reason.
• 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.
• Send errors to this email address: All errors sending information to the iVEDiX platform are sent to this email address.

.

.

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 25.19. The system 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.