Datasets

TABLE OF CONTENTS

• What is a dataset?
• When to use datasets
• Opening the Dataset tab
• Dataset tab layout
• Inbound data
• Filter
• Result
• Examples
• Considerations

What is a dataset?

Add local JSON data to a template and make the result available in the information tree.

A dataset is a local JSON data structure that you add directly to a template in the editor. After it has been added, the dataset result can be used in the template, for example to prefill form fields when configuring information tree building blocks.

A dataset consists of three parts:

• Inbound data: The raw JSON you define or paste into the editor.
• Filter: An optional transformation applied to the inbound data.
• Result: The output of the filter, or the inbound data if no filter is configured.

Datasets are stored locally in the template. They are not shared across templates and are not persisted to a central data store.

When to use datasets

Use datasets when you have data that is known at template-build time and you want to make it available in the information tree without connecting to an external data source.

Common use cases include:

• Providing a fixed list of options for a select field, such as departments or product categories.
• Filtering or reshaping inbound data before exposing it to the information tree.
• Normalizing date formats so they are consistent across the template.
• Combining values from separate fields into a single output string.

Opening the Dataset tab

The Dataset button is available in the top-right area of the editor toolbar. Click the button to open the Dataset tab.

Datasets button

From the Dataset tab, you can add a dataset to the document and configure its inbound data and filter.

Dataset tab layout

The Dataset tab uses a three-column layout:

Overview of the dataset tab

Inbound data

The Inbound data column contains a JSON editor. Enter or paste valid JSON into this editor to define the data that the dataset works with.

The JSON must be valid. If the editor contains invalid JSON, the filter cannot be run and the result pane will not update.

Filter

The Filter column is optional. Use it to configure a transformation that is applied to the inbound data before it is made available in the document.

After configuring a filter, click Run to execute it. The output appears in the Result column.

If no filter is configured, the result is the inbound data as-is.

Result

The Result column shows the final dataset output after the filter has been applied. This view is read-only.

Examples

Pre-select an option in a select building block

Use a dataset to transform an inbound value into the structure expected by a Select building block. A Select building block requires an object with an option property that references the name of the element to select, and a data object that contains the values to insert into that element.

In this example, the recipient's department determines which office location is selected in the template.

Map inbound data to a Select building block

{
  "recipient": {
    "name": "Jane Doe",
    "department": "Legal",
    "office": "Copenhagen Office",
    "location": "Wilders Plads 15A, Copenhagen"
  }
}

{
  offices: {
    option: recipient.office,
    data: {
      Name: recipient.office,
      Location: recipient.location
    }
  }
}

{
  "offices": {
    "option": "Copenhagen Office",
    "data": {
      "Name": "Copenhagen Office",
      "Location": "Wilders Plads 15A, Copenhagen"
    }
  }
}

The option value must match the name of an element configured in the Select building block. If the office name from the external system does not match exactly, use replace or if in the filter to normalize the value before passing it through.

Filter a list to a relevant subset

When the inbound data contains more entries than are needed in the template, use a filter condition to return only the relevant items.

{
  "products": [
    { "name": "Widget A", "active": true },
    { "name": "Widget B", "active": false },
    { "name": "Widget C", "active": true }
  ]
}

products[?active == `true`]

[
  { "name": "Widget A", "active": true },
  { "name": "Widget C", "active": true }
]

Only active products are passed through to the information tree.

Normalize a date format

Use to_datetime and format to convert a raw date string to a usable format before it is used in the template.

{
  "contractDate": "2025-02-19T00:00:00Z"
}

{
  contractDate: format(
    to_datetime(contractDate, 'dd-MM-yyyy', 'en-US'),
    'MMMM d, yyyy',
    'en-US'
  )
}

{
  "contractDate": "February 19, 2025"
}

The normalized date string is available in the information tree under contractDate.

Join two fields into a single value

Use join to combine two string fields from the inbound data into one value, such as a full name composed from a first name and a last name.

{
  "firstName": "Jane",
  "lastName": "Doe"
}

{
  fullName: join(' ', [firstName, lastName])
}

{
  "fullName": "Jane Doe"
}

The combined value is available in the information tree under fullName.

Considerations

• Invalid JSON: The JSON editor does not block the editor from functioning, but a filter cannot be run while the inbound data contains invalid JSON.
• Large datasets: Very large datasets may affect editor performance. Keep inbound data limited to what is needed for the document.
• Filter expressions: Filter logic is evaluated locally. Consider variations in the inbound data that may cause the filter to fail.

Coming soon: An AI assistant for datasets will help write and validate filters directly in the editor.