Differences

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

--- en:mobile:setup:server_side [2020/02/03 02:22] – ↷ Links adapted because of a move operation lou_lomas
+++ en:mobile:setup:server_side [2020/03/01 23:28] (current) – lou_lomas
@@ Line 1: / Line 1: @@
-{{indexmenu_n>30}}
+{{indexmenu_n>10}}
-====== Setting up mSupply Mobile - Server side ======
+{{:mobile_250.png?nolink  |}} \\ \\
-<WRAP center round tip 60%>
+====== Setting up the server ======
+\\
+<WRAP center round tip 80%>
 The following details the steps of setting up mSupply from your organisation's mSupply Server\\
@@ Line 7: / Line 9: @@
 </WRAP>
-<WRAP center round info 60%>
-As of 2019-10-24, this process is largely manual, with sync sites and stores needing to be created by an operator, one-by-one with a few small bits of code to make some of these processes quicker and more reliable.  There is a plan to develop a tool by which virtually all of the process can be automated.  Even with such a tool, //at least// the following information will need to provided manually:
-  * Store name
-  * Customer name from which the store is being created (normally the case)
-  * Item master list controlling visibility for the store
-</WRAP>
+{{indexmenu>en:mobile:setup:server_side#1|tsort msort}}
-===== Requirements =====
-  * A server running mSupply with a web server license registered
-  * Sync server has a static IP and any network permissions required configured
-  * A mobile tablet fitting the recommended specifications [[en:mobile:user_guide|here]]
-===== General approach =====
-**EACH** mobile store needs to have these:
+\\ \\
+|  //Return to [[en:mobile:setup:|]]//  |
-  - [[en:mobile:setup:server_side#create_sync_site|Create sync site]]
-  - [[en:mobile:setup:server_side#create_store_that_will_be_operated_on_the_mobile_device|Create and configure store]]
-  - [[en:mobile:setup:server_side#setting_up_user_access_on_the_primary_server|Create User(s) to access the stores.]]
-<WRAP center round alert>
-If the stores being created from existing customers in an existing mSupply system, then an additional step needs to be carried out:  [[https://docs.msupply.org.nz/names:merging_names|Merge the existing customer name with the new store]].  There is some footrunner code that can facilitate this for multiple sites - see [[en:mobile:setup:server_side#create_store_from_existing_customer_name_using_store_create_from_name|2. Create store from existing customer name using store_create_from_name]], below.
-<wrap em>However</wrap>, Any unfinalised CIs from supplying stores to these existing customers need to be finalised first.  On a system with supplying stores on multiple sync sites, this can take a long time.  Start early, and if possible, ask the supplying stores to refrain from creating new CIs until the merging is done...
-If you try to do the merge before finalising unfinalised customer invoices, you will get an error message, and as that message indicates, the merge will not proceed:
-{{ :en:mobile:pasted:20200116-222550.png }}
-</WRAP>
-===== Create Sync Site =====
-The first step is to create the sync site that the store will be 'Active' on.
-<WRAP center round info 60%>
-As of 2019-10-24, this process is manual, with sync sites needing to be created by an operator, one-by-one.</WRAP>
-  - Got to Admin > Preferences{{ :mobile:mob2_007.jpg?600 |}}
-  - On the Synchronise tab on the left-hand side and click on the unlock button and enter the password{{ :mobile:mob2_008.jpg?600 |}}
-  - Add new Sync Site{{:mobile:mob2_009.jpg|}}
-  - Enter **Sync ID**, **User name** and **Password**.  Note that **URL** and **Hardware ID** are not required.{{ :en:mobile:mob2_010.png |}}
-  - Click **OK**<WRAP center round alert>
-  * Keep track of the password!  If it is lost you'll have to resynchronise from scratch!
-  * Sussol will typically have them securely stored if Sussol has done the sync setup.
-</WRAP>
-===== Create and configure store that will be operated on the mobile device =====
-After the sync sites have been set up, there are three approaches to creating and configuring the store that will operated on that site.
-<WRAP center round tip>
-  * This can be done 'manually' as described in the first method below.  This method is suitable if you are creating only a handful of stores.
-  * If you are creating a larger number of stores, then it is more appropriate to use one or both of the two footrunner code methods.  As of 2019-10-24 there are two pieces of footrunner code that can expedite this process - see [[https://sussol.net/wiki/doku.php/msupply:specifications:admin:sync#creating_data_files_for_multiple_new_remote_sites|Creating data files for multiple new remote sites]].  They can **//not//** be used together for the same store, but it may be appropriate to use [[https://sussol.net/wiki/doku.php/msupply:specifications:admin:sync#store_create_from_name|store_create_from_name]] for creation of one store, and then use [[https://sussol.net/wiki/doku.php/msupply:specifications:admin:sync#sync_clone_sync_site|sync_clone_sync_site]] to create subsequent stores.
-</WRAP>
-==== 1.  Manually create store ====
-  - On mSupply desktop go to **Special > Stores > New Store**{{ :mobile:mob2_001.jpg?600 |}}{{ :mobile:newstore.jpg |}}
-  - Enter the Store Code and the Store Name{{ :mobile:mob2_002.jpg |}}<WRAP center round important 60%>
-  * The Store Code can not include spaces
-  * The Store Name needs to be something that users will recognise.\\  ''Mobile Store 1'' is not likely to be a good name to use. ;-)
-</WRAP>
-  - [[en:mobile:setup:server_side#making_items_visible_to_the_new_store_according_to_a_master_list|Configure items visibility for the store]]
-  - [[en:mobile:setup:server_side#setting_up_correct_synchronisation_settings|Configure synchronisation settings]]
-  - [[en:mobile:setup:server_side#configure_visibility_to_other_stores|Configure store visibility to other stores]]
-==== 2. Create store from existing customer name using store_create_from_name ====
-Use the footrunner code [[https://sussol.net/wiki/doku.php/msupply:specifications:admin:sync#store_create_from_name|store_create_from_name]].  This method is only useful if you already have a customer and you want to convert it to a store.
-  - Run ''store_create_from_name'' to clone the original store.  You will need to provide:
-    - Name **ID** (not name **Code** :-() to create the store for (must not be blank or already a store)
-    - Store mode for new store (one of ''store'', ''dispensary'' or ''report'').  Almost always, this should be ''store''
-    - Sync ID for site on which the new store will be Active (optional; if left blank, will default to the current site ID)
-  - [[en:mobile:setup:server_side#making_items_visible_to_the_new_store_according_to_a_master_list|Configure items visibility for the store]]
-  - [[en:mobile:setup:server_side#setting_up_correct_synchronisation_settings|Configure synchronisation settings]]
-  - [[en:mobile:setup:server_side#configure_visibility_to_other_stores|Configure store visibility to other stores]]
-==== 3. Create store by cloning another sync store using sync_clone_sync_site ====
-Use the footrunner code [[https://sussol.net/wiki/doku.php/msupply:specifications:admin:sync#sync_clone_sync_site|sync_clone_sync_site]].  Under this method:
-  - Manually create and appropriately configure a single store.
-  - Make //**sure**// the relevant sync sites have been created (above) and then, for **EACH** store:
-  - Run ''sync_clone_sync_site'' to clone the original store.  You will need to provide:
-    - Sync ID for source sync site
-    - Sync ID for clone sync site
-    - sync version (v1 for desktop, v3 for mobile)
-    - Decision on whether the cloned store will have 'group' store visibility (visible to all other stores with the same supplying store) or not
-    - Decision on whether to also clone locations, transactions, stock, requisitions.  (almost always **NO**!)
-    - new **store** code //and// name for each cloned store
-    - new **user** name //and// password for the each cloned store's default user
-  - If there are actually existing customers for each of these stores, you will need to [[https://docs.msupply.org.nz/names:merging_names|merge the existing customer name with the new store]]
-  - The store will have the same item visibility configuration as the store that has been cloned.  Review, and if necessary, [[en:mobile:setup:server_side#making_items_visible_to_the_new_store_according_to_a_master_list|Configure items visibility for the store]]
-  - The store will have the correct 'basic' sync settings.  Review, and if necessary, [[en:mobile:setup:server_side#setting_up_correct_synchronisation_settings|Configure synchronisation settings]]
-  - The store will have the correct 'basic' store visiblity settings, including, if you have selected it, 'group' store visibility.  Review, and if necessary, [[en:mobile:setup:server_side#configure_visibility_to_other_stores|Configure store visibility to other stores]]
-==== Making items visible to the new store according to a Master List ====
-  - Click on the **Master Lists** tab and select at least one Master List.{{ :mobile:mob2_003.jpg |}}
-  - Click **OK**
-  - Click **OK** again
-==== Setting up correct synchronisation settings ====
-<WRAP center round tip>
-If you have used [[https://sussol.net/wiki/doku.php/msupply:specifications:admin:sync#store_create_from_name|store_create_from_name]] for creation of the store, and you have specified the sync site that the store will be **Active** on, then all you need to do here is:
-  * Change the Synchronisation type for this store on the Primary Server to **Collector** if so desired (normally the case)
-  * Configure this new store's Sync type to be **Transfer** or **Active/Collector** for any //other// sync sites that need to deal with this store.
-</WRAP>
-  - Edit store synchronisation settings (**Special > Show Stores >** Double-click on store **> Synchronisation > Click to Unlock**, enter code to edit):
-  - In the table below, in row of the Sync site that was created for this store, tick the tickbox in the **Local** column.  This will automatically change the Sync type for that site to ''Active/Collector''.{{ :mobile:mob2_011.jpg?600 |}}
-  - Set **Synchronisation type** at the top to ''Collector''
-  - Click **OK**
-==== Configure visibility to other stores ====
-  - Edit the 'name' associated with the store and configure visibility to other stores appropriately
-===== Setting up User Access to the store =====
-<WRAP center round tip 60%>
-Unlike mSupply Desktop, mSupply Mobile does not need or use individual user permissions for the various activities within the store.  All that is required is for the user to have login rights to the store.
-</WRAP>
-==== Setting up Store User Access ====
-<WRAP center round important 60%>
-This step has already been carried out if you have used method [[en:mobile:setup:server_side#create_store_by_cloning_another_sync_store_using_sync_clone_sync_site|3. Create the store by cloning another sync store using sync_clone_sync_site]].  Don't do it again!
-</WRAP>
-At least one store user needs to be set up to have have access to the new store on the Primary server.  Even though the user will access the store from the device, their credentials need to be set up on the Primary server - refer [[http://docs.msupply.org.nz/admin:managing_users|managing users]].
-<WRAP center round tip 60%>
-For convenience when using a tablet:
-  * Only use lower-case letters for both username and password
-  * Consider using short usernames and passwords
-</WRAP>
-==== Setting up admin User Access ====
-At least one admin user needs to be set up to have have access to the new store on the Primary server.  This user will normally be the ''Sussol'' user that has set up the new store, but there could well be other local administrators that need access.
-  - Go to **Admin > Edit Users**{{ :mobile:mob2_004.jpg?600 |}}
-  - Select the user and go to **Login Rights**{{ :mobile:mob2_005.jpg?600 |}}
-  - Select the new Store
-  - Click **OK**
-===== Verify that the store is working =====
-  - On the Primary server, log in to the Store (**File > Switch**) (or ‘cmd 2’ (apple) or ‘ctrl 2’ (windows)){{ :mobile:mob2_006.jpg |}}
-  - Check that the right items are visible
-==== Start the web server ====
-Sync will not start until you have started the [[https://docs.msupply.org.nz/web_interface:using_the_web_server|web server]]!
-=== Related Links ===
-  * [[en:mobile:user_guide|mSupply mobile user guide]]
-\\
-\\
-|  //Return to:  [[mobile:|mSupply Mobile Home page]]//  |