Adding roles to System

Overview

Roles define the permissions of a user to perform a group of tasks. For example for a Trade License application initiate, forward, approve or payment are tasks which requires permission.
User assigned with role Citizen or Counter Employee can perform initiation and payment. TL Document Verifier can forward the application and only user assigned with role named TLApprover can approve application.

Pre-requisites

Before proceeding with the configuration, make sure the following pre-requisites are met -

Knowledge of DIGIT applications is required.
User should be aware of transactional steps in the DIGIT application.
Knowledge of json and how to write a json is required.
Knowledge of MDMS is required.
User with permissions to edit the git repository where MDMS data is configured.

Key Functionalities

With Roles, permission to perform certain task can be restricted based on the requirement.
For example Only user with Role TLApprover can approve the Trade License initiated application.
While creating employee in system from HRMS Admin, the roles can be assigned to the employees based on the requirement. The roles added in mdms will show for “roles drop down” in employee create screen.
In digit system workflow for a module can be implemented based on roles. For example for Trade License module a Trade License application work flows as per the role is like:
CounterEmployee/Citizen>TLDocVerifier>TLApprover>CounterEmployee/Citizen
Trade License application workflow based on roles:

S.No.	Role	Workflow in Trade License

S.No.	Role	Workflow in Trade License
1	CounterEmployee	Initiates the TL application for Citizen from counter. Initiated TL application goes to TLDocVerifier inbox.
2	Citizen	Initiates the TL application. Initiated TL application goes to TLDocVerifier inbox.
3	TLDocVerifier	User with role TLDocVerifier can forward or reject the TL application after verifying the initiated application. Rejected application shows for re-submission in initiator inbox. Forwarded application goes to TLApprover inbox.
4	TLApprover	TLApprover can approve or reject based on the requirement. Rejected application goes back to TLDocVerifer for re-verification. Approved application shows for payment pending in initiator inbox.
5	CounterEmployee	Once the initiated application is approved by the user with role TLApprover, CounterEmployee can do the payment and download the receipt.
6	Citizen	Once the initiated application is approved by the user with role TLApprover, Citizen can do the payment and download the receipt.

Deployment Details

After adding the new role, the MDMS service needs to be restarted to read the newly added data.

Configuration Details

Roles are added in roles.json
In MDMS, file roles.json, under ACCESSCONTROL-ROLES folder roles are added.
Sample roles:
{ "tenantId": "uk", "moduleName": "ACCESSCONTROL-ROLES", "roles": [ { "code": "CITIZEN", "name": "Citizen", "description": "Citizen who can raise complaint" }, { "code": "TL_CEMP", "name": "TL Counter Employee", "description": "Who has a access to Trade License Services" }, { "code": "TL_DOC_VERIFIER", "name": "Trade License Document verifier", "description": "Trade License Document verifier" }, { "code": "TL_APPROVER", "name": "TL Approver", "description": "Who has a access to Trade License Workflow" } ] }
Role is added as an array element under the array named “roles”.
Each role is defined with three key-value pairs. keys are “code”, ”name” and “description”.

Sr. No.	key	Data Type	Data Size	Is Mandatory?	Definition/ Description

Sr. No.	key	Data Type	Data Size	Is Mandatory?	Definition/ Description
1	code	Alphanumeric	64	Yes	A unique code that identifies the user role name.
2	name	Text	256	Yes	The Name indicates the User Role, while creating a employee a role can be assigned to a individual employee.
3	description	Text	256	No	A short narration provided to the user role name.

4. Localization need to be pushed for all the roles added in roles.json
Sample Localization for roles :
In English:

 {
  "code": "ACCESSCONTROL_ROLES_ROLES_TL_CEMP",  // <"ACCESSCONTROL_ROLES_ROLES_" should be appended before role code>
  "message": "TL Counter Employee",             // English Value to be shown in UI
  "module": "rainmaker-common",                 // module is added with rainmaker-common
  "locale": "en_IN"                             // English language key
}

In Hindi:

{
  "code": "ACCESSCONTROL_ROLES_ROLES_TL_CEMP",  // <"ACCESSCONTROL_ROLES_ROLES_" should be appended before role code>
  "message": "टीएल काउंटर कर्मचारी",               // Hindi value to be shown in UI
  "module": "rainmaker-common",                // module is added with rainmaker-common
  "locale": "hi_IN"                            // Hindi language key
}

Note:

code "code": "ACCESSCONTROL_ROLES_ROLES_TL_CEMP", is the localization key for role. The key has three parts:
a) ACCESSCONTROL_ROLES : It is folder and module name of MDMS, file roles.json in which roles are added. Hypen (- ) in name "ACCESSCONTROL-ROLES" is replaced with underscore ( _ ).
b) ROLES : It is the role.json file name and array name under which roles as array elements are added.
c)TL_CEMP : It is the unique role code.
If localization is not pushed for the roles then key will appear in UI.

Reference Docs

Doc Links

Title	Link
Sample roles.json	https://github.com/egovernments/ukd-mdms-data/blob/SDC/data/uk/ACCESSCONTROL-ROLES/roles.json
Reference link	User Roles