19.01. Setting up to use Vaccine Module

There are a few configuration steps needed in mSupply desktop for setting up the Vaccine module to be used in mSupply mobile. This page is all about those steps.

To set up the vaccine module correctly, you need to:

  • Enable the vaccine module for the mobile store,
  • Set up vaccine vial monitor (VVM) statuses,
  • Set up sensors, and
  • Set up temperature breach configurations

First of all, in mSupply desktop login to the store you want to turn on the vaccine module for. Then, from the menus, choose Special > Show Stores, double-click on the store you are logged into and then click on the Preferences tab. This is the window you will see:

Check the mobile: Uses Vaccine module checkbox in the Store preference list and click on the OK button to save the new setting.

First of all, you need to have permission in the system to edit vaccine vial monitoring statuses.

See the 23.15. Managing users page for details on how to set user permissions. You need to turn on the View and edit vaccine vial monitor status permission on the Permissions (3) tab.

You can access the vaccine vial monitor (VVM) status configuration window by choosing Item > Vaccines > Show vaccine vial monitor status… from the menus. This will open the VVM status window:

The window will show you a list of all the current vaccine vial monitor statuses that have been setup. To edit one, simply double-click on it in the list. This will open the same window as when adding a new status (see below) but populated with the status's current settings, ready for you to edit them.

Click the New button. This window opens:

  • Description: the name of the status and how it will be referred to throughout mSupply.
  • Code: a short code used to refer to the status.
  • Level: the numerical level the status belongs to.
  • Is active?: checked by default. If this is checked then the status will be available for selecting in mSupply mobile.

Click on the OK button to save your changes or the Cancel button to cancel them.

You can only delete a status that you have just created. Once this list of VVM statuses has been closed, you cannot delete the status any more. If there is one that you wish to delete but can't then edit it and uncheck its Is active checkbox (as described above). That will effectively delete it because it will no longer be selectable in any mSupply mobile functionality (but it will mean the status is still available for historical records).

If the status you want to delete is newly created:

  1. Select the status you want to delete by clicking on it in the list
  2. Click on the Delete button
  3. The window below will appear asking you to confirm the deletion. Click Yes to confirm.

Temperature sensors are used by mSupply mobile to monitor the temperature over time at a given location. This section describes the options available within mSupply to view/interact with temperature sensors.

First of all, you need to have permission in the system to view sensor details. See the 23.15. Managing users page for details on how to set user permissions. You need to turn on the View sensor details permission on the Permissions (3) tab.

To see the current sensors go to Item > Vaccines > Sensors…

This window will appear:

The window will show you a list of all the current sensors that have been set up. To view one, simply double-click on it in the list. This will open a window populated with the sensor's current settings.

You cannot add a sensor or edit any of the sensor details. This can only be done in mSupply mobile (see the Cold Chain (for Vaccines and other Cold chain items) - mobile page for details).

Temperature breaches occur when the temperature detected by a temperature sensor exceeds a certain value for a certain amount of time. This section describes how temperature breaches are defined in mSupply.

First of all, you need to have permission in the system to configure temperature breaches.

See the 23.15. Managing users page for details on how to set user permissions. You need to turn on the View and edit temperature breach configuration permission on the Permissions (3) tab.

To see the current temperature breaches go to Item > Vaccines > Show temperature breach configuration…

This window will appear:

The window will show you a list of all the current temperature breach configurations that have been set up. To view one, simply double-click on it in the list. This will open a window (see below) populated with the breach's current settings.

You cannot add, edit or delete a temperature breach configuration, this can only be done in mSupply mobile (see the Cold Chain (for Vaccines and other Cold chain items) - mobile page for details).

When you double-click a temperature breach configuration, this window will open, pre-populated with the configuration's details:

  • Description: The name given to the configuration. It will be referred to by this throughout mSupply.
  • Minimum temperature: If the temperature drops below this, it will contribute towards a breach
  • Maximum temperature: If the temperature rises above this, it will contribute towards a breach
  • Duration hours and minutes: The length of time the temperature must be below the minimum or above the maximum temperatures for a cumulative breach to occur.
  • Type: The breach configuration type, see Cold Chain (for Vaccines and other Cold chain items) - mobile for details on the breach types available.
  • Location type: The location type this breach belongs to. See the 4.06. Stock locations and location types page for details on location types.
  • Is active?: If checked then this breach configuration will be used in cold chain monitoring. If unchecked, it won't.

Click on the OK button to close the window.



  • Last modified: 2021/05/14 00:19
  • by Katherine Setiadarma