Differences

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

--- en:mobile:setup:device_side:initialise_store [2020/03/03 01:04] – ↷ Page name changed from en:mobile:setup:device_side:3 to en:mobile:setup:device_side:initialise_store lou_lomas
+++ en:mobile:setup:device_side:initialise_store [2024/10/08 07:28] (current) – [Initialising the store] Mark Glover
@@ Line 2: / Line 2: @@
 ===== Initialising the store =====
-After installing the mSupply Mobile app, you must do an initialisation of the data for the mSupply Store that the tablet is going to be used in.
+After installing the mSupply Mobile app, you must initialise the data for the mSupply Store that the device is going to be used in. Most of the work is actually done by mSupply but you will need to set the store credentials on the device.
-==== Entering the store credentials ====
+<WRAP center round tip 800px> When first syncing the new device the amount of records to sync may be large (say around 50,000). This could take hours to sync, especially over a poor internet connection. For this reason it is possible for you to limit how many months of transactions and stocktakes you want to include. [[en:mobile:setup:device_side:initialise_store#Limiting_the_sync_date_range|Limiting the sync date range]] below explains how to limit the sync date range if this is required. </WRAP>
-On opening the mSupply Mobile app, the first screen looks as follows:
-{{ :en:mobile:first_screen.jpg?800 |}}
-You must enter:
+When you open mSupply Mobile, the first screen looks as follows:
-  * The correct URL for your mSupply Server, this uses HTTPS protocol for security, e.g. ''%%https://%%//__your organisation__//.msupply.org''
-  * Sync site name as configured on the Primary Server
+{{ :en:mobile:first_screen.jpg?800 |}}
-  * Password for the sync site as configured on the Primary Server
-{{ :en:mobile:explanation.jpg?600 |}}
+  * **PRIMARY SERVER URL**: Please enter the correct URL for your mSupply Server, this uses HTTPS protocol for security. For example: ''%%https://%%//__your organisation__//.msupply.org''
+  * **SYNC SITE NAME**: The site name as configured on the primary server.
+  * **SYNC SITE PASSWORD**: The password for the sync site as configured on the primary server.
+Once you have entered the information, click ''Connect'' to start sync.
-Once you have entered the information, click "Connect" to start sync:
 {{ :en:mobile:initialising.jpg?600 |}}
-Initialisation can take between 1 and 15 minutes, depending on the number of records on the server related to the site being synced. Once the server has found all the records to sync, mSupply Mobile will start pulling them adaptively between 20 and 500 records at a time depending on the connection speed. If connection is lost or you closed the app, you can resume sync where it stopped by entering the exact same details.  It will start again from scratch if you get it wrong before getting it right again!
+Initialisation can take between 1 and 15 minutes depending on the number of records on the server related to the site being synced and the quality of your internet connection.
 {{ :en:mobile:pulling.jpg?600 |}}
+Once the server has found all the records to sync, mSupply Mobile will start pulling them between 20 and 500 records at a time depending on the connection speed.
+If the connection is lost or you close the app, you can resume sync where it stopped by entering the exact same details.  Please note that if you enter different details, it will restart the sync completely!
-=== Logging in to the store ===
+==== Logging in to the store ====
 Once complete, you will be taken to the login screen. For guidance beyond here see the [[https://docs.msupply.foundation/en:mobile:user_guide:getting_started#ok_here_we_go|mSupply Mobile user guide]].
 ==== Limiting the sync date range ====
-When first syncing the new device the amount of records to sync may be large (say around 50,000).  This could take hours to sync, especially over a poor internet connection.  For this reason it is possible for you to limit how many months of transactions and stocktakes you want to include.
+When first syncing the new device the amount of records to sync may be large (say around 50,000). This could take hours to sync, especially over a poor internet connection.  For this reason it is possible for you to limit how many months of transactions and stocktakes you want to include.
 {{ :mobile:msupply_sync_months.jpg?nolink&600 |}}
-  - Change the store **Synchronisation type** from ''collector'' to **''active''** or **''none''** to unlock editing custom fields
+  - Change the store **Synchronisation type** from ''collector'' to **''active''** or **''none''** to unlock editing custom fields.
-  - Add a new line setting the **Field label** to **''syncMonths''** and the **Field value** to the number of months you wish to include
+  - Add a new line setting the **Field label** to **''syncMonths''** and the **Field value** to the number of months you wish to include.
-  - To edit the custom field double-click on the line
+  - To edit the custom field double-click on the line.
-  - Change the store synchronisation type back to **''collector''**
+  - Change the store **Synchronisation type** back to **''collector''**
 Now whenever a sync is carried out the store will only sync transactions and stocktakes for the previous X months.