Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
preferences:synchronisation [2021/04/27 12:03] – Gary Willetts | preferences:synchronisation [2023/12/04 02:32] (current) – [The preferences] Kahn Wynyard | ||
---|---|---|---|
Line 1: | Line 1: | ||
{{indexmenu_n> | {{indexmenu_n> | ||
- | ====== | + | ====== |
<WRAP center round important 90%> | <WRAP center round important 90%> | ||
- | * Synchronisation | + | * The preferences |
- | * These preferences can be safely ignored if you have a stand-alone | + | * In a [[synchronisation:introduction|synced system]] |
+ | * There are some settings that are 'per store' - refer [[other_stuff: | ||
</ | </ | ||
- | To view the synchronisation settings choose //File > Preferences// | + | To view the synchronisation settings choose //File > Preferences// |
- | {{ : | + | {{ : |
- | <WRAP center round alert 60%> | + | When you first arrive at this window, all fields |
- | These settings | + | |
- | </ | + | |
- | This list contains the names of the servers to synchronize with. If this is the primary server all the satellite servers will be identified in this table. If this is a satellite server then the primary server only will be identified in here. Click on the ' | + | ===== Unlocking the settings for editing ===== |
- | ==== Editing sync preferences | + | Click on the **Click to un-lock** |
- | **Sync time interval:** This is the time interval in minutes between requests for new information that the satellite servers make to the primary server. <WRAP center round tip 60%> | + | |
- | Setting this to '' | + | |
- | </ | + | |
- | 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 | + | |
- | **Click to Un-lock button:** Altering these preferences can have serious consequences for your mSupply(r) data so the remaining synchronisation preferences are protected by an authorisation code. Click on the 'Click to Un-lock' | + | {{ : |
- | ==== Synchronize parameters | + | Enter your unlocking code in the **Authorisation code** field and click on the **OK** button. If the code you enter is valid, the various fields and buttons will be unlocked for editing and using, otherwise you will be told that the code is invalid and everything will remain read-only. |
- | * **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 | + | |
- | * **User name:** Communication between | + | |
- | * **Password:** as above. | + | ===== The preferences ===== |
- | * **URL:** On a remote site, this should be the central servers URL or IP address. On central | + | |
- | | + | |
+ | * **Sync time interval:** the number of minutes between attempts | ||
+ | * **Sync request size:** the number of requests to lump together when communicating with the primary server. If the internet connection | ||
+ | * **Use js node HTTP client checkbox:** 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. | ||
+ | * **Check connection button:** click on this to check the connection to the primary | ||
+ | |||
+ | ==== Synchronise parameters section ==== | ||
+ | This list contains the names of all the sites to synchronise with. If this is the primary server all the satellite servers will be identified in this table. If this is a satellite server then the primary server only will be identified in here. | ||
+ | |||
+ | Sometimes there can be hundreds of sites in this list. To find the one you're interested in, you can click on the column headers to order the list by them (click again to reverse the sort order - same as with most columns throughout mSupply) or enter a site sync ID or user name in the field just above the list to reduce the list to those with an ID or user name starting with what you have entered. | ||
+ | |||
+ | === Editing an existing row === | ||
+ | Double-click on a row to edit its details. This window will open: | ||
{{ : | {{ : | ||
+ | |||
+ | * **Sync ID:** The ID of the site in the synchronisation system. You choose this; it MUST be unique to each site to be synchronised. 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 for communication to be successful. 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: | ||
+ | * **URL:** On a remote site, this should be the central server' | ||
+ | * **Hardware ID:** This is a unique hardware identifier of the remote machine. The primary server has a copy of this information and, if the value here differs from that on the central server, sync will be diabled for this site. If the remote machine hardware has actually changed (e.g. a new computer) then clearing this value on the primary server will allow the new value to be saved and sync will resume. | ||
+ | * **Generate sync records button: | ||
+ | * **New button:** Clicking this will create sync out records for system and transactional data (users, preferences, | ||
+ | * **Existing button:** Clicking this will create sync out records for store data only. | ||
+ | |||
+ | * **Retrieve sync records button:** Does a manual pull of sync records waiting for this site on the primary server. | ||
+ | |||
+ | === Adding a site === | ||
+ | To add a new site to sync with, click on the {{: | ||
+ | |||
+ | === Deleting a site === | ||
+ | To delete a site from the list, simply click on it to select it and click on the {{: | ||