How to Make Fields in Rossum Required

You may need your users to always capture value for a specific field. In such cases, Rossum should enforce capturing such a field by showing a specific message to the user. You can enable it in Rossum’s validation screen. This article will show you how to set the fields to “Required” in the Extraction schema editor and in the JSON file editor.

How to set fields to “Required” in the Extraction Schema editor

Header Fields

1. Navigate to the given queue and open its Settings.

2. Click on the “Fields to capture” tab.

3. Hover over the field and click on the “OPT” option to make it required (OPT is going to change to the asterisk symbol *).

4. You can also go to field details (by clicking on arrow “>” icon) and here mark the field as required.

Line Items

1. Navigate to the given queue and open its Settings.

2. Click on the “Fields to capture” tab.

3. Scroll down to the Line Items section, and click on “>” icon to open details.

4. Scroll down to the list of columns.

5. Here you can decide if the field should be optional or required.

How to set fields to “Required” in the JSON code editor

Header Fields

1. Select a queue and open its Settings.

2. Click on the “Edit JSON” button.

3. Click on the field you would like to make required.

4. Set the field to be required in the constraints attribute of the datapoint

The image above shows that the required attribute was set to true and that the field in the left sidebar contains an asterisk “*” mark that tells you the field is required.

Once you save the Extraction schema you’ll see, now in the validation screen, a red asterisk next to the edited filed, again telling you that this field is required.

You will see the following message below the field if no value is captured, and this will prevent the document’s confirmation, something indicated with a red icon next to the confirmation button.

Line Items

You can set line items as “Required” as well. Follow the same steps as when making the header fields required.

After saving the Extraction schema you should be seeing the following message for the required fields with no captured value.