From 246b7b6a052bf4421de53e1523a90b8eb45d9caf Mon Sep 17 00:00:00 2001 From: Mayura Deshmukh Date: Thu, 10 Mar 2022 16:00:23 +0530 Subject: [PATCH 1/2] my entry --- output/mayura-workshop-test-entry.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 output/mayura-workshop-test-entry.md diff --git a/output/mayura-workshop-test-entry.md b/output/mayura-workshop-test-entry.md new file mode 100644 index 0000000..3ef0ea8 --- /dev/null +++ b/output/mayura-workshop-test-entry.md @@ -0,0 +1,28 @@ +# Documentation Workshop + +## Overview +The goal of this workshop session is to assist in understanding the guidelines for writing MOSIP related documentation. + +## Types of documents + +### Type1 + +New functionalities added in Admin Portal: +* Using the Admin Portal, the administrator can now retrieve a resident's lost RID or misplaced RID. +* Using the Admin Portal, the administrator can now control the levels of location hierarchy that are required while creating the registration centres. Each level of the location hierarchy can be configured as well. +* Using the Admin Portal, the administrator can now map the user to a registration centre and to a zone. +* Using the Admin Portal, the administrator can now create and update dynamic fields like gender, blood type, residence status, marital status etc. +* Using the Admin Portal, the administrator can now configure the number of kiosks while creating a registration centre. + +### Type 2 + +Steps for setting up Registration Client: + +* Step 1: Download TPM utility and run it the to get machine keys. Please find the instructions to check out, build and run the utility [here](). + +* Step 2: Whitelist the machine keys in server db. Machine name and keys output from utility should be updated in server. Use the below api to create / whitelist your machine. + ```curl -X POST "https:///v1/masterdata/machine ``` + + **NOTE: + -> Replace appropriate HOSTNAME in the above curl command + -> In case, we are trying to whitelist NON-TPM machine, Please set publicKey and signPublicKey with same value From f6ac138b755df4f3e41cbb4e7bf4fa02923b4c9b Mon Sep 17 00:00:00 2001 From: Mayura Deshmukh Date: Thu, 10 Mar 2022 16:19:52 +0530 Subject: [PATCH 2/2] added remaining part --- output/mayura-workshop-test-entry.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/output/mayura-workshop-test-entry.md b/output/mayura-workshop-test-entry.md index 3ef0ea8..5fee23f 100644 --- a/output/mayura-workshop-test-entry.md +++ b/output/mayura-workshop-test-entry.md @@ -20,9 +20,18 @@ Steps for setting up Registration Client: * Step 1: Download TPM utility and run it the to get machine keys. Please find the instructions to check out, build and run the utility [here](). -* Step 2: Whitelist the machine keys in server db. Machine name and keys output from utility should be updated in server. Use the below api to create / whitelist your machine. +* Step 2: Whitelist the machine keys in server db. + + Machine name and keys output from TPM utility should be updated in server. Use the below api to create / whitelist your machine. ```curl -X POST "https:///v1/masterdata/machine ``` - - **NOTE: - -> Replace appropriate HOSTNAME in the above curl command - -> In case, we are trying to whitelist NON-TPM machine, Please set publicKey and signPublicKey with same value + + **Points to note: + * Replace appropriate ```HOSTNAME``` in the above ```curl``` command + * To whitelist non TPM machine, set ```publicKey``` and ```signPublicKey``` with same value + +* Step 3: Know your user id and required roles. + * Create the user in the Keycloak. + * Map the user to same center as that of the machine that is created/whitelisted in Step 2. + * One of these roles must be assigned to the user in Keycloak - REGISTRATION_SUPERVISOR or REGISTRATION_OFFICER. + +* Step 4: Download Rregistration Client on the regisered machine and run it. You can now use above user Id to login into it. \ No newline at end of file