Roles and permissions - global-121/121-platform GitHub Wiki

This page contains an overview of the Roles and their related Permissions. A User can have multiple Roles. See Actors for the types of Users.

The following roles will be created by default:

Role Description
Admin System administrator
Program Admin Program Administrator, responsible for overall program management
Cva Manager Manager for Cash and Voucher Assistance (CVA)
Cva Officer Officer for Cash and Voucher Assistance (CVA)
Finance Manager Manager for Finance operations
Finance Officer Officer for Finance operations
View Portal Users who are allowed to view only and cannot perform any actions
Kobo User Users who interact with Kobo

Available features in 121-system

  • Below is a list of features in 121, divided by interface and page and their corresponding permissions and default roles access.
  • Underneath that is a list of all available permissions in 121, including a more detailed description.
  • NOTE: The system administrator role is omitted in the overviews because it has all permissions mentioned.

Features in 121 Portal

Dashboard
Features Permission ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
See data in table ProgramMetricsREAD v v v v v v
Aidworkers
Features Permission(s) ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
See program team AidWorkerProgramREAD v v
Add/edit team members AidWorkerProgramUPDATE v v
Design
Features Permission(s) ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
See program details ProgramMetricsREAD v v v v v v
Open for registration ProgramPhaseUPDATE v v
Registration & Validation
Features Permission(s) ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
Create PAs RegistrationCREATE v v v v
Import registrations RegistrationImportTemplateREAD v v v
Export PAs RegistrationPersonalEXPORT v v v
Move to inclusion ProgramPhaseUPDATE v
Change Allow new registrations ProgramUPDATE v
Invite for registration RegistrationStatusInvitedUPDATE v v v
Mark as no longer eligible RegistrationStatusNoLongerEligibleUPDATE v v v
Mark as validated RegistrationStatusMarkAsValidatedUPDATE v v v
Mark as declined RegistrationStatusMarkAsDeclinedUPDATE v v v
Send message to PAs RegistrationNotificationCREATE v v v
Delete PA RegistrationDELETE v
See PA table RegistrationREAD v v v v v v
Open detailed info per PA popup RegistrationPersonalREAD v v v v v v
Change PA custom attributes RegistrationAttributeUPDATE v v
Change PA finance details from popup RegistrationAttributeFinancialUPDATE v v
Change PA details from popup RegistrationPersonalUPDATE v v
Inclusion
Features Permission(s) ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
Export inclusion list RegistrationPersonalEXPORT v v v
Include in program RegistrationStatusIncludedUPDATE v v
Reject from program RegistrationStatusRejectedUPDATE v v v
Send message to PAs RegistrationNotificationCREATE v v v
See PA table RegistrationREAD v v v v v v
See PA table incl. PII RegistrationPersonalREAD v v v v v v
Change PA custom attributes RegistrationAttributeUPDATE v v v
Change PA details from popup RegistrationPersonalUPDATE v v v
Move to payment ProgramPhaseUPDATE v v
Payment
Features Permission(s) ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
See payment data PaymentTransactionREAD v v v v v v
End inclusion in program RegistrationStatusInclusionEndedUPDATE v v
Reject from program RegistrationStatusRejectedUPDATE v v
Send message to PAs RegistrationNotificationCREATE v v
Export Report RegistrationPersonalEXPORT v v
Payment READ PaymentREAD v v v v v
Do payment PaymentCREATE
See PA table RegistrationREAD v v v v v
See PA table incl. PII RegistrationPersonalREAD v v v v v
Change PA custom attributes RegistrationAttributeUPDATE v v
Change PA details from popup RegistrationPersonalUPDATE v v
Move to evaluation ProgramPhaseUPDATE v
Evaluation

N.A.

PA Profile page
Features Permission(s) ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
See personal data RegistrationPersonalREAD v v v v v v
Add note RegistrationPersonalUPDATE v v v
Change PA details from popup RegistrationAttributeUPDATE v v v
Change PA finance details from popup RegistrationAttributeFinancialUPDATE v v
See payment data PaymentREAD, PaymentTransactionREAD v v v v v v
See debit card data PaymentREAD, PaymentTransactionREAD, FspDebitCardREAD v v v v v v
Pause debit card FspDebitCardBLOCK v v v v v
Unpause debit card FspDebitCardUNBLOCK v v v v
Issue new debit card FspDebitCardCREATE v

Features in Aid Worker App

Validation
Features Permission(s) ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
Download validation data RegistrationPersonalForValidationREAD v v v
Find PA by phonenumber RegistrationPersonalForValidationREAD v v v
Upload validation data RegistrationPersonalUPDATE, RegistrationAttributeUPDATE v v v
Account
Features Permission(s) ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
Change password N.A. v

Features for functions called via API

Features Permission(s) ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
Create User AidworkerCREATE v
Export monitoring data ProgramMetricsREAD v v v v v v
Update program questions ProgramQuestionUPDATE v
Update custom attributes ProgramCustomAttributeUPDATE v

All available permissions in 121-system

Below this table, you can find a description per permission

Permission ProgramAdmin View KoboUser CvaManager CvaOfficer FinanceManager FinanceOfficer
ProgramUPDATE v v
ProgramPhaseUPDATE v v
ProgramQuestionUPDATE v
ProgramQuestionDELETE v
ProgramCustomAttributeUPDATE v
ProgramMetricsREAD v v v v v v
PaymentREAD v v v v v v
PaymentCREATE v
PaymentFspInstructionREAD v
PaymentTransactionREAD v v v v v v
PaymentVoucherREAD v v v v v v
FspDebitCardREAD v v v v v v
FspDebitCardBLOCK v v v v v
FspDebitCardUNBLOCK v v v v
FspDebitCardCREATE v
FspDebitCardEXPORT v
RegistrationREAD v v v v v v
RegistrationCREATE v v v v
RegistrationDELETE v v
RegistrationAttributeUPDATE v v v
RegistrationAttributeFinancialUPDATE v v
RegistrationFspUPDATE v
RegistrationNotificationREAD v v v v
RegistrationNotificationCREATE v v v
RegistrationPersonalREAD v v v v v v
RegistrationPersonalForValidationREAD v v v
RegistrationPersonalEXPORT v v v
RegistrationPersonalUPDATE v v v
RegistrationStatusMarkAsValidatedUPDATE v v v
RegistrationStatusMarkAsDeclinedUPDATE v v v
RegistrationStatusNoLongerEligibleUPDATE v v v
RegistrationStatusIncludedUPDATE v v
RegistrationStatusRejectedUPDATE v v v
RegistrationStatusInclusionEndedUPDATE v v v
RegistrationStatusInvitedUPDATE v v v
RegistrationStatusPausedUPDATE v v v
RegistrationImportTemplateREAD v v v
ActionREAD v v v v v v
ActionCREATE v
AidWorkerProgramREAD v v
AidWorkerProgramUPDATE v v

Programs

  • ProgramUPDATE: Update a program
  • ProgramPhaseUPDATE: Update specific phase of program. (For example: Move to next phase)
  • ProgramQuestionUPDATE: Update program questions
  • ProgramQuestionDELETE: Delete a program question
  • ProgramCustomAttributesUPDATE: Update custom attributes of program
  • ProgramMetricsREAD: Read program date for metrics/export

Payment(s)

  • PaymentREAD: Read payment(s)
  • PaymentCREATE: Create payment instruction for FSP
  • PaymentFspInstructionREAD: Read payments instructions for past payment to post in Financial Service Provider Portal
  • PaymentTransactionREAD: Read single or all transaction(s)

Payment(s) - Voucher(s) - (only applicable for programs with voucher-support)

  • PaymentVoucherREAD: Read balance of voucher & export voucher

FSP integration - Debit card(s) - (only applicable for programs with debit card management support)

  • FspDebitCardREAD: See cards and card details
  • FspDebitCardBLOCK: Block (pause) a card
  • FspDebitCardUNBLOCK: Unblock (unpause) a card
  • FspDebitCardCREATE: Issue new debit card & permanently block old card
  • FspDebitCardEXPORT: Export data about all debit cards

Registration(s)

  • RegistrationREAD: Read all People Affected for program EXCLUDING personal data
  • RegistrationCREATE: Create set of registered PA's (import) & create set of PA's to invite (import)
  • RegistrationDELETE: Delete registrations
  • RegistrationAttributeUPDATE: Update (non-financial) attribute for registration
  • RegistrationAttributeFinancialUPDATE: Update financial attribute for registration (multiplier, max payments)
  • RegistrationFspUPDATE: Update specific FSP and attributes
  • RegistratonNotificationREAD: Read message history
  • RegistratonNotificationCREATE: Create (and send) message to list of registrations

Registration(s) - Personal

  • RegistrationPersonalREAD: Read all People Affected for program INCLUDING personal data & get note for registration
  • RegistrationPersonalForValidationREAD: Read registration with prefilled answers & download all program answers
  • RegistrationPersonalEXPORT: Read a list of people for export
  • RegistrationPersonalUPDATE: Update note for registration & issue validation

Registration(s) - Status

  • RegistrationStatusMarkAsValidatedUPDATE: Update set of People Affected to Validated
  • RegistrationStatusMarkAsDeclindUPDATE: Update set of People Affected to Declined
  • RegistrationStatusNoLongerEligibleUPDATE: Update set of People Affected to No longer eligible
  • RegistrationStatusIncludedUPDATE: Update set of People Affected to Included
  • RegistrationStatusRejectedUPDATE: Update set of People Affected to Rejected
  • RegistrationStatusInclusionEndedUPDATE: Update set of People Affected to Inclusion ended
  • RegistrationStatusInvitedUPDATE: Update set of PAs to Invited for registration
  • RegistrationStatusPausedUPDATE: Update set of PAs to Paused

Registration(s) - Import

  • RegistrationImportTemplateREAD: Read a CSV template for importing registrations

Action(s)

  • ActionREAD: Read when certain actions were last taken in 121-portal
  • ActionCREATE: Save time of action taken in 121-portal

User(s)

  • AidWorkerProgramREAD: See Aid workers assigned to program
  • AidWorkerProgramUPDATE: Update Aid worker to assign to program