This space is created to document the configuration guide for Android Reg Client.

Reference configuration guide for Registration Client: https://docs.mosip.io/1.2.0/modules/registration-client/registration-client-configuration

Overview

This Android Reg Client Configuration Guide lists down important properties that can be configured based on preference. The properties listed here are not exhaustive, but a checklist to review properties that are likely to be configured.

All the properties are synced to the Android Registration Client from registration-default.properties file.

Configuration Files:

application-default.properties

registration-default.properties

SBI related configurations:

Timeouts in milliseconds set during any http calls to SBI.

mosip.registration.mdm.connection.timeout=10000
mosip.registration.mdm.RCAPTURE.connection.timeout=40000
mosip.registration.mdm.MOSIPDINFO.connection.timeout=5000
mosip.registration.mdm.MOSIPDISC.connection.timeout=5000

Quality score threshold based on modality, Possible values 1 to 100

mosip.registration.leftslap_fingerprint_threshold=40
mosip.registration.rightslap_fingerprint_threshold=40
mosip.registration.thumbs_fingerprint_threshold=40
mosip.registration.iris_threshold=60
mosip.registration.face_threshold=9

Retry attemps, Possible values 1 to 10

mosip.fingerprint_authentication.quality_score=30
mosip.iris_authentication.quality_score=30
mosip.face_authentication.quality_score=30

Quality score threshold based on modality for operator authentication, Possible values 1 to 100

mosip.fingerprint_authentication.quality_score=30
mosip.iris_authentication.quality_score=30
mosip.face_authentication.quality_score=30 

Batch Size:

Jobs like RID sync, packet upload, status sync is carried out in batches, number of registration records to be executed in a batch on every trigger.

mosip.registration.rid_sync_batch_size=5
mosip.registration.packet_upload_batch_size=5
mosip.registration.status_sync_batch_size=5 

Scheduled Jobs:

Default CRON expression for scheduling the Jobs.

mosip.registration.sync_jobs_restart_freq=0 0 */11 ? * *

Other Configurations:

Enables / disables reviewer authentication on any biometric exception during registration

mosip.registration.reviewer_authentication_configuration=Y

If enabled cross-checks of residents biometrics with locally stored operator biometric templates.

mosip.registration.mds.deduplication.enable.flag=N

Minimum disk space required to create a packet - in MB

mosip.registration.disk_space_size=5

Maximum no. of days for approved packet pending to be synced to server beyond which Registration Client is frozen for registration

mosip.registration.last_export_registration_config_time=100

No. of days beyond audit creation date to delete audits

mosip.registration.audit_log_deletion_configured_days=10

Maximum duration to which registration is permitted without sync of master data

mosip.registration.sync_transaction_no_of_days_limit=5

Allowed number of invalid login attempts

mosip.registration.invalid_login_count=50

Configuration used to check if any sync job is missed / failed beyond expected days, this configuration is checked everytime operator clicks on any registration process. We follow below convention to create this config key.

mosip.registration.job api name as in sync_job_def table.frequency=value in days

Date Formats:

Date format to be displayed on acknowledgement slip, default value - dd/MM/yyyy hh:mm a

mosip.registration.application_date_format

Date format to be displayed on Registration Client dashboard, default format - dd MMM hh:mm a

mosip.registration.dashboard_date_format

Supporting properties for 1.1.5.x server compatibility:

As 1.1.5.x versions did not have ui-specs, in android regclient, the backward compatibility is handled by migrating 1.1.5.x schema to LTS UI Spec structure.

To handle this migration, we have added some configurations and templates to support the 1.1.5.x server compatibility. Those configurations are listed below.

• mosip.registration.consent-screen-template-name=reg-consent-screen-content-template

  • Consent screen is not a part of 1.1.5.x schema structure. So, we are completely fetching this consent screen content from “master.template" table, and the templateTypeCode for the consent screen content is mentioned in the above configuration.

• mosip.registration.individual-biometrics-id=individualBiometrics

  • The id of individual biometrics should be mentioned in the above property according to the configured 1.1.5.x schema.

• mosip.registration.introducer-biometrics-id=guardianBiometrics

  • The id of guardian / introducer biometrics should be mentioned in the above property according to the configured 1.1.5.x schema.

• mosip.registration.infant-agegroup-name=INFANT

  • The age-group name for infants (aged below 5 years) which is configured in the configured server should be mentioned in the above property.

• mosip.registration.agegroup-config={"INFANT":{"bioAttributes":["face"],"isGuardianAuthRequired":true},"ADULT":{"bioAttributes":["leftEye","rightEye","rightIndex","rightLittle","rightRing","rightMiddle","leftIndex","leftLittle","leftRing","leftMiddle","leftThumb","rightThumb","face"],"isGuardianAuthRequired":false},"SENIOR_CITIZEN":{"bioAttributes":["leftEye","rightEye","rightIndex","rightLittle","rightRing","rightMiddle","leftIndex","leftLittle","leftRing","leftMiddle","leftThumb","rightThumb","face"],"isGuardianAuthRequired":false}}

  • The above property indicates list of age-groups, required bio-attributes, and a flag which indicates guardian authentication is required or not. This property should be changed according to the server configuration and requirements.

• mosip.registration.allowed-bioattributes=leftEye,rightEye,rightIndex,rightLittle,rightRing,rightMiddle,leftIndex,leftLittle,leftRing,leftMiddle,leftThumb,rightThumb,face

  • The above property defines the list of bio-attributes that are allowed for scanning during registration. If there are any changes in the server, it should be changed accordingly.

• mosip.registration.default-app-type-code=000

  • The above property defines the default applicantTypeCode. In LTS, we have applicanttype.mvel script to fetch the documents according to the age, gender and some other attributes. Based on the applicant details, the script returns an applicantTypeCode which can be any value from “000” to “014”, and respective documents will be fetched from master.applicant_valid_document table. But we do not have this script defined in 1.1.5.x, to handle this, we have added a default applicantTypeCode.

Templates:

Ensure that preview and acknowledge templates are present in template table of mosip_master database with the following type code

reg-android-preview-template-part

reg-android-ack-template-part

Logout:

Logout from ARC will check for any running background tasks in the background. And ask user that if user is still wants to logout from the application.

• If user click on logout on the popup all the jobs that are running and scheduled jobs will stop.

• If no jobs running in the background, Simply user will logout and navigate to login screen.

• There are no configuration changes required for logout in ARC.

Enhanced version

Logout:

Logout from ARC will check for any running background tasks in the background. Ask the user if the user still wants to logout from the application.

• If the user clicks on logout on the popup, all the jobs running and scheduled jobs will stop.

• If no jobs are running in the background, the user will simply log out and navigate to the login screen.

• No configuration changes are required to log out of ARC.

Selected Handles:

• Inside ClientManager/RegistrationConstants.java file define variable for selectedHandle key as:

Open

• As shown in the above image define the selected handles as per Id-Schema in the environment. And this is the link to add / update the fields to set as selected handles by default it will navigate to develop1 branch.  
  
  
  

• And then in GlobalParamRepository.java use this method to access the values of selected handle-fields

• Inside SubmitRegistrationDto method in RegistrationServiceImpl.java use this code to add selectedHandles into the packet:

• We have to do some changes in below files as well.

1.  id-repository-default.properties (Click on the text to navigate to docs)

Open

2. id-authentication-default.properties (Click on the text to navigate to docs)

Open