User Roles

Target release	3.1
Epic	OLMIS-2706 - Getting issue details... STATUS OLMIS-2707 - Getting issue details... STATUS
Document status	DONE
Document owner	Sam Im (Deactivated)
Technical Lead

Goals

The goal of this requirements page is to document the feature of User Roles and the associated user stories. User Roles is defined as enabling the administrator to create and manage roles so that new or existing users can be assigned roles that enable and restrict access.
- Scope: This feature includes stories on:
  - Viewing existing roles and the rights assigned to them.
  - Editing existing roles and the rights assigned to them.
  - Creating a new role and assigning rights.
  - Assigning a role to a user.
    - Assigning a Supervision Role
      - Home Facility
      - Supervisory Node
    - Assigning a Fulfillment Role (create stub - compare to 2190)
    - Assigning an Admin Role
    - Assigning a Reporting Role (create stub - compare to 2190)

Background

Version 2 used the following screens to manage the role assignment

View existing roles. Select "Add role"

then you see this screen to select rights for the role →

Then you assign roles to a user through the user profile screen :

role assignment happened for "Home Facility", "Supervisory", "Order Fulfillment", "Delivery Zones", "Admin and General Operations", "Custom Reports", "Report Viewing"

Assumptions

The initial set of users and role assignments will happen during setup through a batch upload process

User Stories

#	Title	User Story	Importance	Notes	JIRA Tickets
1	View roles	As an administrator I need to view roles and rights so that I have an overview of existing roles. Acceptance Criteria: Create view that lists all existing roles in 3.0 and their associated rights.	Must Have	UI screens based on 2.0 design Viewing affected # of users is out of scope for this story, may be future implementation.	OLMIS-2188 - Getting issue details... STATUS
2	Edit roles	As an administrator I need to edit roles and rights so that I can configure roles for users. Acceptance Criteria: Admin can select existing role to edit. When role is selected to edit, only the associated rights are visible. (2.0 Design shows all rights for all roles.)	Must Have	Individual roles cannot be a mix of rights.	OLMIS-2215 - Getting issue details... STATUS
3	Create new roles	As an administrator I need to create new roles so that I can configure roles for users that do not fit the default roles. Acceptance Criteria: Admin can create a new role and assign to users.	Nice to Have	This may be done in a later release. Similar screens to 2.0 design	OLMIS-2189 - Getting issue details... STATUS
4	Assign roles to users	As an administrator I need to assign roles to users so that they can complete actions within the system based on their roles. Acceptance Criteria: Once role has been created, Admin can go to the User search to select a user. Admin must select the user to edit, and in the User details section they can select Roles to assign Admin must select role type (Supervision, Admin & General Operations, etc) and then assign the program and/or role.	Must Have	A modal where the admin can search and select multiple users to assign a role once it's been created is out of scope.	OLMIS-2190 - Getting issue details... STATUS
5	Add/Edit Supervision roles	As an administrator I want to add or edit Supervision roles so that I can configure user roles. Acceptance Criteria: Admin can create new Supervision roles so they can get assigned to users. Admin can view and edit existing Supervision roles.	Must Have	Similar screens to 2.0 design	OLMIS-2281 - Getting issue details... STATUS OLMIS-2332 - Getting issue details... STATUS

Diagrams

Admin can view existing roles (done)

Admin can create new roles (done)

Admin can assign roles to users (also enables supervision over multiple facilities) (in progress OLMIS-2190)

need better flow for this scenario

Admin can assign/edit Supervision roles to a Home Facility (OLMIS-2281)

Admin can create new Supervisory Nodes

Open Questions

Below is a list of questions to be addressed as a result of this requirements document:

Question	Outcome

Out of Scope

Delete existing roles

OpenLMIS