Import Person from CSV file

2022-07-01

Written by: Ahsan

This document describes the step-by-step process for importing persons into the system using a CSV file, along with how checks and validations are handled during the import.

Todo

• Show only error cases after import.
• Display count of successfully imported records.
• Add “Choose File” step in the import flow.
• If check info is not provided, mark the case as INSUFF.
• Show on admin portal if the service has not run.

1. Select the Company

Before starting the import process, you must select the company into which the persons will be imported.

• This ensures that all imported records are correctly associated with the chosen company.
• The selected company context will also determine available checks and configurations.

2. Select Checks for Each Person

Choose the checks that should be created for every person in the CSV file.

• Checks define the type of verification or validation performed on each person.
• Different checks may require different data fields.
• The selected checks directly influence the required columns in the CSV file.

3. Choose the CSV File

Select the CSV file from your system that contains the person records to be imported.

• This step allows you to browse and pick the correct file before uploading.
• Ensure that the file you choose matches the expected structure and required columns.
• Only valid CSV files should be selected to avoid import issues.
• The valid and invalid rows are shown after selecting the csv file.
• Examples of failure reasons:
  • Missing required fields
  • Invalid data format
  • Inconsistent or unsupported values
• If there are redundant columns then before import it will show redundant columns.

4. Upload the CSV File

Provide a CSV file containing one row per person.

• Each row represents a single person record.
• The file must follow the expected structure and format defined by the system.

5. Ensure Valid Data for Required Columns

Each row in the CSV must contain valid data for all columns required by the selected checks.

• Required columns include:
  • Base columns (common for all imports)
  • Additional columns required by selected checks
• Missing or invalid required data may cause the row to fail during import.
• Data should follow expected formats (e.g., date formats, unique identifiers).

6. Start the Import

Once the file is uploaded and validated, initiate the import process.

• The system begins processing each row.
• Validation and check creation are performed during this stage.
• This operation may take some time depending on file size and complexity.

7. Import Results Summary

After processing is complete, the system provides a summary of the import results.

• Displays:
  • Number of successfully imported rows
  • Number of failed rows
• Gives a quick overview of the import outcome.

8. Failure Details for Each Row

For every row that fails to import, the system provides a detailed reason.

• Examples of failure reasons:
  • Missing required fields
  • Invalid data format
  • Inconsistent or unsupported values
• This helps in correcting the data.

9. Service Invocation for Checks

For checks that have associated external or internal services:

• The system automatically invokes the corresponding service after creating the check.
• This ensures that:
  • Verification processes begin immediately
  • Results are generated without manual intervention

Conclusion

Following the above steps ensures a smooth and reliable import process. Proper data preparation and validation are key to minimizing failures and ensuring successful execution of checks.