Documentation for Administrators

Imports: Understanding the Significance of Import Keys and Method in the Data Import Process

Updated on

Import Keys play an essential role in guiding the behavior of how data gets imported based on a  chosen Import Method. Therefore, the correlation between both of these elements and especially the pivotal role of Import Keys cannot be overstated as they ensure the integrity and accuracy of imported data.

Executing an import job will always require that both keys and a method are defined in its settings. This can happen by default or with the help of user input. Then, as the process is prompted to execute an import, it will first compare the contents from the data that's been successfully validated against what's available in the destination table(s) of the database, specifically referencing the combination of Import Key values between both, to apply logical import method rules as follows:

Import Method Rule
Delete and Insert The process will first delete the corresponding matching records from the database and then proceed to add all valid records of the import job.
Insert Only The process will add all valid non-matching records of the import job to the database while ignoring those that matched.
Update Only

The process will update* the corresponding matching records in the database while ignoring all the non-matching ones.

Update or Insert The process will first update* the corresponding matching records in the database and then proceed to add all other valid non-matching records of the import job.

The process will update the corresponding matching records in the database while ignoring all the non-matching ones.

When an import method that involves an update is executed, the import key fields themselves don't get updated in the database but all other mapped fields in the import job will.

Import Key Configuration

The Imports module provided by Focus School Software allows configuration and management of Import Keys in its general Settings and for each available import tool. This flexibility aims to promote process adaptation to varying import scenarios, ensuring optimal performance across different datasets and import tasks.

The configured Import Keys in the Imports general settings are considered standard and will apply by default to all import jobs. In general, they cannot be changed by the user that's executing an import, however, should a different set of import keys be needed for a given set of data files, the Allow Import Key Override option provides a mechanism for handling specific import key requirements on an import-by-import basis. This can be accomplished without having to alter the standard options defined in the general settings, offering users a practical solution to address unique import challenges more effectively.

Additionally, whenever Import Keys are changed they can always be restored to their original settings by clicking the restore button that's located next to the corresponding dropdown, however, it's important to understand that restoring them can occur at both the general settings and import levels while producing different results:

  • Restoring Import Keys in the Settings tab resets them to the default system configuration.
  • Restoring Import Keys at the import level aligns them with the pre-established configuration defined in the general settings.

Import Keys are the backbone of data import processes, guiding the transformation and integration of data with precision and accuracy based on the selected Import Method. By understanding their significance and functionality, users can streamline import operations, enhance data quality, and unlock the full potential of their import processes.

Next Article ACCESS for ELLs (WIDA)