An Introduction to Data Imports
The Import Module is designed to bring external data from structured files like CSV, TSV, JSON, or XML directly into your forms. The entire process is built around a central concept: the Import Configuration.
Think of an Import Configuration as a reusable blueprint or a saved set of instructions. You create it once, and it tells the system everything it needs to know about how to handle a specific data file and where that data should go.
What is an Import Configuration?
An Import Configuration is a collection of rules that defines a complete, end-to-end import process. Each configuration is saved with a unique Alias (a technical name) so that you can easily link it to one or more forms.
Every configuration contains rules for four key areas:
This defines where to find your data file and how to read it. You'll specify the file's name and location, its format (e.g., CSV, JSON), and other details like date formatting.
2. Data Processing
This section controls how the data is handled before being matched. You can apply optional Data Transformations here to restructure complex XML or JSON files, or define a sort order for your data rows.
3. Person Matching Rules
These rules tell the system how to connect each row in your file to the correct person in the system. You'll specify which column in your file contains a unique identifier (like a Student ID) and which field in the application it should be matched against.
4. Record Matching Rules
This is an advanced set of rules that allows you to route data to a specific record belonging to a person, such as updating a "Term 2" report card instead of their most recent one.
Once an Import Configuration is created and saved, it doesn't do anything on its own. You must connect it to your forms by selecting its Alias in the Import Panel of a form element. This creates the link that allows data to flow from your file, through the configuration's rules, and into the correct fields on your form.
A single, well-defined configuration can be used to populate fields across many different forms, making it a powerful and efficient tool for data management.
Next Steps
Now that you understand what an Import Configuration is, the next article will walk you through creating one step-by-step, covering each section of the configuration page in detail.
Next Article: Configuring an Import: A Section-by-Section Guide
Related Articles
Introduction to Import Data Transformation
Sometimes, the data in your source file isn't in the exact structure or format that your forms require. Data Transformation is an optional but powerful step in the import process that allows you to clean, restructure, and manipulate your source data ...
Introduction to Exporting Data
Overview The Export Module is a powerful tool that allows users to transform and export data from your platform into different formats, such as XML, JSON, and CSV. By leveraging XSLT 1.0 (Extensible Stylesheet Language Transformations), the module ...
Advanced Mapping: Importing Data into Repeaters
A repeater allows a section of your form to be duplicated, which is perfect for lists of information like emergency contacts. This guide explains how to map data from your import file to the fields inside a repeater. Before you begin, ensure your ...
Introduction to Field Mapping
Once you have an Import Configuration set up, the next critical step is field mapping. This is the process of telling the system exactly which column from your source file should populate which field on your form. This connection is made directly ...
Best Practices and Common Pitfalls
Building a successful import process involves more than just correct configuration; it also requires a solid workflow to prevent common errors. This guide outlines best practices for testing, data validation, and file management to help you create ...