Field value source explained
In Rossum, you can set the source of field values to make the annotation process smoother and more efficient. There are four types of fields: Captured, Data, Formula and Manual. Each has its own features and lets you decide if annotators can edit the field value.
We know that different fields need different annotation methods. By adding these new attribute and editing options, we aim to help users improve document processing, avoid mistakes, and keep their automation capabilities while preventing wrong data from entering other systems.
Different value source options
Captured field
Our AI directly extracts the Captured field value from the document. Its icon is a partial square and it always includes a bounding box when selected.
Data field
The Data field gets its value from extensions like Master Data Hub or other data sources you have set up. It has a icon made of 4 small squares and when selected, it does not have a bounding box.
Manual field
The Manual field is for annotators to manually type in values and is not linked to any data source. It does not have a bounding box and can be easily recognised by it’s icon with lines.
Formula field
Formula fields let you easily transform your data right within the app. You can create formulas to set field values, whether it’s for normalizing data, performing calculations, or doing text operations.
Unset (kept for backward compatibility)
Unset is a value source used only for backward compatibility. It can be recognised in the schema as it lacks both the field type and the editing options. Users can change it’s value by adjusting the bounding box or typing in a new value.
Nothing changes for our existing customers’ queues. You can switch between the new and Unset type fields. New clients will be using the new fields by default.
With new feature, the navigation on the annotation screen will change slightly. When you press the Tab key on your keyboard, it will direct you to fields that usually need your attention, such as Captured field. This will result in Data fields and Manual field being skipped.
Editing options
The editing options of a field refer to the user’s ability to modify the data within the field during annotation. This can be by either moving, redrawing the bounding box, or simply typing in a value. Available options are “Enabled”, “Enabled without warning” and “Disabled” (explained in the table below). When disabled, users are partially or completely restricted from changing the value. Though it is important to note that this restriction only applies to the app, the value can still be changed via API.
Value source | Enabled | Enabled without warning | Disabled |
|---|---|---|---|
Captured | Users can modify the field by moving the bounding box or simply typing in the value. It’s recommended to modify a field only by adjusting it’s bounding box if possible. The messages suggesting how to edit the field in the best way is displayed. | Users can type and edit the text in the field. You will not see any messages suggesting how to edit the field in the best way. | The only way to modify the extracted value of this field is to move the bounding box’s position. The value cannot be typed in. Hovering on a field, users will see the message: “Text editing is disabled.” |
Data | Users can modify the field’s data by simply typing in the value. The messages suggesting how to edit the field in the best way is displayed. | Users can type and edit the text in the field. You will not see any messages suggesting how to edit the field in the best way. | The value is read-only and cannot be modified. Hovering on a field, users will see the message: “Text editing is disabled.” |
Manual | - | - | - |
Formula | Users can type in the value. | - | The value is read-only and cannot be modified. Hovering on a field, users will see the message: “The value is defined by formula.” |
Unset | - | - |
Setting up value source and editing options
In Rossum’s queue schema editor, users have the ability to fine-tune both value source and editing options.
New queues created from the templates automatically include the field value source. Nothing changes for existing queues.
Setup in the Rossum schema editor
Navigate to the “Queue Settings”
Click on the “Fields to capture” tab
Select the field and click on the arrow icon (“>”) to move to the field details
In the field’s edit window, choose the “Value source” and “Editing” to match your preferences
Save your changes, and you are all set to use this field in your workflow
Existing customers will be able to see “Unset” as a field type option; this will imitate previous field behaviour.
Setup in the JSON code editor
Navigate to the “Queue Settings”
Click on the “Fields to capture” tab
Click on the “Edit JSON” button
Click on the field you would like to adjust
Specify the “type“ and “edit“ attributes within the ui_configuration attribute of the datapoint (you can find more details here) e.g.
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}