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. To configure your account, you can either use API, elisctl command line tool or you can edit the settings directly using the Rossum app user interface very easily.

To open it, go to the Queues settings screen and select a Queue, then click on the “Edit schema” button in the upper right corner:

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 on the user’s Validation Screen.

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

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 datapoint. To create a table, add a new multivalue field (i.e. the grid) with tuples in it (i.e. rows). The schema must contain at least one section, that works as a container for more fields.

As you edit the Extraction Schema, the editor generates a preview in the sidebar in real time.

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

Once you’re finished with your updates, you can save your Extraction Schema so that Rossum applies it to your selected Queue and you can start using it for extraction. You can also discard the new changes and resume updating from the last saved version instead.