3. Create the Store

This step is best carried out using the Sync site wizard. These instructions are retained here for reference only.

After the sync sites have been set up, there are three approaches to creating and configuring the store that will be operated on that site.

  1. On mSupply desktop go to Special > Stores > New Store
  2. Enter the Store Code and the Store Name
    • The Store Code can not include spaces
    • The Store Name needs to be something that users will recognise.
      Mobile Store 1 is not likely to be a good name to use. ;-)

This method is only useful if you already have a customer that you want to convert to a store.
We must first clone the existing customer then merge the new store with the existing customer.

Cloning the existing customer to a store

  1. The mSupply Support Team will use the footrunner code ''store_create_from_name'' to clone the original store. We will need to provide:
    1. Name ID (not name Code :-() to create the store for (must not be blank or already a store)
    2. Store mode for new store (one of store, dispensary or report). Almost always, this should be store
    3. Sync ID for site on which the new store will be Active (optional; if left blank, will default to the current site ID)

Merging the new store with the existing customer

Using the mSupply Desktop User Guide merge the new store name with the existing customer name. There is some footrunner code that can facilitate this for multiple sites.

Before merging all unfinalised Customer Invoices from supplying stores to the existing customer must be finalised. On a system with supplying stores on multiple sync sites, this can take a long time. Start early, and if possible, ask the supplying stores to refrain from creating any new Customer Invoices until the merging is done…

If you try to do the merge before finalising all customer invoices, you will get an error message, and the merge will not proceed

First manually create and appropriately configure a single store.

Make sure the relevant sync sites have been created and then, for EACH store:

  1. The mSupply Support Team will use the footrunner code sync_clone_sync_site to clone the original store. We will need:
    1. Sync ID for source sync site

    2. Sync ID for clone sync site

    3. Sync version (v1 for desktop, v3 for mobile)

    4. Decision on whether the cloned store will have 'group' store visibility (visible to all other stores with the same supplying store) or not

    5. Decision on whether to also clone locations, transactions, stock, requisitions. (almost always NO!)

    6. new store code and name for each cloned store

    7. new user name and password for the each cloned store's default user

  2. If there are actually existing customers for each of these stores, you will then need to merge the existing customer name with the new store

  3. The new store will have the same item visibility configuration as the original store. Review, and if necessary, configure items visibility

  4. The new store will have the correct 'basic' sync settings. Review, and if necessary, configure synchronisation settings

  5. The new store will have the correct 'basic' store visibility settings, including, if you have selected it, 'group' store visibility. Review, and if necessary, configure store visibility to other stores



  • en/mobile/setup/server_side/create_store.txt
  • Last modified: 2021/07/15 23:01
  • by Mark Glover