synchronisation:sync_sites

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
synchronisation:sync_sites [2023/08/14 01:10] – [Type of sites] Mark Gloversynchronisation:sync_sites [2025/05/15 22:28] (current) – [Viewing Sync Sites] Gary Willetts
Line 12: Line 12:
 ===== Type of sites ===== ===== Type of sites =====
 When thinking about sites, it's helpful to understand which mSupply products are being used - refer [[about:which_one_for_you#comparison_of_the_msupply_products|Comparison of the mSupply products]]. When thinking about sites, it's helpful to understand which mSupply products are being used - refer [[about:which_one_for_you#comparison_of_the_msupply_products|Comparison of the mSupply products]].
- 
-==== mSupply Desktop Single User ==== 
-mSupply Desktop can be run as a single-user site. This is recommended for smaller facilities where there will only be one mSupply store being managed, and only one user needing to access the application at a time. A single user site can run offline while the internet is patchy, and communicate with other sites once internet connection is restored.  
- 
-==== mSupply Desktop Client/Server ==== 
-Facilities that require multiple concurrent users can use a client-server instance.  
- 
-==== mSupply Mobile ==== 
-A mobile site will run [[https://msupply.org.nz/mobile/|mSupply Mobile]], an open-source mobile app with a stripped-back version of mSupply. The mSupply mobile app has been specifically designed to be used in areas with intermittent internet connection.  
- 
-We recommend mSupply mobile for small facilities which process up to [TO DO] transactions per day, and do not require label or receipt printing.  
- 
  
 ===== Permissions ===== ===== Permissions =====
Line 36: Line 24:
  
 From here you'll see the list of all sites: From here you'll see the list of all sites:
-{{ :synchronisation:site_output.png?400 |}}+{{ :synchronisation:site_output.png?500 |}}
  
-You can see the unique site ID, site name and application type of the remote site here.+  * **ID:** the unique site ID that identifies the site 
 +  * **Site code:** the code that identifies the site, This is usually a shorthand way of referring to the site, rather than using its name. 
 +  * **Site name:** the name of the site. This is how the site is usually referred to 
 +  * **Device type:** the type of application used by this site: 
 +    * desktop = existing mSupply, single user 
 +    * mobile = mSupply mobile 
 +    * mSupplySingleUser = existing mSupply, single user 
 +    * Open mSupply = Open mSupply stand alone site 
 +    * remote_server = Open mSupply remote server 
 +    * mSupplyServer = existing mSupply remote server 
 +  * **Last synced date:** the date the site last successfully synchronised with the central server 
 +  * **Last snced time:** the time the sote last successfully synchronised with the central server
  
 **Note:** The active central server site will always be at the top of the list when sites are viewed on the central synchronisation server. **Note:** The active central server site will always be at the top of the list when sites are viewed on the central synchronisation server.
Line 51: Line 50:
 Double-click on a site in the list to open its details window: Double-click on a site in the list to open its details window:
  
-{{ :synchronisation:pasted:20230407-112843.png?700 |}}+{{ :synchronisation:pasted:20240904-173421.png?650 |}}
  
-The various fields are all described below in the [[synchronisation:sync_sites#creating_new_sync_sites|Creating New Sync Sites]] section. Click on the //Log// tab to see a list of the logs that have been recorded for that site:+The various fields are all described below in the [[synchronisation:sync_sites#creating_new_sync_sites|Creating New Sync Sites]] section.
  
-{{ :synchronisation:pasted:20230407-113017.png?700 |}}+Click on the //Details// tab to see some details to do with the support contract for this site: 
 + 
 +{{ :synchronisation:pasted:20240904-174020.png?650 |}} 
 + 
 +  * Funder name: the name of the funder. Type something in here and press the //Tab// key to search for a funder in the support database. 
 +  * License code: Read only. The mSupply license code for this site. Empty is it doesn't have one. 
 +  * Licensed users: Read only. The number of concurrent user licenses this site has. 
 +  * Support start date: Read only. The date that this site's support contract started, as retrieved from the support database. 
 +  * Support end date: Read only. The date that this site's support contract will or did end, as retrieved from the support database. 
 + 
 +Click on the //Log// tab to see a list of the logs that have been recorded for that site: 
 + 
 +{{ :synchronisation:pasted:20230407-113017.png?650 |}}
  
 The filters are set to show all logs for the current day by default. The filters are set to show all logs for the current day by default.
Line 76: Line 87:
    
 <WRAP tip center round 90%> <WRAP tip center round 90%>
-If the site is blocked because there have been too many failed login attempts then an **Unblock site** button will be shown next to the **Check connection** button. Click it and the site will be unblocked so that isers can attempt to login to it again.+If the site is blocked because there have been too many failed login attempts then an **Unblock site** button will be shown next to the **Check connection** button. Click it and the site will be unblocked so that users can attempt to login to it again.
 </WRAP> </WRAP>
 === Site ID === === Site ID ===
Line 90: Line 101:
  
 === Password === === Password ===
-The password is a password! It is used by remote sites to authenticate with the central server. You cannot view the password that is set, so you should record it securely.+The password is used by remote sites to authenticate with the central server.  It is recommended to use copy and paste so as to avoid data entry errors, particularly as you cannot view the password that is set here.
  
-Note: due to this being used for authentication, beware editing it. If you change the password on an actively used site, the remote site will stop syncing. To resume syncing, the password must be restored to the old value on the central server, or updated to the new value on the remote site.+<WRAP center round alert 60%> 
 +  * Take care to record this password securely as it will be required when creating the datafile on the remote site.   
 +  * This password is used for authentication, so beware of editing it. If you change the password for an active remote site, the remote site will stop syncing. To resume syncing, the password must be restored to the old value on the central server, or updated to the new value on the remote site. 
 +</WRAP>
  
 === Hardware ID === === Hardware ID ===
Line 110: Line 124:
 If this is checked the site is active on this datafile, which means transactions can be entered in it but master data (like item and customer details etc.) cannot. If unchecked then the site is not active in this datafile and transactions cannot be entered in it.  If this is checked the site is active on this datafile, which means transactions can be entered in it but master data (like item and customer details etc.) cannot. If unchecked then the site is not active in this datafile and transactions cannot be entered in it. 
  
-=== Use js node http client === +=== Use of JS Node HTTP Client === 
-If checked then a js node http client will be used to transmit and receive synchronisation data instead of the built-in mSupply webserver. Useful in some special circumstances.+This preference is not recommended and will be disabled in future versions of mSupply (v7.11 and above). Node JS was used in special circumstances where 4D HTTP handlers were not working well on cellular connections for certain regions. This has been improved and Node JS is no longer needed.
  
 === Sync interval === === Sync interval ===
Line 121: Line 135:
 === Server URL === === Server URL ===
 Only visible if you are on a remote site. The URL of the server to synchronise with, including the port number if necessary. Only visible if you are on a remote site. The URL of the server to synchronise with, including the port number if necessary.
 +
 +=== Site is Open mSupply central server === 
 +<WRAP center round important 60%>
 +In mSupply v7.14.00 we've added an //Open mSupply central server settings// section. This must be set for all Open mSupply sites from Open mSupply v2.0.0 onwards. The settings are used to identify the Open mSupply Central Server and tell Open mSupply remote sites where their server is.
 +</WRAP>
 +
 +{{:synchronisation:screenshot_2024-04-23_at_10.20.50_pm.png?400|}}
 +
 +This checkbox is only editable when the site is not active on mSupply central server. Only one site can be set as the open mSupply central server, an alert will be shown if you try to set this when another site already has it set. 
 +
 +=== Open mSupply central server url ===
 +The URL which points to the open mSupply central server. This URL will be sent to all open mSupply remote sites on every sync iteration, and an open mSupply remote site will, in turn, use this URL to synchronise with the open mSupply central server. This URL can be changed if the open mSupply central server site is relocated.
 +
 ==== Adding stores ==== ==== Adding stores ====
 **Note:** You can only add a single store to a //mobile// type site. If you try to add another mSupply will show you an alert telling you that you can't add another. **Note:** You can only add a single store to a //mobile// type site. If you try to add another mSupply will show you an alert telling you that you can't add another.
Line 144: Line 171:
 When editing an existing site, all store data of any added stores will automatically be queued to sync to the remote site after pressing OK to save the changes. When editing an existing site, all store data of any added stores will automatically be queued to sync to the remote site after pressing OK to save the changes.
  
-==== Removing stores ====+==== Removing stores to the Central Server site ====
  
-To remove a store, highlight the store you wish to remove in the list of stores in the Site window, then press the //Remote store// button.+To remove a store, highlight the store you wish to remove in the list of stores in the Site window, then press the //Remove store// button.
  
-Stores removed from a remote site will automatically be moved to the Central Server Site. +Stores removed from a remote site will automatically be moved to the Central Server site. 
  
  
  • Last modified: 2023/08/14 01:10
  • by Mark Glover