Flatfile | Getting Started

Deploying Flatfile: Project Checklists

Deploying Flatfile: Project Checklists

Recommended reading: How to start using Flatfile

Recommended Portal demos: Portal playgrounds

On your website (Portal):

Business configuration:

  • Define your data model(s)
    • Type(s) of data you are onboarding
    • The validation requirements for accepted data
    • Required/Optional/Custom data that might be accepted
    • Any information from external systems that would be useful as data is being imported (internal system validation errors, duplicate information feedback, etc)

Technical configuration:

  • Configure your website to launch Flatfile (NPM package or CDN)

  • Set Portal's configuration options

    Required:

  • Set up your Portal field config with the identified data model(s)

    Note: You will want a different configuration launched for each type of primary data you are importing

    • Field validation
      • Required/accepted fields
      • Regex validation for each field
      • Default error to be displayed to the user (see Data Hooks below for advanced error/warning/notification messaging)
    • Dynamically supplied changes to the launched config
  • Configure Data Hooks for normalization, advanced validation, and advanced messaging (validation within the data being imported, as well as from external libraries or your own system)

    • Within a single field (Field Hook)
    • Across multiple fields in the same record (Row Hook)
    • Advanced messaging and errors
  • Pull submitted data into your system

    • Via API
    • Via webhooks
    • (Skip this step if files will be downloaded manually from the Flatfile dashboard)

Design configuration:

End user/testing:

  • Launch the importer from your application

In a secure online data workspace (Concierge):

Business configuration:

  • Define data model
    • Type(s) of data you are onboarding
    • Validation requirements for accepted data
    • Required/Optional/Custom data that might be accepted

Data template configuration (either no-code or technical configuration):

  • Set up your [field config] with the identified data types and properties
    • Note: You will likely want a different configuration for each type of primary data you are importing
    • Required/accepted fields
    • Regex validation for each field
    • Error messaging to be displayed to the user
  • Add advanced validation or normalization: Contact the Flatfile team to configure

Collaborate:

  • Send an invitation to collaborate
  • Import/merge/add additional files
  • Manually add corrections
  • Approve complete data

Collect:

  • Download completed/approved data sets