Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision | ||
en:mobile:user_guide:mobile_settings [2020/07/22 00:32] – [Export data to backup mSupply Mobile database] Mark Glover | en:mobile:user_guide:mobile_settings [2022/01/21 01:03] – [Editing the Sync Interval] Mark Glover | ||
---|---|---|---|
Line 6: | Line 6: | ||
The Mobile Settings is where an user with appropriate permissions can carry out certain administration tasks including: | The Mobile Settings is where an user with appropriate permissions can carry out certain administration tasks including: | ||
- | * Editing | + | * Edit the **Sync URL** and **Sync Password** for your mobile store |
+ | * Configure the **Sync interval** and **Idle logout** interval | ||
* View the **Realm Explorer** | * View the **Realm Explorer** | ||
* **Export Data** (i.e. export your database file). | * **Export Data** (i.e. export your database file). | ||
+ | * **Import Data** (i.e. import a database file from another device). | ||
+ | * Perform a **Factory Reset** (i.e. remove all app-related data, including sync settings from the device) | ||
+ | * **Check Connection** (verifies connectivity between mSupply mobile and mSupply Desktop) | ||
==== Permission to Edit Mobile Settings ==== | ==== Permission to Edit Mobile Settings ==== | ||
- | To edit mobile settings, the user must have the **View/Edit Preferences** permission set for the mobile store on the Central server. Once these permissions are set, the **Settings** button will be visible the next time the user logs in. | + | To edit mobile settings, the user must have the **View/Edit Preferences** permission set for the mobile store on the Central server - refer [[en:mobile:setup:server_side: |
- | + | ||
- | In the mSupply Central server: | + | |
- | + | ||
- | | + | |
- | - Go to File > Edit users | + | |
- | - Select the mobile user (whom you want to give permission for backing mobile data up), double click it. An edit user window will open. | + | |
- | - Go to **Permission (3)** tab and check the **View/edit preferences** permission on | + | |
- | + | ||
- | {{ :en:mobile:user_guide:settings_permission.png? | + | |
- | + | ||
- | Click **OK** | + | |
==== Access Mobile Settings ==== | ==== Access Mobile Settings ==== | ||
Line 32: | Line 25: | ||
Clicking this button opens the **Settings** window. | Clicking this button opens the **Settings** window. | ||
- | + | {{ : | |
- | {{ : | + | |
=== Editing Sync URL or Sync Password === | === Editing Sync URL or Sync Password === | ||
Line 46: | Line 38: | ||
For changes to occur, click the **Save Changes** button. | For changes to occur, click the **Save Changes** button. | ||
- | + | {{ : | |
- | {{ : | + | |
When prompted, re-enter your password to confirm the changes. | When prompted, re-enter your password to confirm the changes. | ||
{{ : | {{ : | ||
+ | === Editing the Sync Interval === | ||
+ | |||
+ | * From v8.1.0, it is possible to edit the sync interval via the mobile settings page. | ||
+ | * To edit, drag the **Sync interval (minutes): | ||
+ | * It is also possible to enter a specific value into the text field to the right of the slider. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | |||
+ | |||
+ | You will need to click the **Save Changes** button and enter your password when done for the changes to be saved. | ||
=== Export data to backup mSupply Mobile database === | === Export data to backup mSupply Mobile database === | ||
- | For support purposes, it may be necessary to recover a backup of the mSupply Mobile database from the device. | + | For support purposes, it may be necessary to recover a backup of the mSupply Mobile database from the device. |
{{ : | {{ : | ||
Line 60: | Line 62: | ||
An admin worker will then be able to recover this backup file from **Download** > **mSupplyMobile_data** folder. | An admin worker will then be able to recover this backup file from **Download** > **mSupplyMobile_data** folder. | ||
+ | === Import backup mSupply Mobile database === | ||
+ | <WRAP center round important 60%> | ||
+ | This functionality is available from mSupply mobile v8.1.0 onwards | ||
+ | </ | ||
+ | For support purposes (e.g. replicating an issue locally that was reported on a remote device), previously backed up files (using the **Export Data** functionality described above) are able to be imported into mSupply mobile. Click the **Import Data** button on the settings page. This will take you to your device' | ||
+ | |||
+ | When a file is successfully selected and imported, you will get a [[https:// | ||
+ | {{ : | ||
\\ | \\ | ||
\\ | \\ | ||
+ | |||
+ | === Perform a Factory Reset of mSupply Mobile === | ||
+ | To avoid having to manually clear app data (which is sometimes not possible on remote devices), there is a **Factory Reset** option available in the settings menu which will do this for you. After clicking the button, you will be prompted with a warning and dialog to enter your user password (note the warning and be sure you really want to clear everything!): | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | After entering the correct details and clicking **Done**, you will be taken back to the mSupply mobile initialisation page, where you will be required to re-initialise the tablet. See [[https:// | ||
+ | |||
+ | === Check Connection === | ||
+ | <WRAP center round important 60%> | ||
+ | This functionality is available from mSupply mobile v8.1.0 onwards | ||
+ | </ | ||
+ | This feature provides a quick and easy way of verifying that the tablet has connectivity established with mSupply Desktop. This is particularly useful after updating the **Sync URL** or **Sync Password**. Simply click the **Check Connection** button. If the connection is all good, you will get a [[https:// | ||
+ | {{ : | ||
+ | |||
+ | If there are any problems (some examples include: incorrect URL, incorrect password, or no internet) the notification will instead have a description of the error, e.g. //Unable to connect// or //Invalid username or password// | ||
+ | |||
+ | |||
| // | | // |