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
admin:managing_users [2026/05/27 14:43] – [Editing permission templates] Gary Willettsadmin:managing_users [2026/09/30 12:56] (current) – [Users and sync] Gary Willetts
Line 12: Line 12:
 ==== Users and sync ==== ==== Users and sync ====
 A few points to remember if you are working with users on a [[synchronisation:introduction|synced system]] and with newer versions of mSupply: A few points to remember if you are working with users on a [[synchronisation:introduction|synced system]] and with newer versions of mSupply:
-  * Users are //normally// created and configured on the Legacy mSupply Central server.  These settings are then copied to remote sites when the store is transferred to the remote site. +  * Users are //normally// created and configured on the Legacy mSupply Central server. These settings are then copied to remote sites when the store is transferred to the remote site. 
-  * //Normally//, when these configuration settings are altered on the Legacy mSupply Central server after a store has been migrated, the settings do not get synced to the remote site.  It is now possible to sync user permission settings across all stores that they have permission to log in to, regardless of which site the store is on (on the Edit user > Login rights tab).  As mSupply is currently configured, this setting defaults to ‘off’, and needs to be turned on every time a user is edited.+  * //Normally//, when these configuration settings are altered on the Legacy mSupply Central server after a store has been migrated, the settings do not get synced to the remote site.  It is now possible to sync user permission settings across all stores that they have permission to log in to, regardless of which site the store is on (on the Edit user > Login rights tab). This setting defaults to ‘off’, and needs to be turned on every time a user is edited. See the [[admin:managing_users#sync_user_across_all_login_stores_checkbox|Sync user across all login stores checkbox]] section for more details.
   * Users can be created and edited on a Legacy mSupply remote site.  Name details of any newly created user on a remote site will sync back to the Legacy mSupply Central server.  This is primarily for the sake of reporting transactions.  Any permission edits made on the remote site will //not// sync back to the Legacy mSupply Central server.   * Users can be created and edited on a Legacy mSupply remote site.  Name details of any newly created user on a remote site will sync back to the Legacy mSupply Central server.  This is primarily for the sake of reporting transactions.  Any permission edits made on the remote site will //not// sync back to the Legacy mSupply Central server.
-  * As of 2025-07-28, users can not be created or permissions edited on [[https://docs.msupply.foundation/mobile/introduction/introduction/|mSupply Mobile (Deprecated)]] or [[https://docs.msupply.foundation/docs/introduction/introduction/|Open mSupply]] sites.+  * Users can not be created or permissions edited on [[https://docs.msupply.foundation/mobile/introduction/introduction/|mSupply Mobile (Deprecated)]] or [[https://docs.msupply.foundation/docs/introduction/introduction/|Open mSupply]] sites.
  
  
  
 ===== Adding and editing users and groups ===== ===== Adding and editing users and groups =====
- 
 User access is managed by choosing **File > Edit users** from the menus, or by choosing **Admin > Edit users** in the Navigator. When clicking on this option you are presented with a list of current users: User access is managed by choosing **File > Edit users** from the menus, or by choosing **Admin > Edit users** in the Navigator. When clicking on this option you are presented with a list of current users:
  
Line 38: Line 37:
   * **Group** The name of the group   * **Group** The name of the group
   * **Active** Checked if the group is active. If the group is active then all users in the group are allowed to login to the system. If the group is inactive (checkbox unchecked), all users in the group are inactive and are not allowed to login to the system.    * **Active** Checked if the group is active. If the group is active then all users in the group are allowed to login to the system. If the group is inactive (checkbox unchecked), all users in the group are inactive and are not allowed to login to the system. 
- 
-To get a list of all current user permissions, click the **Permission Report** button. An Excel spreadsheet will be generated (see {{ :admin:user_permission_report_sample.xlsx |sample}}); it will have one worksheet for each store showing all the users and groups and what permissions they have in that store. 
  
 Double-click a user (or group) to edit their details or delete them. Click the **New User** button to add a new user (or the **New group** button to add a new group). Doing either will open the user details window (described below - for a new user or group all the tabs are empty, for an existing user or group the tabs are filled with their current settings) Double-click a user (or group) to edit their details or delete them. Click the **New User** button to add a new user (or the **New group** button to add a new group). Doing either will open the user details window (described below - for a new user or group all the tabs are empty, for an existing user or group the tabs are filled with their current settings)
  
  
 +=== Reports ===
 +When viewing either groups or users in the list you can different user reports by clicking on the **Reports button**. When you do that a small submenu appears with the following options:
 +
 +  * **Permission report:** produces a report which shows all the permissions the selected (highlighted) user or group has in all stores in the datafile. It looks like this:{{ .:pasted:20260527-150348.png?600 }}
 +  * **User stores report:** produces a report which shows all the stores all the users in the datafile can login to. It looks like this:{{ .:pasted:20260527-150706.png?800 }}
 +
 +As soon as you click on one of the options, the report is generated and opened in your spreadsheet application.
 ===== User details window ===== ===== User details window =====
 <WRAP center round tip 95%> <WRAP center round tip 95%>
Line 238: Line 242:
   * "Supervisor - All stores" stores is a special mode to allow users to view information in and run reports over multiple stores. See [[other_stuff:misc_topics#supervisor_mode_-_all_stores|here]] for more information.   * "Supervisor - All stores" stores is a special mode to allow users to view information in and run reports over multiple stores. See [[other_stuff:misc_topics#supervisor_mode_-_all_stores|here]] for more information.
  
-=== Sync user across all login stores ===+=== Sync user across all login stores checkbox === 
 +This checkbox is only displayed if the user is logged into the primary server in a synchronisation system.
  
-The **Sync user across all login stores** checkbox is only displayed if the user is logged into the primary server in a synchronisation system.  If this checkbox is checked, when the **OK** button is clicked the user's details are synchronised to all the stores that the user is allowed to login to, whichever sites those stores are Active on.  In this way, an administrator in a synchronisation system is able to edit user permissions and settings and have them automatically synchronised to all relevant sites, rather than having to log in remotely to those sites and configure permissions locally.  <WRAP center round tip 60%> +If this checkbox is checked, when the **OK** button is clicked then the user's details, including their permissions (or group membership and group permissions if they are part of a group) and their store login permissions, are synchronised to all the stores that the user is allowed to login to, whichever sites those stores are Active on.
-As you can imagine, **Sync user across all login stores** is a powerful feature, and can have unintended consequences.  Therefore as of 2025-11-04, there are restrictions on who can be configured as a '**special user**'.  Contact [[support@msupply.foundation]] for assistance. +
-</WRAP>+
  
 +In this way, an administrator in a synchronisation system is able to edit user permissions and settings centrally and have them automatically synchronised to all relevant sites, rather than having to log in remotely to those sites and configure permissions locally.
  
-<WRAP center round important 60%> +As you can imagine, this is a powerful feature and can have unintended consequences so be careful when using it!
-**Sync user across all login stores** will propagate: +
-  * Group permissions +
-  * User group membership (which group the user is a member of)  +
-  * User permissions, if the user is not a member of a group +
-  * User store login permissions+
  
-**Sync user across all login stores** will <wrap em>NOT</wrap> propagate: +<WRAP center round important 60%> 
-  * User deletion +**Sync user across all login stores** will <wrap em>NOT</wrap> propagate user or group deletion to remote sites. 
-  * Group deletion+
  
-Deleting the user or group on remote sites must be carried out by either of: +Deleting a user or group on remote sites can only be done by manually logging in to those sites and editing the users or groups there (or, if really necessary, by execution of custom code on the central server that will propagate these changes.  Contact [[support@msupply.foundation]] for assistance with that). 
-  * Manually logging in to those sites and editing users, or +
-  * Development and execution of custom 'footrunner' code on the Central server that will propagate these changes.  Contact [[support@msupply.foundation]] for assistance. +
 </WRAP> </WRAP>
  
Line 387: Line 383:
 Your own templates are created as user group permission reports which you then load into a user's permissions. To do this, follow these steps: Your own templates are created as user group permission reports which you then load into a user's permissions. To do this, follow these steps:
  
-  - Create a user group which has the permissions you require set on the //Permissions//, //Permissions (2)//, //Permissions (3)// and //Open mSupply permissions// tabs (see the  section above for instructions how to do this)+  - Create a user group which has the permissions you require as a template set on the //Permissions//, //Permissions (2)//, //Permissions (3)// and //Open mSupply permissions// tabs (see the [[admin:managing_users#user_groups|User groups]] section above for instructions on how to do this) 
 +  - View the list of user groups (see the [[admin:managing_users#adding_and_editing_users_and_groups|Adding and editing users and groups]] section above for instructions on how to do this) 
 +  - Run a Permission report for that group (see the [[admin:managing_users#reports|Reports]] section above for instructions on how to do this) 
 +  - Save the report as a ''.csv'' file from your spreadsheet application 
 +  - Now create or edit the user to which you want to apply these permissions to (double-click it in the list of users) 
 +  - Click on the //Permissions//, //Permissions (2)//, //Permissions (3)// or //Open mSupply permissions// tab and select the store you want to set tyhte permissions for in the **Store** drop-down list in the top right corner of the window. 
 +  - Hold down the //Shift// key on the keyboard and click on the **User permissions template** button at the bottom of the screen 
 +  - A file selection window will appear. Navigate to the csv file you saved in step 4 above, select it and click on the **Open** button 
 +  - The user template selection window will open with only one entry in the table. The entry has the name of the group you ran the permissions report for in step 3. Select that entry and click on the **OK** button 
 +  - The user permissions for all the tabs are loaded from the file and you see them set in the user's details window 
 +  - You can further edit these permissions if you wish or copy them to other stores (using the **Copy** button at the bottom of the window). When you are finished, click on the **OK** button on the user details window to save the permissions 
 =====  User license categories ===== =====  User license categories =====
  
  • Last modified: 2026/05/27 14:43
  • by Gary Willetts