Skip to content

Latest commit

 

History

History
149 lines (142 loc) · 13.4 KB

Guidelines-for-Adding-Centers,-Machine,-User-and-Devices.md

File metadata and controls

149 lines (142 loc) · 13.4 KB

List of Contents

1. Seed Data Source files (in csv format):

  1. Registration Centers: master-registration_center
  2. Machines: master-machine_master
  3. Users: master-user_detail
  4. Devices: master-device_master
  5. Center-Machine Mapping: master-reg_center_machine
  6. Center-Device Mapping: master-reg_center_device
  7. Center-User Mapping: master-reg_center_user
  8. Center-Machine-Device Mapping: master-reg_center_user_machine
  9. Center Machine User Mapping: master-reg_center_machine_device
  10. User Zone Mapping: master-zone_user

2. Steps to Add seed data:

2.1 Create Roles in LDAP

Before creating the Masterdata, Roles used across MOSIP are needed to be created in LDAP.

Following roles have to be created using the process as mentioned above.(Refer here for help on how to create roles in LDAP.)

  1. REGISTRATION_ADMIN
  2. REGISTRATION_SUPERVISOR
  3. REGISTRATION_OFFICER
  4. ZONAL_ADMIN
  5. GLOBAL_ADMIN
  6. AUTH
  7. PREREG
  8. REGISTRATION_PROCESSOR
  9. ID_AUTHENTICATION
  10. PRE_REGISTRATION_ADMIN

2.2 Create a Registration Center:

  1. Center ID: This should be a 5-digit ID and should be in an incremental sequence for each center added. The sequence should start from 10000. Keeping the length other than 5 digits will fail validations as the same Center ID is used to generate the Request ID (Registration ID). For each Center created, Center ID should be incremented sequentially to avoid inconsistency in data.
  2. Center Name: Country defined name for the Center
  3. Center Type Code: (Should be kept as “REG”). Center Type Code will come from a Center Type Masterdata which currently have one center Type defined as “Regular” and Code as “REG”. More Center Types can be defined by the country in the Center Type Masterdata.
  4. Address Line 1: It is an Optional Field but should be defined to be visible to the resident on the Pre-Registration UI
  5. Address Line 2: It is an Optional Field
  6. Address Line 3: It is an Optional Field
  7. Latitude: Should be defined in format XX.XXXX. minimum 4 digits are need after the decimal for the accuracy to be atleast 11 meters on the GPS map on Pre-Registration Portal
  8. Longitude: Should be defined in format XX.XXXX. minimum 4 digits are need after the decimal for the accuracy to be atleast 11 meters on the GPS map on Pre-Registration Portal
  9. Location Code: Maps the Registration Center to a Location. Should be a location code referring to a location defined in the location Masterdata table. Should always be the code of the location which is at the lowest hierarchy level
  10. Contact Phone: An optional field. Usually a point of contact for a Registration Center
  11. Contact Person: Name of the person who is a point of contact for a Registration Center
  12. Number of Kiosk: Number of Registration Kiosk a Registration Center will have to register residents. This number is used by the pre-registration to calculate appointment slots for Registration. This should always be equal to the number of machines assigned to the Center or will be assigned to the Center. Refer point 2.5 in steps below
  13. Working Hours: Should be the difference of “Center Start Time” and “Center End Time”. Should be in format hh:mm:ss
  14. Per Kiosk Processing time: Duration of Registration Appointment defined as per the country requirement. This attribute is used by pre-Registration to calculate appointment slots. Should be in format hh:mm:ss
  15. Center Start Time: Time when Center would start taking registration of Residents. This time is used by Pre-Registration to calculate appointment slots. Should be in format hh:mm:ss
  16. Center End Time: Time when the Center closes. This time is used by Pre-Registration to calculate appointment slots. Should be in format hh:mm:ss
  17. Lunch Start Time: Starting of Lunch Time the Center would have in-between the Working hours. It is used by Pre-Registration to calculate appointment slots. Should be in format hh:mm:ss
  18. Lunch End Time: Ending of Lunch Time the Center would have in-between the Working hours. It is used by Pre-Registration to calculate appointment slots. Should be in format hh:mm:ss
  19. Time Zone: (GTM+01:00) CENTRAL EUROPEAN TIME
  20. Holiday Location Code: Refers to the location to which country defined holidays are mapped in holiday location table. Should come from the Holiday master table. Current values can only be “KTA” or “RBT” as holidays are only defined for these two location codes.
  21. Zone Code: Contains the Zone code to which the Registration Center should be tagged to. The Administrative Zones are defined by a country to better manage the resources(Centers, Machines and Devices) used in Registration Process. These are defined in Masterdata table 'zone' in hierarchical fashion similar to Location masterdata
  22. Language Code: Should be the language code for the languages supported by the Country as primary/secondary Language. (E.g English - eng, French - fra, Arabic - ara)
  23. Is_Active: TRUE. If set as false, this Registration will not be shown up in Pre-Registration UI and no appointments will be generated for this Center
  24. Cr_by: <username> ideally name of the admin
  25. cr_dtimes: The time at which the Center is getting created
    Note: A Registration Center is needed to be created in all the languages supported by the country. if a country supports primary language as French and Secondary language as arabic, create the same registration center twice. One with language code as fra for French and one with language code as ara for Arabic. Center ID should be same for both the records as both the records are for one center only.

2.3 Create a Machine:

  1. Machine ID: This should be a 5-digit ID and Ideally should be in an incremental sequence for each machine added. The sequence should start from 10000. Keeping length other than 5 digits will fail validations as the same Machine ID is used to generate the Request ID(Registration ID)
  2. Machine Name: Machine Host name
  3. Machine Mac-Address: Machine’s Mac-Address
  4. Serial Number: <serial number of machine>
  5. IP Address: Leave it blank
  6. Mspecid: 1001. These values come from a Machine Spec table. Putting any value other than these will throw an error
  7. Zone Code: Should come from a pre-defined list of Administrative Zone codes created in Zone Masterdata. Current values can be “RBT”, “KTA”, “SAL”, “BSN”, “CSB”, ”STT”, ”NDR”, ”BRK”, “JRD”, “SAF“, “YSF“, “TTA“, “TZT”.
  8. Lang_code: eng
  9. Is_active: True
  10. cr_by: <username> ideally name of the admin'
  11. cr_dtimes: now()

2.4 Create a User

  1. Create a User in LDAP (User ID/Password)
  2. Create a User in DB
    1. Id: ID used in LDAP
    2. UIN: Leave it black
    3. Email: Email used in LDAP
    4. Mobile: Mobile used in LDAP
    5. Status Code: ACT
    6. Lang_code: eng
    7. last_login_method: PWD
    8. Is_active: True
    9. cr_by: <username> ideally name of the admin
    10. cr_dtimes: now()

2.5 Create a Device

  1. Device ID: This can be a random ID.
  2. Device Name: <Name of the device>
  3. Device Mac-Address: <mac-address of device>
  4. Serial Number: <serial number of device>
  5. IP Address: Leave it blank
  6. Dspecid: Can be either 165(fingerprint scanner), 327 (iris scanner), 736(web camera), 801(Document scanner) or 920(Printer). These values come from a Device Spec table. Putting any value other than these will throw an error
  7. Zone Code: Should come from a pre-defined list of Administrative Zone codes created in Zone Masterdata. Current values can be “RBT”, “KTA”, “SAL”, “BSN”, “CSB”, ”STT”, ”NDR”, ”BRK”, “JRD”, “SAF“, “YSF“, “TTA“, “TZT”.”
  8. Lang_code: eng
  9. Is_active: True
  10. cr_by: <username> ideally name of the admin
  11. cr_dtimes: now()

2.6 Map the User to a Zone

  1. User ID: from master_userdetail
  2. Zone_code: Should come from a pre-defined list of Administrative Zone codes created in Zone Masterdata. Current values can be “RBT”, “KTA”, “SAL”, “BSN”, “CSB”, ”STT”, ”NDR”, ”BRK”, “JRD”, “SAF“, “YSF“, “TTA“, “TZT”.”

Note: While mapping Machine, User, Device to a Center in points 2.6, 2.7, 2.8, 2.9, 2.10, these resources should belong to the same zone code. For example, while mapping a machine to a Center, both machine and a center should belong to same zone.

2.7 Map the Machine to a Center

  1. Center ID: from master-registration_center
  2. Machine ID: from master-machine_master (newly created machine)
  3. Lang_code: eng
  4. Is_active: True
  5. cr_by: <username> ideally name of the admin
  6. cr_dtimes: now()

2.8 Map the User to a Center

Follow the above example in point 2.4.

2.9 Map the Device to a Center

Follow the above example in point 2.4.

2.10 Map Center-Machine-Device

Follow the above example in point 2.4.

2.11 Map Center-Machine-User

Follow the above example in point 2.4.

2.12 Store History of MasterData

After adding all these data in the DB, we would need to create the same records in all the History tables for every table mentioned in the “Tables Names” section.

  1. Each history table has an extra attribute “effective date” other than the standard attributes mentioned for each table.
  2. The Effective date should be now().and all the attributes should be same as they are stored in the standard tables.
  3. Find the table names below for history tables
    1. Registration Centers: master-registration_center_h
    2. Machines: master-machine_master_h
    3. Users: master-user_detail_h
    4. Devices: master-device_master_h
    5. Center-Machine Mapping: master-reg_center_machine_h
    6. Center-Device Mapping: master-reg_center_device_h
    7. Center-User Mapping: master-reg_center_user_h
    8. Center-Machine-Device Mapping: master-reg_center_user_machine_h
    9. Center Machine User Mapping: master-reg_center_machine_device_h
    10. User Zone Mapping: master-zone_user_h

3. Load updated CSVs to the database using dml sql script:

Run dml sql scripts on DB server where master seed data needs to be updates.

mosip_master=#\ir '/mosip/mosip-platform/blob/master/db_scripts/mosip_master/mosip_master_dml_deploy.sql'