Schema
A schema is the data output format you expect from Capyflow. Everything Capyflow do is to try to fit the data, into your schema, and if it’s not possible automatically, we do it hand to hand with your user.
Once a Schema is created, you can’t modify it. It’s a decision we made to keep data consistent with data that could have been imported with a different version of the schema. So if you want to update schema, you have to create a new one (then link it to the importer).
Fields
A schema can have an unlimited number of “fields”. It’s like the “columns” of a CSV file. A schema field contains following data:
| Name | Type | Description |
|---|---|---|
| Verbose name | string | Showed to the user in the header of the table in the import portal |
| Internal name | string | Used when you pull the data, the name of the json’s field |
| Is required | boolean | Define if the field is required or not |
| Data type | data-type | The type of the expected data |
| Rule | rule | Custom rules you can add to the data type |