mSupply Server Setup

Setting up mSupply Server for mobile

Setting up the server🔗

The following details the steps of setting up mSupply from your organisation's mSupply Server

The mSupply Support Team will complete these steps for you. The following instructions are for your information only.

Where to start🔗


  • a server running msupply with a web server license registered
  • sync server has a static ip and any network permissions required configured
  • a mobile tablet fitting the recommended specifications here

Information needed

  • Store name
  • The item master list to be attached to the store
  • If you are converting an existing mSupply site (customer) to mSupply Mobile, then you also need to provided the existing customer name tha the store is being created for

Creating mobile stores for new sites

EACH individual mobile store needs to have the following steps done on the server, which are detailed later in this Server setup guide:

  1. Create the sync site
  2. Create the mobile store
  3. Configure the mobile store section 4 of this guide
  4. Create user(s) to access the store section 5 of this guide

Items 1 and 2 can now be carried out using the Sync site wizard. See here.

Custom settings🔗

These are set on the Custom fields tab of the store preferences in mSupply desktop (Special > Show Stores, Double-click on store > Custom fields tab).

Setting nameAllowed Value(s)Description
default value in italics
usesDashboardModuletrue or falseNeeds to be set to true if using the dashboard
usesVaccineModuletrue or falseNeeds to be set to true if using the vaccines module
usesCashRegisterModuletrue or falseNeeds to be set to true if using the cash register
usesPaymentModuletrue or falseNeeds to be set to true if handling cash payments. There are some (good!) side effects if this setting is true: The sell and cost price columns are shown on Supplier Invoices and are also shown when editing batches in a stocktake where the sell price is editable. See below for examples.
usesPatientTypestrue or falseIf set to true then you can choose between “Inpatient and Outpatient” when dispensing. The data is stored in the transact.user1 field. Of course, usesDispensaryModule must be set to true for this to have any effect (see above)
monthsLeadTimenumber (0)The months of lead time - will be multiplied by 30 to use in mobile as months of lead time
monthlyConsumptionLookBackPeriodnumber (12)The number of months to look back when calculating average monthly consumption (AMC)
monthlyConsumptionEnforceLookBackPeriodtrue or falseif True, then the full lookbackup period will be used, even if there is no consumption in those periods. We don't recommend this, but it's here to comply with the rules in some countries

Other preferences🔗

You can set other preferences for mobile in the Store preferences by going to Special > Show Stores, Double-click on store > Preferences tab

Here are the preferences and what they do:

ProgramsIf you have a master list configured as a program, in mobile you will then be able to perform stock takes or supplier requisitions by program.
ReasonsIf you have BOTH positive and negative inventory adjustments, have to apply a reason to stocktake lines with a difference = 0
Prescription CategoriesIf you have transaction categories with type of “prescription” mobile will display a drop down list of prescription categories to select from
Insurance ProvidersIf you configured an insurance provider, then mobile will give you the ability to choose a policy, and to edit and create them at the end of a prescription
Payment TypesIf you have configured any payment types, they’ll show up in a list at the end of a prescription

Dispensary mode🔗

Ensure that your store is a Dispensary by choosing Dispensary from the drop-down list on the General tab of the store preferences.

Mobile dispensing pref on desktop!

You will need to synchronise mSupply mobile with the server before the mobile device receives these configuration settings. After sync, your Navigator window will look like this:

mobile navigator with dispensing enabled!

Vaccine dispensing🔗

If you want to use mobile for dispensing vaccines then see the setup instructions on the Vaccine Dispensing Setup page.

When the Payments module is on🔗

  • The cost and sell price are visible on supplier invoices.
  • The cost and sell price are visible when doing stocktakes.