From 3bfc50a4b1c593c5eda503edb99aa97de2bcb036 Mon Sep 17 00:00:00 2001 From: Suseela S Date: Fri, 9 Aug 2024 11:03:09 +0000 Subject: [PATCH] GITBOOK-1003: Added details on form.io, oidc and common base --- .../self-service-registration-portal.md | 30 +++++++++++-------- 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/social-registry/development/upcoming-features/self-service-registration-portal.md b/social-registry/development/upcoming-features/self-service-registration-portal.md index c8a1014f..cea03859 100644 --- a/social-registry/development/upcoming-features/self-service-registration-portal.md +++ b/social-registry/development/upcoming-features/self-service-registration-portal.md @@ -4,17 +4,17 @@ description: Work in Progress # Self Service Registration Portal -The Self Service Registration Portal for a Social Registry is a digital platform designed to streamline and simplify the process of accessing and managing social services. It empowers citizens to interact with social services independently, reducing administrative burdens and improving service delivery. +The Self Service Registration Portal for a Social Registry (SR-SSRP) is a digital platform designed to streamline and simplify the process of accessing and managing social services. It empowers citizens to interact with social services independently, reducing administrative burdens and improving service delivery. ## Feature and functionality -
FeatureFunctionality
OpenID Connect integration

The Self Service Registration Portal allows integration with any OpenID Connect (OIDC) client. The portal has an existing integration with eSignet.

User Portal AccessUsers can log in and independently manage various aspects of their social registry profile.
Form Design and ManagementAdministrators can design multiple forms tailored to different social programs, enabling streamlined data collection, and processing.
Profile and Contact ManagementUsers can directly update their profile information and contact details, ensuring accuracy, and timeliness.
Household and Family ManagementUsers can add and update household and family details, facilitating comprehensive data management.
Periodic Liveliness Check Users can perform periodic liveliness checks through ID integration options, maintaining up-to-date records.
Document UploadUsers can upload important documents as required by various departments, simplifying application processes.
User Profile ManagementUsers can view and update their personal information, ensuring their data is current and accurate.
Notifications and AlertsSend automated notifications and alerts to users regarding application status, deadlines, and important updates.
+
FeatureFunctionality
OpenID Connect integration

The SSRP allows integration with any OpenID Connect (OIDC) client. The portal has an existing integration with eSignet.

User Portal AccessUsers can log in and independently manage various aspects of their social registry profile.
Form Design and ManagementAdministrators can design multiple forms tailored to different social programs, enabling streamlined data collection, and processing.
Profile and Contact ManagementUsers can directly update their profile information and contact details, ensuring accuracy, and timeliness.
Household and Family ManagementUsers can add and update household and family details, facilitating comprehensive data management.
Periodic Liveliness Check Users can perform periodic liveliness checks through ID integration options, maintaining up-to-date records.
Document UploadUsers can upload important documents as required by various departments, simplifying application processes.
User Profile ManagementUsers can view and update their personal information, ensuring their data is current and accurate.
Notifications and AlertsSend automated notifications and alerts to users regarding application status, deadlines, and important updates.
## High-level workflow {% embed url="https://miro.com/app/board/uXjVKtyyeYg=/" %} -## Benefits of Self Service Registration Portal +## Benefits of SSRP 1. **Enhanced Accessibility** * **24/7 Availability:** Users can access the portal at any time, from anywhere, making social services more accessible. @@ -29,7 +29,7 @@ The Self Service Registration Portal for a Social Registry is a digital platform * **Self-Reliance:** Users gain greater control over their interactions with social services, fostering independence. * **Transparency:** Real-time updates and status tracking enhance transparency in service delivery. 5. **Reduces Dependency** - * Self Service Registration Portal reduces dependency on government initiatives to gather data. + * SSRP reduces dependency on government initiatives to gather data. * Additionally, this feature offers an alternate method to create the nation's registry by allowing beneficiaries to update their information whenever they choose. This eliminates the need for them to wait for government to collect their data. ## Design strategy @@ -38,7 +38,7 @@ The Self Service Registration Portal for a Social Registry is a digital platform {% embed url="https://miro.com/app/board/uXjVKsL5Bfg=/" %} -This above chart outlines the redesigning of the PBMS Beneficiary Portal components to enhance re-usability and maintainability. The current architecture is being refined to separate a base set of components that can be effectively reused across both the Beneficiary Portal and the Social Registry Self Service Registration Portal (SR-SSRP). +This above chart outlines the redesigning of the PBMS Beneficiary Portal components to enhance re-usability and maintainability. The current architecture is being refined to separate a base set of components that can be effectively reused across both the Beneficiary Portal and the SR-SSRP. #### **Initial architecture: Beneficiary Portal** @@ -52,22 +52,28 @@ The Beneficiary Portal originally managed key services needed by users, includin #### **Redesign: separation of base components** -The redesigned architecture separates core components into a base that can be leveraged by both the Beneficiary Portal and the Social Registry SSRP, thereby increasing the overall reusability, maintainability, and flexibility of the system. +The redesigned architecture separates core components into a base that can be leveraged by both the Beneficiary Portal and the SR-SSRP, thereby increasing the overall reusability, maintainability, and flexibility of the system. -
Base Portal
  • Login Services: Centralised control over user authentication, session management, and reusable across both the portals.
  • Form Services: Manages all form-related activities, including creation, and submission.
Beneficiary PortalProgram Services: Focuses specifically on program-related functionalities, ensuring dedicated support, and customisation for beneficiaries.
Social Registry Self Service Registration Portal (SR-SSRP)Profile Services: Manages user profiles, enabling users to update, and maintain their personal information.
Household ServicesManages household-related data and interactions, allowing the head of the household to update and maintain household information.
+
PortalsAPI Services
Base Portal
  • Login Services: Centralised control over user authentication, session management, and reusable across both the portals.
  • Form Services: Manages all form-related activities, including creation, and submission.
Beneficiary PortalProgram Services: Focuses specifically on program-related functionalities, ensuring dedicated support, and customisation for beneficiaries.
Social Registry Self Service Registration Portal (SR-SSRP)
  • Profile Services: Manages user profiles, enabling users to update, and maintain their personal information.
  • Household Services: Manages household-related data and interactions, allowing the head of the household to update and maintain household information.
-### Advantages of redesigning of Beneficiary Portal components +#### Advantages of redesigning of Beneficiary Portal components -The redesign of the Beneficiary Portal components into a shared base architecture not only facilitate the reuse of essential services across different portals but also enhances the maintainability and adaptability of the entire system. By strategically separating these components, we are better equipped to meet the evolving needs of our users and ensure a more efficient, scalable solution. +The redesign of the Beneficiary Portal components into a shared base architecture not only facilitate the reuse of essential services across different portals but also enhances the maintainability and adaptability of the entire system. By strategically separating these components, we are better equipped to satisfy the changing needs of our users and ensure a more effective, scalable solution. -### **Form.IO for managing form and rendering** +### **Form.io for managing form and rendering** + +Both the Beneficiary Portal and SR-SSRP will utilise Form.io to manage forms and display dynamic content. Using the features of Form.io, forms can be designed to collect and update socio-economic data from users, allowing them to add new household information or edit existing data directly through the portal. ### **OIDC for user login** -### **Common code base for Beneficiary Portal and Social Registry Self Service Registration Portal** +Secure and standardized user authentication is paramount. By implementing OIDC, the system can leverage a robust authentication framework. OIDC allows integration with various third-party identity providers, such as Keycloak or eSignet. This approach enables centralised user management, strengthens security, and simplifies the login process. With user credentials stored and managed by the chosen identity provider, the system benefits from enhanced security and reduced development complexity. + +### **Common code base for Beneficiary Portal and SR-SSRP** + +The redesigned architecture emphasises code reusability and maintainability by establishing a common code base. Core services like login and form management, originally part of the Beneficiary Portal, are now refactored into reusable components accessible by both the portals. This approach simplifies development processes, guarantees a uniform user experience on both the platforms, and makes future maintenance and updates simpler. ## Development phase -The following deliverables for the Self Service Registration Portal for Social Registry module are planned for development and release at the appropriate phases. +The following deliverables for the SR-SSRP module are planned for development and release at the appropriate phases.
PhaseDeliverableStatus
Phase 1
  • Login with OIDC
  • Update Profile
  • Add/Update Household members
  • Reference UI
Phase 2
  • Survey and Program forms
  • Notifications and Alerts
  • Document management
  • Liveliness check
Phase 3
  • Discovery service