other_stuff:remote_sync

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
Last revisionBoth sides next revision
other_stuff:remote_sync [2021/06/14 16:21] – [Data types] Adrian Booneother_stuff:remote_sync [2021/12/28 02:46] – [Moving stores and sites] Mark Glover
Line 1: Line 1:
 {{indexmenu_n>30}} {{indexmenu_n>30}}
  
-====== 25.03. Remote synchronisation ====== +====== 26.03. Remote synchronisation ======
- +
-<wrap info>Updated: mSupply Version 4.0.3</wrap>+
 <wrap info>Updated: mSupply Version 4.12</wrap> <wrap info>Updated: mSupply Version 4.12</wrap>
  
Line 229: Line 227:
 | Custom reports | Central | Standard reports are regenerated on each upgrade | | Custom reports | Central | Standard reports are regenerated on each upgrade |
 | Asset settings | Central | | | Asset settings | Central | |
 +| Regions | Central | |
 | Sites and sync-related preferences | Sync | Changes on the central server indirectly update related records on remote sites | | Sites and sync-related preferences | Sync | Changes on the central server indirectly update related records on remote sites |
 | Dashboard reports | Sync | | | Dashboard reports | Sync | |
Line 295: Line 294:
 ==== Dispensary data ==== ==== Dispensary data ====
  
-=== Prescriptions ===+=== Stock transactions ===
  
 By default, prescriptions and any other operations in dispensary mode which affect stock levels are not synced to the sync server, unless the //Include transactions in sync// option is enabled in the store sync preferences, as these can potentially generate a lot of sync traffic and there is usually no need for the central users to have this level of detail - the same site will usually have another store which supplies the dispensary and its transactions will be synced, and that's usually enough to infer usage for the dispensary store. By default, prescriptions and any other operations in dispensary mode which affect stock levels are not synced to the sync server, unless the //Include transactions in sync// option is enabled in the store sync preferences, as these can potentially generate a lot of sync traffic and there is usually no need for the central users to have this level of detail - the same site will usually have another store which supplies the dispensary and its transactions will be synced, and that's usually enough to infer usage for the dispensary store.
Line 303: Line 302:
   * Transactions (including backorders, builds etc.)   * Transactions (including backorders, builds etc.)
   * Prescriptions   * Prescriptions
-  * Stock and stocktakes+  * Stock lines 
 +  * Stocktakes
  
 If the preference is switched on, all of the store's transaction & stock data will be synced to the sync server. If the preference is switched on, all of the store's transaction & stock data will be synced to the sync server.
Line 381: Line 381:
  
 ===== Requirements ===== ===== Requirements =====
 +==== Synchronisation Server ====
 +The Sync server module is the component that controls all the logic of the sync system described in this chapter.  This module is priced separately - refer [[http://msupply.org.nz/pricing/|Pricing]]
 +==== Web Server ====
 +Any communication through the web to an mSupply central server requires the [[web_interface:using_the_web_server|Web Server Module]].  This module is priced separately - refer [[http://msupply.org.nz/pricing/|Pricing]]
 +==== Internet connection ====
 +Each sync site requires an internet connection.  This doesn't have to be on all the time for each satellite server, but at least an hour or so per day or per week, depending on the transaction volume, how often primary server data needs to be updated, and the speed and latency of the internet.  <WRAP center round tip 60%>
 +Obviously, the internet needs to be on at the central server at the same time as any other sync site that it will communicate with.  For this reason, the central server needs to have high availability, and so in most cases, will be cloud hosted.
 +</WRAP>
 +
  
-  * A license from Sustainable Solutions to use the web server module and the synchronisation module on the primary server. 
-  * Internet at each sync site. This doesn't have to be on all the time for each satellite server, but at least an hour or so per day or per week (depending on the transaction volume and the speed and latency of the internet, and how often you need primary server data updated). Obviously, the internet needs to be on at the primary server at the same time. 
  
 ===== How to tell if synchronisation is happening ===== ===== How to tell if synchronisation is happening =====
Line 436: Line 443:
   - Decide on the users for each site and their roles/permissions   - Decide on the users for each site and their roles/permissions
    
-===== Movings stores and sites =====+===== Moving stores between sync sites =====
  
 <WRAP center round important 60%>Misconfiguring of store or site settings can corrupt data across the synchronisation system. This should only be done by someone trained to do so and with guidance from the mSupply team</WRAP> <WRAP center round important 60%>Misconfiguring of store or site settings can corrupt data across the synchronisation system. This should only be done by someone trained to do so and with guidance from the mSupply team</WRAP>
Line 454: Line 461:
 <WRAP center round important 60%> <WRAP center round important 60%>
   * A mobile site can only have one **Active** store.   * A mobile site can only have one **Active** store.
-  * Therefore, only one of the stores on a 'From' desktop site can be moved to a single mobile site. +  * Therefore, only one of the stores on a 'From' desktop site can be moved to a single mobile site.  If another **Active** store on the 'From' desktop site needs to be moved to a mobile site, then it will need to be moved to another sync site, mobile or desktop.
-  * If another **Active** store on the 'From' desktop site needs to be moved to a mobile site, then it will need to be moved to another sync site, mobile or desktop.+
 </WRAP> </WRAP>
  
Line 467: Line 473:
   - If the 'To' site is a desktop site that already exists, then make the store **Active** on the 'To' site by finding the 'To' site in the list and click on the **Local** checkbox.{{  :other_stuff:pasted:20200915-042211.png?400  }}   - If the 'To' site is a desktop site that already exists, then make the store **Active** on the 'To' site by finding the 'To' site in the list and click on the **Local** checkbox.{{  :other_stuff:pasted:20200915-042211.png?400  }}
   - If the 'To' site is the central server, or doesn't yet exist, make the store **Active** on the central server by clicking on the **Set as local store** checkbox{{  :other_stuff:pasted:20200915-052116.png?400  }}   - If the 'To' site is the central server, or doesn't yet exist, make the store **Active** on the central server by clicking on the **Set as local store** checkbox{{  :other_stuff:pasted:20200915-052116.png?400  }}
-  - Unless you are sure that you want a full **Collector** copy of the store to be maintained on the 'From' site (not normally desired), change the sync type for this store on the 'From' site to **Transfer**.+  - Set the sync type for this store on the 'From' site to whatever you want: 
 +    - **None** if the 'From' site only had this store on it.  You will likely also want to delete the sync site - see step 12 below. 
 +    - **Transfer** if this store will likely need to transfer to / from another store on the 'From' site 
 +    - **Collector** //**only**// if a full copy of the store is to be maintained on the 'From' site.  This is not normally desired and is not recommended!
   - Click **OK** to save changes   - Click **OK** to save changes
   - Click **OK** to exit the stores list   - Click **OK** to exit the stores list