This is an old revision of the document!


15.07. Synchronisation

  • Synchronisation preferences are only relevant for a synced system.
  • These preferences can be safely ignored if you have a stand-alone mSupply installation, or a single server.

These settings will normally only be changed by Sustainable Solutions. They are not intended for general use by mSupply users. Documentation here is for reference only.

Sync time interval: This is the time interval in minutes between requests for new information that the satellite servers make to the primary server.

Setting this to 0 effectively pauses sync (after the current sync 'batch' has finished syncing).

Any user with permission to edit preferences can edit the sync time interval. This is the only synchronisation preference that can be edited without clicking the un-lock button.

Click to Un-lock button: Altering these preferences can have serious consequences for your mSupply® data so the remaining synchronisation preferences are protected by an authorisation code. Click on the 'Click to Un-lock' button and you are presented with the following screen: To continue and edit the synchronize preferences enter your authorisation code in the box and click on the OK button. To return to the preferences screen without unlocking the synchronize preferences click on the Cancel button.

  • Sync ID: The ID of the current store to use in the synchronization process. You choose this - it MUST be unique to each store to be synchronized. ID 1 is reserved for the primary server (so, if this is the primary server put 1 in here).
  • User name: Communication between the primary and satellite servers is authenticated. This user name and the password field must match what the primary server is expecting. So, you can enter any valid username and password in these fields but they must all be the same for the primary and satellite servers.
  • Password: as above.
  • URL: On a remote site, this should be the central servers URL or IP address. On central server, if any sites have this field populated it'll disable sync.
  • Hardware ID: This is a unique hardware identifier of the remote machine. If the remote machine hardware has changed (e.g. a new computer), you'll need to clear this value on the central server.



  • Last modified: 2020/10/14 04:42
  • by Chris Petty