Fields Editor

Introduction to the new Fields Editor

The Fields Editor is where you define the data structure for your document templates. This completely redesigned interface allows you to visually create and organize your data fields without needing to understand JSON schema or other technical formats.

Getting Started with the Fields Editor

To get started with the fields editor, select the custom data source option.

When creating a new template, you have three ways to set up your fields:

1. Start from scratch: Manually define each field one by one.

2. Paste a JSON schema: Copy and paste an existing JSON schema to quickly set up your field structure.

3. Upload a JSON schema file: Import a JSON schema file directly.

Field Types

The Fields Editor supports seven fundamental field types, covering all common data needs:

1. String

For text data such as names, descriptions, addresses, and other textual information.

2. Number

For any numerical values such as prices, quantities, percentages, and measurements.

3. Boolean

For true/false or yes/no values.

4. Date/Time

For timestamps, due dates, calendar events, and other time-related information.

5. Objects

For structured data containing multiple related properties. For example, a "customer" object might contain name, email, and address properties.

6. Collections

For arrays or lists of objects with the same structure. For example, invoice line items, where each item has properties like description, quantity, and price.

7. Lists

For simple arrays of primitive values (strings, numbers, booleans, or dates). For example, a list of tags, phone numbers, or dates.

Creating Simple Fields

Adding a simple field (string, number, boolean, or date) is straightforward:

1. Click the "Add Field" button.

2. Enter a name for your field.

3. Select the field type from the dropdown menu.

Creating Complex Fields

Objects

To create an object field:

1. Click the "Add Field" button.

2. Enter a name for your object.

3. Select "Object" as the field type.

4. The object will appear in your fields list with an expandable/collapsible interface.

5. Click the "+ Add Object Field" button within the object to add properties.

6. Add as many properties as needed, of any supported type.

Collections

Collections are similar to objects but represent arrays of objects:

1. Click the "Add Field" button.

2. Enter a name for your collection.

3. Select "Collection" as the field type.

4. The collection will appear in your fields list with an expandable/collapsible interface.

5. Click the "+ Add Collection Field" button within the collection to add properties that each item will have.

6. Define the structure of each item in the collection.

Lists

For simple arrays of primitive values:

1. Click the "Add Field" button.

2. Enter a name for your list.

3. Select "List" as the field type.

4. Select the type of items in the list (string, number, boolean, or date).

Importing Field Definitions

For users who already have a data structure defined in JSON Schema:

1. Click the "Import" button.

2. Choose either "Paste JSON Schema" or "Upload JSON Schema File".

3. If pasting, enter your JSON Schema in the text area and click "Import".

4. If uploading, select your file and click "Open".

5. The Fields Editor will parse the schema and create your field structure.

Note: Currently, advanced features of JSON Schema such as references ($ref), complex validations, and dependencies are not supported. If your schema contains these elements, they will be simplified during import.

Testing Your Field Structure

Before finalizing your template, it's a good idea to test your field structure:

1. Use the "Preview" feature with sample data.

2. Check that complex fields like collections and objects display as expected.

3. Make adjustments as needed.

In the next section, we'll explore how to connect your template directly to Airtable, allowing Documint to automatically import your field structure.