Skip to main content
An image field lets you save parts of documents as pictures. For example, this can be useful when dealing with identity photos, signatures, or stamps. You can add an image field by clicking the Add Image icon. Add the image region if needed, note however that image fields cannot be trained. For each document that has an image field, you will have to find that image and set its region either during manual review or using a Custom activity script. The image field may not have several regions.

​
General properties of the Image field

  • Field name. The unique name of the field in a particular skill. The field name cannot contain special characters like full stops, commas, slashes, colons, asterisks, question marks, quotation marks, less-than signs, greater-than signs, or vertical bars. The maximum allowed length of a field name is 90 characters.
  • Required field. Specifies that the value of the field cannot be left empty. Enabling this property adds a validation rule to the page. If the field is empty after extraction, the document will be sent to manual review with an error.
  • Allow multiple items. Specifies that the field may have several instances. For example, if an agreement is signed by several parties, you may want to extract all signatures as instances of the same image field.

​
Working with extracted images

During data export, the image is extracted using its region coordinates and saved in JPG format. You will be able to access the images in the same way as the other extracted data:
  • Via Vantage API.
  • In Custom activity or Output activity (external system) scripts. The Field object has a Value property that stores the filename and an Image property with the binary representation of the image.
  • Using Shared Folder export set up in your Output activity. If a document has image fields, the JSON file containing the document data will store the filename of each image in the value key of the corresponding image field. The image files will be placed into a subfolder with the same name as the JSON file.

​
File naming

Image file names follow the naming scheme below:
  • An image extracted from a field inherits the field name as its file name. For example, if an image field is called Signature, the resulting filename is Signature.jpg
  • If a field has several instances, the filename for each gets a postfix with the instance number, separated by an underscore. For example, if a signature field has two instances, the filenames will be Signature_1.jpg and Signature_2.jpg.
  • If the field is part of a group or a group of groups, the filename will contain the full path to the image field, with an underscore as the separator. For example, if a signature field is a child of the Group2 group of fields, which is in turn a child of the Group1 group of fields, the resulting filename will be Group1_Group2_Signature.jpg.
Note: If a filename created according to this naming scheme turns out to be longer than 256 characters (including all separators, postfix numbers, and the file extension), an alternate naming scheme will be used: Field_{Guid of image field}.jpg.

​
See also