End User Guide

Introduction

The Issuance - Certificate Generation Platform leverages Verifiable Credentials (VC) technology to enhance the transparency, security, and efficiency of document management. This system has two primary stakeholders:

  1. VC Maker The VC Maker is responsible for managing and uploading students' (users') documents into the system. This includes functionalities for:

  • Uploading documents or certificates of students.

  • Previewing uploaded documents on an intuitive dashboard for verification and tracking purposes.

  1. VC Checker The VC Checker focuses on reviewing, filtering, and validating student records. This role includes:

  • Viewing a list of schools and their associated students.

  • Applying document-specific filters to sort and identify relevant student records.

  • Previewing documents or certificates uploaded for each student.

  • Approving or declining documents based on compliance with scholarship requirements.

The system is designed to streamline the scholarship approval process while ensuring data integrity through the adoption of verifiable credentials.

Key Features

  1. Homepage:

  • The homepage contains a Users Category section, which includes a Create Account link that redirects users to the VC Maker registration page.

  • The Sign In button in the header redirects to the Keycloak login page, where both VC Maker and VC Checker can log in using the same link.

  • The FAQ section includes platform-related questions and their answers.

  1. Authentication and User Management:

VC Maker registers through the platform, and VC Checker retrieves login details from the database.

Both VC Maker and VC Checker can log in via Keycloak, with links provided on the homepage

  1. Login with Keyclock:

  2. Enter email ID / Mobile number and password

  3. User registration:

  1. Enter Name, Username, Email Id, Mobile number, Password, Confirm Password

Dashboard:-

VC Maker

Through the dashboard, the VC Maker can manage and upload students' (users') documents into the system. This includes functionalities for:

  • Uploading documents or certificates of students.

  • Previewing uploaded documents on an intuitive dashboard for verification and tracking purposes.

VC Checker

Through the dashboard, the VC Checker focuses on reviewing, filtering, and validating student records. This role includes:

  • Viewing a list of schools and their associated students.

  • Applying document-specific filters to sort and identify relevant student records.

  • Previewing documents or certificates uploaded for each student.

  • Approving or declining documents based on compliance with scholarship requirements.

  • Approved Student List : Displays the list of students approved by the VC Checker.

Download Certificates:

  1. Filter certificates by document type and download them individually.

  2. Option to download all issued certificates in bulk.

Logout

Using the logout button option on the Dashboard, both VC Checker and VC Maker can log out from Keycloak

Note: Some of the persona/entities need to be created from the backend before starting to use the application.

Usage Guide

  1. Login:

    1. Navigate to the application URL on DEV or UAT

    2. Enter your credentials (username/Mobile Number and Password)

    3. Click the Login button to access the admin dashboard

Login page for VC Maker and VC Checker

  1. Registration:

    1. Click on the Create Account link VC Maker section in the Users Category section button

    2. Navigate to the route form/examiner-signup

  2. Fill in the following details:

    1. Name

    2. Email Id

    3. Mobile number

    4. Password

    5. Confirm Password

    6. Click on the “Create Account” button

  3. Navigate to the Login page

On the registration page, there is a section titled 'Already have an account? Sign in,' which can also redirect to the sign-in/login page.

Registration page for VC Maker

Dashboard Overview:

VC Checker View

On the dashboard's main page, there is an institute list. When the 'Proceed' button is clicked in the institute list table, it redirects to the student list page, which displays the school name and includes a document filter. The student list is displayed based on the applied filter, with the default list showing according to the marksheet. You can change the filter option as needed.

The table includes actions such as Preview:

  • Preview: Clicking on 'Preview' opens the PDF in a modal, where you can view the details. Clicking the 'Cancel' button on the modal closes it.

  • Approve Certificate: Clicking on 'Approve Certificate' within the modal will approve the certificate.

  • Approve Button: Clicking the 'Approve' button directly in the table also approves the certificate.

  • Decline: Clicking 'Decline' deletes the certificate."

Approved List

  • The approved list has a table view, which includes the fields: First Name, Last Name, Certificate No., and Status. There is also a certificate list filter to filter the approved student list based on the document

Download Certificate

  • "The 'Download Certificate' tab has a table view that includes the fields: First Name, Last Name, Certificate No., Status, and a Download button. There is also a certificate list filter to filter the approved student list based on the document.

  • When the Download button is clicked, the specific student's record is displayed in JSON format. Additionally, there is a 'Download All Issued Certificates' button. When clicked, all records related to the selected document type are displayed in CSV format."

VC checker Dashboard Main page

VC checker Detail page

VC Maker View

On the dashboard's main page, there is an institute list. When the 'Proceed' button is clicked in the institute list table, it redirects to the student list page, which displays the school name and includes a document filter. The student list is displayed based on the applied filter, with the default list showing according to the marksheet. You can change the filter option as needed.

  • The table includes actions such as Preview:

    • Preview: Clicking on 'Preview' opens the PDF in a modal, where you can view the details. Clicking the 'Cancel' button on the modal closes it.

VC maker Dashboard page

VC maker Detail page

Logout

  1. Click on the text Logout in the left-bottom corner.

Logout

Troubleshooting

This guide addresses common issues users might face and provides solutions to help resolve them

  1. Problem: Incorrect email or password.

    1. Solution:

      1. Verify that the credentials are correct

      2. Ensure the Caps Lock key is off

      3. Register username/Mobile Number and password by clicking on Register Now button and fill the correct data.

  2. Problem: Unable to access the login page

    1. Solution:

      1. Check your internet connection

      2. Ensure the URL is correct

      3. Clear browser cache and cookies, then try again

3. Problem: The dashboard shows blank or no data.

  • Check the backend API status. Ensure the server is running

  • Open the browser console (usually F12 > Console tab) and check for API errors.

  • Ensure environment variables are correctly configured in the frontend environment.ts file and proxy.conf.json file.

  • When filters are applied to the document list on the VC Checker and VC Maker dashboards, the data sometimes loads slowly. In such cases, the VC Checker and VC Maker should wait for 2-3 seconds before changing the document filters in the list.

PreviousDeveloper GuideNextBeneficiary Toaster

Last updated

Was this helpful?