Core Concepts
Our embeddable Importer SDK provides the building blocks for scaling the import of diverse and messy data.
Often, data from your customers, suppliers, or partners is not formatted or structured as required by your system. Handling this mismatch manually can significantly drain time and resources during data onboarding.
With our AI-powered column and option mapping, along with fully customizable transformation functions, even your non-technical users can effortlessly import clean data.
Our Importer SDK is fully customizable to meet your specific requirements. Depending on your use case, the import workflow can include more or fewer steps. Typically, our importer guides users through three main steps: uploading files, matching columns, and reviewing the transformed and cleaned data.
- Upload your file(s): Users can upload one or multiple files by either dragging them into the drop zone or pressing the "Select file" button. We currently support XLS(X), CSV, TSV, XML, and JSON files. The UI is fully customizable (white-label) to match your corporate identity and can be implemented with only a few lines of code.
- Match columns: Our nuvo AI restructures the data and matches the imported columns to the columns in your defined output schema. It learns from initial imports, so if a similar file structure is uploaded in the future, this step can be skipped. During this process, users can confirm recommended matches and create new mappings if necessary.
- Review entries: In this step, users review the restructured data, resolve potential errors either manually or by utilizing our nuvo AI for data cleaning, and submit their data. You can flexibly define what should happen with the submitted and cleaned data, whether it should be downloaded directly as an Excel file or sent to your preferred target destination via an HTTP call.
nuvo’s power lies in its intuitive UI, AI-powered mappings, and flexible data validation and cleaning functions. After the upload, nuvo reorganizes the data. Once the mappings are complete, the cleaning functions you configured take effect, validating and transforming the imported data into the desired format. With nuvo, you can release an advanced importer to your users in days, not months.
Core Concepts
Before diving into the details of how to set up your own nuvo importer, let’s review the most important concepts and elements of nuvo.
Target Data Model (TDM)
The most essential element of our importer is the target data model (TDM), which reflects the data structure required by your system. The TDM includes column labels, validation rules such as required, uniqueness, regex, and cross-column validations, and column types, our interpretation and extension of data types, such as string, int, float, country code, currency, email address, and many others.
You can create your preferred TDM in our user platform using one of the following four methods:
- Generate from an existing file
- Use the no-code generator
- Feed prompts to our nuvo AI
- Write the TDM code manually
Please note, the TDM can be generated dynamically within your application in real time, allowing you to present a customized and personalized schema to each user. It can be generated before initializing the importer and then inserted during runtime.
Cleaning Functions
Our cleaning functions are callbacks that are triggered after specific events. These functions allow you to transform imported data into the desired format and provide feedback to the user. Typical use cases include correcting date formats, enriching entries, comparing imported data against your database or third-party services, validating cross-column dependencies, and flagging duplicates with customizable error messages. Cleaning functions provide full flexibility for adding your own cleaning logic in JavaScript/TypeScript.
dataHandler Functions
Our dataHandler
functions perform more advanced cleaning functions that offer even more flexibility for validating and manipulating data, covering scenarios such as transposing, merging, splitting columns, joining sheets, and nesting as well as de-nesting data, and more.
Unlike our standard cleaning functions, which iterate through each row or access specific columns individually, the dataHandler
functions operate on the entire dataset at once. This provides complete control over the data immediately after it is uploaded and after it has been mapped inside the mapping step. Whether you need to transform a few columns or an entire dataset, the dataHandler
functions offer the flexibility and power needed for efficient processing. Additionally, they allow access to the file’s metadata such as the name, size, and extension. Like our cleaning functions, you can implement any logic using JavaScript/TypeScript.
Dynamic Import
The Dynamic Import feature allows you to trigger an import based on various events, such as user interactions or receiving data from an external source. Additionally, you can initiate the import process at different stages, such as starting directly at the mapping or review steps, with your preferred data. This feature offers the flexibility to customize the import workflow to meet your specific requirements.
Advanced Parsing
Our advanced parsing feature enables users to upload nested JSON files up to five levels deep, as well as complex XML files.
Smart Table
This feature adds Excel-like functionality to the nuvo importer in the review step, making it easier and quicker for users to resolve potential errors during the import process. For example, users can sort, filter, freeze, and hide columns, as well as find and replace values.
Knowledge Base
nuvo’s knowledge base includes 70+ sandboxes, providing real-life examples that you can incorporate into your nuvo importer. To access them, log into the nuvo user platform, click on the SDK section in the sidebar, and select the "Knowledge Base" tab.