Skip to content

Commit

Permalink
update sync page docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mark-prins committed Jan 8, 2025
1 parent e785081 commit 2f04523
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 8 deletions.
Binary file modified content/docs/getting_started/images/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/docs/sync/images/expand_qr.gif
Binary file not shown.
Binary file added content/docs/sync/images/qr_expanded.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/sync/images/settings_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/docs/sync/images/sync.gif
Binary file not shown.
Binary file modified content/docs/sync/images/sync_in_progress.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/docs/sync/images/sync_status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/sync/images/sync_status_close.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 12 additions & 8 deletions content/docs/sync/synchronisation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,20 @@ top = false

## Viewing the synchronisation status

To view the synchronisation status, go to `Sync` in the lower section of the navigation panel:
To view the synchronisation status, click `Sync` in the lower section of the navigation panel or press CTRL+ALT+S (CTRL+OPT+S if using a mac) on your keyboard:

![sync: nav](/docs/sync/images/sync_nav.png)

The page shows the number of records waiting to be pushed to the central servers, and the time that the last sync happened.
The window shows the number of records waiting to be pushed to the central servers, and the time that the last sync happened.

![sync: status](/docs/sync/images/sync_status.png)

As of v2.0.0, your Open mSupply server actually syncs to two central servers! The `Push V6` and `Pull V6` steps transfer data to and from the Open mSupply central server, which you can read more about [here](../../getting_started/central). The `Push`, `Pull Central` and `Pull Remote` steps are syncing with an mSupply central server.

To close the window you can press `Esc` on your keyboard or click the close button which is at the top right:

![sync: status](/docs/sync/images/sync_status_close.png)

## Manual synchronisation

On this (sync) screen you are also able to initiate synchronisation immediately rather than wait for the scheduled time ( remember, the sync interval is configured in the Admin > Synchronisation section, see the [Settings](/docs/settings/synchronisation/) page for details ).
Expand All @@ -40,16 +44,16 @@ The records will then be pushed to _either_ the Open mSupply central server (V6)

So in the above example, 4 sync records are being sent in total, not 8.

Here is the complete process in action. You'll notice that most of the sync steps are very quick, though it depends on how many records you have to sync:

<p><img src="/docs/sync/images/sync.gif" alt=:"sync: manual" width="800" /></p>

If any errors are encountered during the sync progress you will see these on this screen too. Hover over the `i` icon to see additional details.

![sync: error](/docs/sync/images/sync_error.png)

## Server details

At the top right of the `Sync` page the current server URL is shown, along with a QR code. The code contains the server URL and can be used to easily configure [mSupply Cold Chain](http://127.0.0.1:1111/coldchain/introduction/) when synchronising with Open mSupply. If you are having trouble scanning the code, you can click (or press, if using a tablet) the code to display a larger version.
At the top right of the `Settings` page the current server URL is displayed, along with a QR code. The code contains the server URL and can be used to easily configure [mSupply Cold Chain](/coldchain/introduction/) when synchronising with Open mSupply.

![sync: manual](/docs/sync/images/settings_page.png)

If you are having trouble scanning the code, you can click (or press, if using a tablet) the code to display a larger version.

![sync: manual](/docs/sync/images/expand_qr.gif)
![sync: manual](/docs/sync/images/qr_expanded.png)

0 comments on commit 2f04523

Please sign in to comment.