en:mobile:user_guide:getting_started

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
en:mobile:user_guide:getting_started [2021/05/26 01:12] – [Initialisations] Mark Gloveren:mobile:user_guide:getting_started [2022/01/21 01:12] (current) – [Sync] Mark Glover
Line 15: Line 15:
   * mSupply may be able to work on older versions of Android, but, for ease of management, **Android 6** is the lowest acceptable version.  Enrollment and management is even less error prone with **Android 9+**.   * mSupply may be able to work on older versions of Android, but, for ease of management, **Android 6** is the lowest acceptable version.  Enrollment and management is even less error prone with **Android 9+**.
   * Android 9 was released in August 6, 2018.  Why would you be installing hardware that is already several years closer to it's end of service life?   * Android 9 was released in August 6, 2018.  Why would you be installing hardware that is already several years closer to it's end of service life?
-=== Minimum specifications ===+ 
 +=== Hardware === 
 + 
 +== Minimum specifications == 
   * Minimum display size: **9.8 inches** (measured diagonally)      * Minimum display size: **9.8 inches** (measured diagonally)   
   * Minimum display resolution: **768 × 1024 pixels**   * Minimum display resolution: **768 × 1024 pixels**
   * Android Version: **6.0**   * Android Version: **6.0**
 +
 +But, if the operator's eyesight may be poor, or you will ever be wanting to monitor a fridge at the facility for very little extra cost, consider the...
 +
 +== Recommended specification ==
  
 If [[en:mobile:user_guide:vaccine|mSupply Vaccine]] or mSupply ColdChain are to be used on the device at any point, the following are required minimum specifications: If [[en:mobile:user_guide:vaccine|mSupply Vaccine]] or mSupply ColdChain are to be used on the device at any point, the following are required minimum specifications:
Line 27: Line 35:
 The device must also be compatible with MDM (Mobile Device Management) software and support google services.  Please contact [[https://sussol.net/contact|Sustainable Solutions]] or [[https://msupply.foundation/#contact|mSupply Foundation]] for details.   The device must also be compatible with MDM (Mobile Device Management) software and support google services.  Please contact [[https://sussol.net/contact|Sustainable Solutions]] or [[https://msupply.foundation/#contact|mSupply Foundation]] for details.  
  
-  +== Processor and RAM ==
-=== Recommended Specifications ===+
  
 These recommended specifications will allow mSupply Mobile to operate well on the device. These recommended specifications will allow mSupply Mobile to operate well on the device.
-  * **1.5 Gb** Ram+  * **1.5 Gb** RAM
   * Quad-core 1.3 GHz   * Quad-core 1.3 GHz
  
 === How will it connect to the internet? === === How will it connect to the internet? ===
 +
 The most challenging aspect of any remote data recording solution is management of the internet connection.    It may be worth procuring devices that are **mobile data enabled (3G minimum)**, at least to allow future flexibility.  But that doesn't answer the harder questions: The most challenging aspect of any remote data recording solution is management of the internet connection.    It may be worth procuring devices that are **mobile data enabled (3G minimum)**, at least to allow future flexibility.  But that doesn't answer the harder questions:
   * Who is responsible for keeping the device connected?   * Who is responsible for keeping the device connected?
Line 51: Line 59:
  
 </WRAP> </WRAP>
 +==== Configuration on the mSupply Server ====
 +Before using mSupply Mobile, the mSupply central server needs to be configured for it - refer to [[https://docs.msupply.org.nz/faq:what_do_i_need_to_setup_msupply_mobile_on_a_tablet|the mSupply User Guide]] for details.
  
-==== Installation ==== +<WRAP center round important> 
-You can download the latest version of mSupply Mobile from GitHub [[https://github.com/openmsupply/mobile/releases|here]] +If you are upgrading an existing mSupply Mobile device to version 2.0.0, there are a few changes that need to be made to your mSupply Desktop/Server:
- +
-If you are upgrading to mSupply Mobile version 2.0.0, there are a few changes that need to be made to your mSupply Desktop/Server:+
   * Upgrade to mSupply Server v3.83 or higher   * Upgrade to mSupply Server v3.83 or higher
   * Set Visibility for Supplying Stores (including main Supplying Store)   * Set Visibility for Supplying Stores (including main Supplying Store)
   * Add a new Supplier as facility (External Supplier) and make it visible in mobile store   * Add a new Supplier as facility (External Supplier) and make it visible in mobile store
   * Set all other mobile/desktop stores that current mobile store needs to interact with (send/receive Requisition, send/receive Invoices) as 'transfers' in store/synchroniser (this needs to be done by your mSupply team)   * Set all other mobile/desktop stores that current mobile store needs to interact with (send/receive Requisition, send/receive Invoices) as 'transfers' in store/synchroniser (this needs to be done by your mSupply team)
- 
-==== Initialisations ==== 
-The mSupply Mobile app needs to be installed on your tablet. Once it is started, you need to enter the 'site' credentials (user name and password) and the URL for the mSupply server that will hold the data generated by the tablet. 
-<WRAP center round important 60%> 
-Be careful to enter the correct credentials here.  If you fail to enter it three times in a row, you will be locked out from trying again for 1 hour! 
 </WRAP> </WRAP>
-  
  
-There is also a little configuration required within mSupply. Refer to [[https://docs.msupply.org.nz/faq:what_do_i_need_to_setup_msupply_mobile_on_a_tablet|the mSupply User Guide]] for details.+==== Installation ==== 
 +You can download the latest version of mSupply Mobile from GitHub [[https://github.com/openmsupply/mobile/releases|here]]
  
-==== OK. Here we go! ==== +==== Connecting to the central server ==== 
-(Check you've initialised your tablet with the site user name and password in the step above first).+After the mSupply Mobile is installed on your tablet and you've started it, you need to enter the 'site' credentials (user name and password) and the URL for the mSupply server that will hold the data generated by the tablet.
  
-This is the login screen. You will be given a user name and password when your tablet computer is installed at your clinic. Your tablet computer can only log in to one facility.+<WRAP center round important 60%> 
 +  * Be careful to enter the correct credentials here.  If you fail to enter it three times in a row, you will be locked out from trying again for 1 hour! 
 +  * Android auto-correct may try to add a space after each word.  This will result in incorrect credentials being entered. 
 +</WRAP> 
  
-The first thing to do is to choose your preferred language by clicking **Language** at the bottom left of your screen. <WRAP clear/>{{ :mobile:chooselanguage2.jpg?nolink |}}<WRAP clear/> +==== Logging in ==== 
-<wrap center round tip> +After the device has synced to the central server you will see the login screen:
-The tablet above is asking for the user name and password for the person that will be operating the store. This user name and password needs to be set on the mSupply server. Refer to [[https://docs.msupply.org.nz/admin:managing_users|Managing Users]] in the mSupply User Guide. +
-</wrap>+
  
-For example, if your first language is Tetum, then you're in luck!<WRAP clear/>+{{ :mobile:chooselanguage2.jpg?nolink |}}
  
-{{ :mobile:language.jpg |}}<WRAP clear/>+=== Selecting the language ===
  
-<WRAP clear/> +  * The first thing to do is to choose your preferred language by clicking **Language** at the bottom left of the screen. For example, if your first language is [[https://en.wikipedia.org/wiki/Tetum_language|Tetum]], then you're in luck! - see [[en:mobile:user_guide:getting_started#tetum|below]].
-<WRAP clear/>+
  
 +{{ :en:mobile:user_guide:pasted:20210803-052945.png?800 }}<WRAP clear/>
  
-Once you have selected the language of your choice, enter your user name and password and click **Login**!  +=== Logging in the user === 
 + 
 +<WRAP center round important 60%> 
 +  * Users need to be configured on the mSupply central server -refer to [[https://docs.msupply.foundation/en:mobile:setup:server_side:users|Setting up the Users to access the store]]. 
 +</WRAP> 
 + 
 +Once you have selected the language of your choice, enter the credentials (user name and password) for the store user and tap **Login**
  
 {{ :mobile:001loginscreen.jpg?350 |}} {{ :mobile:001loginscreen.jpg?350 |}}
-          + 
-          +<WRAP center round important 60%> 
-<wrap info>After 3 minutes of not using the app (either it is in the background, or the app is asleep), you will be logged out.</wrap>+  * Be careful to enter the correct credentials here.  If you fail to enter it three times in a row, you will be locked out from trying again for 1 hour! 
 +  * Android auto-correct may try to add a space after each word.  This will result in incorrect credentials being entered. 
 +</WRAP> 
 + 
 +<WRAP center round info 60%> 
 +After 3 minutes of not using the app (either it is in the background, or the app is asleep), you will be logged out. 
 +</WRAP> 
 + 
 +==== Main screen ====
  
 This brings us to the main screen. We will be returning to the main screen a lot as we use mSupply Mobile, so it's important to understand the main functions. Let's go through them one by one. This brings us to the main screen. We will be returning to the main screen a lot as we use mSupply Mobile, so it's important to understand the main functions. Let's go through them one by one.
Line 99: Line 117:
 {{ :en:mobile:user_guide:004mainscreen.png?600 |}} {{ :en:mobile:user_guide:004mainscreen.png?600 |}}
  
-Red badges indicate there are unfinalised transactions requiring attention. Click a badge for a description. Badges will automatically disappear when there are no unfinalised transactions remaining.+=== Icon badges === 
 + 
 +[[https://www.leanplum.com/blog/what-are-app-icon-badges/|Icon badges]] (orange circle with a number) indicate there are unfinalised transactions requiring attention. Click a badge for a description. Badges will automatically disappear when there are no unfinalised transactions remaining.
  
 {{ :en:mobile:user_guide:mobile_badges.png?600 |}} {{ :en:mobile:user_guide:mobile_badges.png?600 |}}
 +
 +=== Sync ===
 +
 +<WRAP center round tip 60%>
 +  * mSupply Mobile will attempt to sync to the Primary server at regular intervals.
 +  * The default sync interval is 10 minutes.
 +  * The interval between these attempts (the sync interval) can be configured to be from 1 minute to 10 minutes by [[en:mobile:user_guide:mobile_settings#editing_the_sync_interval|Editing the Sync Interval]].
 +</WRAP>
  
 A link on the top right of the screen shows the **Sync Status**. A link on the top right of the screen shows the **Sync Status**.
Line 107: Line 135:
 {{ :mobile:002syncstatus.jpg |}} {{ :mobile:002syncstatus.jpg |}}
  
-Clicking this link will take you to a page where you can choose to do a manual sync if there is internet connectivity.  +Clicking this link will take you to a page where you can choose to do a manual sync if you want to re-sync in-between the automatic syncs.  
  
 {{ :mobile:003manualsync.jpg |}} {{ :mobile:003manualsync.jpg |}}
  
 You can close this page by clicking the cross on the top right. You can close this page by clicking the cross on the top right.
 +
 +=== Settings ===
  
 Users with the appropriate permissions can access the mobile **[[en:mobile:user_guide:mobile_settings|Settings]]** on the bottom right of the screen. Users with the appropriate permissions can access the mobile **[[en:mobile:user_guide:mobile_settings|Settings]]** on the bottom right of the screen.
  
 {{ :en:mobile:user_guide:mobile_settings.png?600 |}} {{ :en:mobile:user_guide:mobile_settings.png?600 |}}
 +
 +=== Logging out ===
  
 To log out, click the **Log Out** button on the bottom left of the screen. To log out, click the **Log Out** button on the bottom left of the screen.
Line 132: Line 164:
  
                                                        
- === Suppliers ===+=== Suppliers ===
  
 {{mobile:suppliers.png?nolink |}} The **Suppliers** area shows orders that you have placed and received for **your own stock**. Usually, you will only have ONE supplier (a medical store or other healthcare facility) and this will be pre-programmed for you.  {{mobile:suppliers.png?nolink |}} The **Suppliers** area shows orders that you have placed and received for **your own stock**. Usually, you will only have ONE supplier (a medical store or other healthcare facility) and this will be pre-programmed for you. 
Line 144: Line 176:
  
  
- === Stock === +=== Stock ===
  
 {{mobile:stock.png?nolink |}} The **Stock** section is used to manage the stock in your store.  {{mobile:stock.png?nolink |}} The **Stock** section is used to manage the stock in your store. 
 <WRAP clear/> <WRAP clear/>
- 
                                                            
 {{:mobile:009currentstockbutton.jpg|}} The **Current Stock** button allows you to easily see how much stock you have on hand (//"How many paracetamol tablets do I have?"//), search for an individual item, or check expiry dates.  {{:mobile:009currentstockbutton.jpg|}} The **Current Stock** button allows you to easily see how much stock you have on hand (//"How many paracetamol tablets do I have?"//), search for an individual item, or check expiry dates. 
- 
  
 {{:mobile:010stocktakesbutton.jpg|}} The **Stocktakes** button allows you to do a stocktake on all items or a small selection of items and shows you a list of all previous stocktakes. You can also use this area to update the stock levels of an item when you realise there is a mistake.                      {{:mobile:010stocktakesbutton.jpg|}} The **Stocktakes** button allows you to do a stocktake on all items or a small selection of items and shows you a list of all previous stocktakes. You can also use this area to update the stock levels of an item when you realise there is a mistake.                     
                                                              
 +==== Tetum ====
  
----- +And here is the main screen in Tetum!
- +
-(And here's the main screen in Tetum!) +
-<WRAP clear/>+
 {{ :mobile:tetum.jpg?700 |}}<WRAP clear/> {{ :mobile:tetum.jpg?700 |}}<WRAP clear/>
-<WRAP clear/> 
  
  
  • en/mobile/user_guide/getting_started.1621991574.txt.gz
  • Last modified: 2021/05/26 01:12
  • by Mark Glover