Getting your Importer properly configured and running can be challenging if you're not implementing the correct tools. In this quick start guide, you'll learn how to use methods that are accessible in jQuery's library to activate features of the Importer for ease-of-use. Along with our code examples, we'll discuss how to handle the data output and field configuration for desired output.
Obtain your license key
Before we begin we'll need to initialize the application, please have your License Key ready to start this process. You can find out how to obtain the key by navigating to the Licenses option under the Account settings.
CDNs can offer a performance benefit by hosting jQuery on servers spread across the globe. This also offers an advantage that if the visitor to your webpage has already downloaded a copy of jQuery from the same CDN, it won't have to be re-downloaded.
Here's an example of the script used to access the jQuery library depending on your preferred CDN host and version of jQuery. This script can be inserted before the ending
tag in your html file. In this snippet, the Google CDN is utilized with compressed jQuery library version 3.4.1
Use the license key found in your Account settings here link back to Get license key
const LICENSE_KEY = 'PASTE YOUR KEY HERE'
Field configuration for desired output
Mapping a user's data to your data model can be a tedious process, in this section we'll discuss how to setup your importer and configure the fields according to your database. If you'd like more information on the extent of fields, please refer to this guide: Field Config
If the output you'd like to receive from your user looks like this below:
This configuration tells Flatfile how to build the UI necessary to help a user map their data to your database. You can provide helpful validators and describe a field to help the user understand what type of data to input.
Here's an example of what your Importer will display with the configuration above with Full Name and Email Address
How to handle the data output
This creates a background request to your API
If you don't have an API already here's information on how to handle the data
Enable managed:true and then you can access the data directly from Flatfile's API / UI
How does Flatfile work?
Flatfile helps you reduce friction on imports by eliminating the need for your customers to rework their files prior to upload and increasing the success rate on their first attempt with our easy-to-use, purpose-designed interface.
Where does my data go and is it secure?
By default, 100% of the data processing happens in the browser. This ensures your customer's sensitive data is never transmitted to our servers or compromised in any way.
Only the filename, header row, and stats about validation, row, and column count are sent to our servers, securely encrypted and stored in your upload log. This allows you to review and debug what your customers are importing.
Most modern browsers are capable of handling processing over 1 million records without choking. Once the browser has finished processing the incoming data you decide where it goes. You can upload it to your own server, Amazon S3 and more.
Can I have a dropzone on my page?
Yes, for ease of use Flatfile does integrate a drag and drop feature for your files. See it live here: Demo