Preparing an extraction schema is one of the most important tasks you need to do when configuring Rossum. You have a lot to define, including the names and formats of data fields you want to extract, necessary value constraints, and, if you’re using them, enum options.

In order to correctly configure the data fields, go to the Workspaces & Queues settings screen and select a queue, then click on the “Edit schema” button in the upper right corner:

Exploring the schema editor

You can now see the extraction schema in JSON for your selected queue. The left sidebar shows a preview of your schema as it will appear in a user’s validation screen.

Using this editor, you can do all the extraction schema configuration: add custom fields, change label names, edit field types and formatting, and do other similar changes to any field attribute.

Extraction schema structure

When working with the JSON file, note the structure of the file and appropriate level of nesting. Be careful when distinguishing between the field types and their relations to each other.

The basic element is the data field. However, Rossum enables to capture even more complex structures like tables. To create a table, add a new multivalue field (i.e. the grid) with tuples in it (i.e. rows). Moreover, the schema must contain at least one section, that works as a container for more data fields.

Updating an extraction schema

As you edit an extraction schema, the editor generates a preview in the sidebar in real time.

The schema editor also displays syntax and semantic errors and constraints as you write so you can make corrections immediately. 

Saving schema changes

Once you’re finished your updates, you can save your extraction schema so that Rossum applies the updates to your selected queue and you can start using it for extraction. You also have the option of discarding your new changes and resuming your updates from the previously saved version.

You can get more information on how to customize schema in Rossum also in the following video.