Blueprint definitions that define the structure and validation rules for your data in Flatfile
string
Field that is required
and another a number
Field with a decimalPlaces
config.
enum
field with a status
key, Customer Status
label, and Current status of the customer
description. It also defines four options for the field: active
, inactive
, pending
, and suspended
.
string
- Basic text datanumber
- Integer or floating point numbersboolean
- True/false valuesdate
- GMT date values in YYYY-MM-DD formatenum
- Single selection from predefined optionsstring-list
- Array of string valuesenum-list
- Multiple selections from predefined optionsreference
- Single reference to another sheetreference-list
- Multiple references to another sheetstring
string-list
number
enum
100
. For multiple selections, use enum-list
.
config.allowCustom
Permit the user to create new options for this specific field.
config.sortBy
The field to sort the options by (label
, value
, ordinal
).
config.options
An array of valid options the user can select from:
enum-list
enum
when users need to select multiple options.
config.allowCustom
Allow users to create new options for this field.
config.sortBy
Sort options by: label
, value
, or ordinal
.
config.options
Array of option objects:
boolean
true
or false
value type. Usually displayed as a checkbox.
config.allowIndeterminate
Allow a neither true or false state to be stored as null
.
date
YYYY-MM-DD
format in order for it to be considered a valid value.
reference
refField
value matches the current record’s recordField
value will be available as options.
ENUM_REFERENCE
sheet treatment, may be collectively referred to as Dynamic Enums. By combining these two features, you can create a drop-down list for any cell in your sheet that’s dynamically controlled by the value of another field in the same record – and to the end-user, it will just work like a dynamically-configured enum
field.filter
property accepts a ReferenceFilter
object with two required properties:
Property | Type | Description |
---|---|---|
refField | string | The field key in the referenced sheet to filter with |
recordField | string | The field key in the current record used for filtering |
recordField
of the current recordrefField
matches that valueENUM_REFERENCE
sheet treatment to hide the reference sheet from the UI. You may wish to disable this treatment for testing purposes.country-name | state-name |
---|---|
USA | California |
USA | New York |
USA | Texas |
Canada | Ontario |
Canada | Quebec |
Filtering for USA States based on the selected country
Filtering for Canadian Provinces based on the selected country
If data is imported that does not match the filtered options, it will result in a validation error
reference-list
filter
property on reference-list
fields works identically to reference
field filters, but allows for multiple selections.
department | category | subcategory |
---|---|---|
Electronics | Computers | Laptops |
Electronics | Computers | Desktops |
Electronics | Computers | Tablets |
Electronics | Audio | Headphones |
Electronics | Audio | Speakers |
Clothing | Men’s | Shirts |
Clothing | Men’s | Pants |
Clothing | Women’s | Dresses |
Clothing | Women’s | Shoes |
Books | Fiction | Novels |
Books | Fiction | Short Stories |
Books | Non-Fiction | Biography |
Books | Non-Fiction | History |
config
object with the constraint.
For example:
config
object with the constraint — see the example with the required constraint above.
readonly
On a field level you can restrict a user’s interaction with the data to readonly
. This feature is useful if you’re inviting others to view uploaded data, but do not want to allow them to edit that field.
Option | Type | Required | Default | Description |
---|---|---|---|---|
key | string | ✓ | The system name of this field. Primarily informs JSON and egress structures | |
type | string | ✓ | One of string , number , boolean , date , enum , reference , string-list , enum-list , reference-list . Defines the handling of this property | |
label | string | key | A user-facing descriptive label designed to be displayed in the UI such as a table header | |
description | string | A long form description of the property intended to be displayed to an end user (supports Markdown) | ||
constraints | array | [] | An array of system level validation rules (max 10). Learn more about field constraints | |
config | object | Configuration relevant to the type of column. See type documentation below | ||
readonly | boolean | false | Prevents user input on this field | |
appearance | object | UI appearance settings. Currently supports size property with values: "xs" , "s" , "m" , "l" , "xl" | ||
actions | array | [] | User actions available for this field. See Field Actions for detailed configuration |