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/04/07 09:07] – Gary Willettssynchronisation:sync_sites [2024/04/23 10:21] (current) – Andrei Evguenov
Line 11: Line 11:
  
 ===== Type of sites ===== ===== Type of sites =====
-When thinking about sites, it's useful to align the concept with real-world scenarios as well as the type of mSupply installation being used. +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 40: Line 28:
 You can see the unique site ID, site name and application type of the remote site here. You can see the unique site ID, site name and application type of the remote site here.
  
-**Note:** The 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.
  
 **Note:** The //X/Y// number in the bottom left corner shows the number of sites showing in the table (//X//) and the total number of sites (//Y//) **Note:** The //X/Y// number in the bottom left corner shows the number of sites showing in the table (//X//) and the total number of sites (//Y//)
 +
 +  * **New button:** When clicked, this will open a new site window for you to enter the details. See the [[synchronisation:sync_sites#creating_new_sync_sites|Creating New Sync Sites]] section below for details of all the fields and what they mean.
 +  * **Delete button:** Select a site in the list and click on the **Delete** button to delete it. Sync sites can be deleted if they: 
 +    * have no stores connected to them (delete the stores in the site first. Note: removing a store from a remote site will add that store to the central server), and 
 +    * are not the active site on your current datafile.
 +
 +Double-click on a site in the list to open its details window:
 +
 +{{ :synchronisation:pasted:20230407-112843.png?700 |}}
 +
 +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:
 +
 +{{ :synchronisation:pasted:20230407-113017.png?700 |}}
 +
 +The filters are set to show all logs for the current day by default.
  
  
Line 75: Line 78:
  
 === 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 95: Line 101:
 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 106: Line 112:
 === 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.
 +
 +=== Open mSupply Central Server Settings ===
 +<WRAP center round important 60%>
 +In mSupply v7.14.00 we've added configuration for open mSupply central server, which is required for open mSupply remote site from v2.0.0 **Open mSupply Central Server Settings** are used to identify a site as open mSupply central server
 +</WRAP>
 +
 +{{:synchronisation:screenshot_2024-04-23_at_10.20.50_pm.png?600|}}
 +
 +=== Site is open mSupply central server === 
 +
 +Only editable when site is not active on mSupply central server. Only one site can be set as open mSupply central server, an error will be shown if you try to set this site as open mSupply central server (the site that is set as open mSupply central server will be shown in the error alert). 
 +
 +=== Open mSupply central server url ===
 +
 +A url which points to this open mSupply central server site. This url will be sent to all open mSupply remote sites on every sync iteration, open mSupply remote site will in turn use this url to synchronise with open mSupply central server. This url can be changed if 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 129: Line 151:
 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. +
- +
-Stores removed from a remote site will automatically be moved to the Central Server Site.  +
- +
-===== Deleting Sync Sites =====+
  
-Sync sites can be deleted if they:  +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.
-  * Have no stores connected to them, and  +
-  * Are not the active site on your current datafile. +
  
-If the sync site you want to delete has stores on it, you will have to remove those stores from the sync site before mSupply allows you to delete it. Removing a store from a remote site will add that store to the central server. +Stores removed from a remote site will automatically be moved to the Central Server site. 
  
-You can not delete the site that is active on your current datafile. That would break your datafile! 
  
 ===== Viewing/Editing Site Details on the Remote Site  ===== ===== Viewing/Editing Site Details on the Remote Site  =====
  • Last modified: 2023/04/07 09:07
  • by Gary Willetts