| Both sides previous revision Previous revision Next revision | Previous revision |
| admin:managing_users [2026/05/27 15:16] – [Using your own permission templates] Gary Willetts | admin:managing_users [2026/09/30 12:56] (current) – [Users and sync] Gary Willetts |
|---|
| ==== 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. |
| |
| |
| * "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. |
| | |
| | As you can imagine, this is a powerful feature and can have unintended consequences so be careful when using it! |
| |
| <WRAP center round important 60%> | <WRAP center round important 60%> |
| **Sync user across all login stores** will propagate: | **Sync user across all login stores** will <wrap em>NOT</wrap> propagate user or group deletion to remote sites. |
| * 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: | |
| * User deletion | |
| * 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> |
| |
| |
| - 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) | - 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 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) | - 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 | - 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 ===== |
| |