Registration Client Setup Guide - Collab Environment

Owned by Rakshith B
Last updated: Oct 05, 2023 by sanchi singh
8 min read

Overview

Welcome to the Registration Client Setup Guide tailored specifically for our Collab Environment!

The Registration client setup guide for the MOSIP Collab environment offers a comprehensive walkthrough to help you effortlessly configure and access the Registration Client module. Designed to provide agents with a range of functionalities, the Registration Client module allows you to perform various tasks such as onboarding, data synchronization, packet management, and more.

This guide aims to ensure that you have a smooth and efficient experience while setting up the Registration Client in the MOSIP Collab environment. Whether you're a new user exploring the module or an experienced operator looking for a seamless setup process, this guide will take you through the necessary steps to ensure you have the tools you need at your fingertips. Let's delve into the details and embark on a journey of effective operational management with MOSIP in our Collab environment.

Pre-requisites

  1. Hardware

    1. Workstation

    2. Windows 10/11 laptop or desktop

    3. Minimum 16 GB RAM

    4. 50 GB of free space on the hard disk

    5. The workstation should be TPM 2.0 enabled. The sequence of steps to check if your workstation is TPM enabled, click here.

It is important that your workstation is TPM 2.0 enabled and not with any older version of TPM. If your workstation has an older version of TPM, like TPM 1.2, then you may have to upgrade your BIOS firmware to upgrade to TPM 2.0. You should contact your vendor in this respect, if you are not aware of how to do this.

2. Software

a. Mock MDS - To simulate biometric capture and see if you do not have real biometric devices with you, click here.

b. TPM Utility - This is used for registering the workstation on which the Registration Client would be executed. To access the utility, click here.

c. JAVA - Ensure JAVA 11 is installed and JAVA_HOME is in the PATH.
d. Registration Client Application -

  1. Credentials:

    1.  

  2. ID Schema:

    1.  

Step-by-Step Process

To effectively setup the Registration Client in the Collab environment, follow the steps given below:

Step 1: Download and extract the TPM utility

  1. As explained in README.txt, download and extract the TPM utility (using the command prompt).

  2. Run the following command from the folder where the TPM jar is located.

  3. java -jar tpmutility-0.0.2.jar  > tpmdetails.txt

  4. Email the “tpmdetails.txt” to your MOSIP representative.

  5. Your MOSIP representative will assist you in registering your workstation on the designated MOSIP server. Once completed, they will provide you with the necessary credentials to access the registration client.

Step 2: Running Mock MDS

  1. Download and extract the Mock MDS zip provided here.

  2. Certificates need to be placed in
    Biometric Devices > Face > keys
    Biometric Devices > Finger > keys
    Biometric Devices > Iris > keys

The certificates need to be placed in the certificate paths as highlighted in the mock MDS.

 

Screenshot 1 FYR:

Step 3: Update application properties

  1. Once you have placed the certificates, follow these steps to update the application.properties file with the necessary changes.

Screenshot 2 FYR:

Step 4: Build Mock MDS

  1. Build the Mock MDS in the command prompt in the same directory where the pom file exists
    (run mvn clean install ).

  2. After building Mock MDS, the Target Folder will be created in the same directory.

  3. Open the target folder and execute run.bat (by double-clicking it).

  4. By default, the Purpose will be set for Registration and the Biometric Type will be set to Biometric.

    1. The device also has the “Device Discovery Port” by default set to 4501.

    2. To change the “Purpose” or “Biometric Type”, edit the run.bat file in a notepad.

Screenshot 3 FYR:

Step 5: Setup biometric device

  1. You can set the Purpose as “Registration” or “Auth” (For reg-client, purpose will be Registration).

  2. If you set “Biometric Type” to “Biometric Device”, all the devices will be displayed during device discovery. If you want to set it to a specific Device Type, you can set it from the following options.

  3. Biometric Device - click here

    1. Finger

    2. Face

    3. Iris

  4. Mock MDS will start running and listening to a port between 4501 and 4600.

  5. If the run is successful, you will see the following output.

Screenshot 4 FYR

Ensure that Mock MDS is always running whenever you are running the Registration Client.

Step 6: Adding Your Own Biometrics

  1. If you need to add your own biometrics, follow the steps below.

    1. Open the profile folder > Add a new folder with your own biometrics.

    2. While running mock MDS, use API to change the biometrics folder Post method URI: http://127.0.0.1:4501/admin/profile

    3. Request:

      { "type": "Biometric Device", //Possible Values: Biometric device, Face, Iris or Finger "profileId": "Name" //Name given to Biometric folder }

Step 7: Running the Registration Client  

  1. Download Registration Client: To download the Registration Client, click here.

    1. Extract the registration client zip file and click run.bat. As mentioned above under pre-requisites, make sure that you have JAVA installed in your path.

  2. Login:

    1. Login as a Registration agent with the credentials provided to you.

  3. First Time Sync: After your registration client is completely set up and you have successfully logged in, please follow the below steps:

    1. Click on Synchronize Data.

  4. Initiate a New Registration: To start registering an individual, follow the steps below.

    1. In the homepage, click on New Registration.

    2. Select Your Language Preference:

      1. Choose the preferred language and proceed

    3. Capture Demographic Data:

      1. Continue by entering entering the demographic details. Click on Continue.

    4. Upload Documents:

      1. Upload the required documents marked as mandatory/upload optional documents as preferred: Address Proof and Identify Proof are currently marked as mandatory.

      2. Upload the documents > Then opt to scan, capture, and save. Click on `Continue”.

    5. Capture Biometrics:

      1. Proceed to capture Biometric details of the individual, by scanning. Click on Continue.

      2. Click on Agree and Continue.

    6. Supervisor Authentication:

      1. Provide the password and Continue.

    7. Preview

      1.  

    8. Acknowledgement:

      1.  

    9. On completion of the registration process, opt to navigate to the homepage by clicking on “Home”

  5. Packet Approval:

    1. Click on Pending Packet Approval> Approve and then > Authenticate by providing the correct credentials.

  6. Packet Upload:

    1. On the home screen - click on Registration Data Upload.

    2. Select the packet and click Upload.

  7. Verify Packet Upload Completion:

    1. After successful upload, check for the presence of the RID in the drives where the Registration Client is installed.

    2. You will find a folder titled with as the RID of the packet. If you find it, your packet has been successfully created and uploaded.

Screenshot 5 FYR


The uploaded packet is further synced with the backend processing engine (Registration Processor), which subsequently processes the packet and issues the Unique Identification Number (UIN) for the registered individual. Refer here to know more about MOSIP’s Registration Processor engine, or click here (Upcoming) to know more about how to run the engine.

Get in Touch:

If you require any assistance or encounter any issues during the testing and integration process, kindly reach out to us through the support mechanism provided below.

  • Navigate to community.mosip.io

  • Provide a detailed description about the support you require or provide detailed information about the issue you have encountered, including steps to reproduce, error messages, logs and any other relevant details.

Thank you. We wish you a pleasant experience!