Objective
The Role management needs to be migrated from the legacy Web Application (Profile menu entry) to the new modular architecture and will be part of the Core module. The Role management, in particular Add/Edit Role screen, should take contributions from the other modules to add additional specific authorities.
Use cases
Web application
UC13-1: Search Role: Role list > enter search criteria > search
UC13-2: Add Role: Role list > add > select the authorities and define name > save
UC13-3: Update Role: Role list > Select Profile > update the authorities and name > save
UC13-4: Replace Role: Role list > Select Profile > update the authorities and name > replace > define replacement date
UC13-5: Remove Role: : Role list > Select Profile > remove > select replacement Role > confirm
UC13-8: Duplicate Role: Role list > Select Profile >duplicate > give the new name and, if required, update authorities > confirm
Backend
UC13-7: propagation of replacing / removing to user
Authority
Roles
Roles
C/R/U/D
Duplicate
Replace
Entities
Already existing:
tblRole
tblRoleRight
Details design
Backend module
Because openIMIS core already have an adapter to read the openIMIS roles and authorities, no business function will be required outside the database updates and Role management.
Mutations
Mutation as part of the schema file:
create roles => CreateRolesMutation
update roles => UpdateRolesMutation
submit roles => SubmitRolesMutation
replace roles => ReplaceRolesMutation
delete roles => DeleteRolesMutation
duplicate roles => DuplicateRolesMutation
Permissions
"gql_query_roles_perms": ["122001"]
"gql_mutation_create_roles_perms": ["122002"]
"gql_mutation_update_roles_perms": ["122003"]
"gql_mutation_replace_roles_perms": ["122006"]
"gql_mutation_duplicate_roles_perms": ["122005"]
"gql_mutation_delete_roles_perms": ["122004"]
"role_print_perms": ["122001"]
Models
The models should be created based on the existing tables.
Services
none
Frontend
The frontend should group the authorities/rights per managing module. In order to do that the two first digits for the authorities/rights code. The authorities contributed from other modules should be grouped with the associated module’s name.
Role search page
The list of roles should use the same layout as other existing list in openIMIS (claims, insuree ...)
Role add/edit page
Ideally when reading or editing a Role, each module will have a "box" containing its authorities/rights. In read mode, the box will appear only if at least one of the authority right is selected. The box should be placed according to the screen size (responsive design).
Open point: Xavier Gillmann (Unlicensed) how to get the string for the rights and module name ? should we use the module configurations json ? will it support standard translation ?
Solution 1 to retrieve the role from other module:
when the mutation “getAvailableRole“ will called then a signal will be sent Signal_get_module_role, the listener of that signal should return a module role definition object
roles = []
Signal_get_module_role()
for signal_listener
roles .amend(signal_listener.return_value)
module role definition object:
module_name: str
module_label = List of ‘lan_code':’display for lang_code'
roles = list of:
'role_name': str
'role_value': int
‘role_label’: List of ‘lan_code':’display for lang_code'