Annotations table
Administrators can export annotations to a Ringtail load file and import annotations from a Ringtail load file.
The following table describes the fields in the annotations table.
| Field |
Type |
Size |
Mandatory |
Description |
| Document_ID |
Text |
255 |
Yes |
A unique ID for each document in the case. IDs can include numbers and alphabetic characters, but not Unicode characters. |
| file_name |
Text |
255 |
Yes |
The name of the file that represents the image with the highlight or redaction. This field is used to connect the highlight or redaction to the file. |
| page_num |
Number |
|
Yes |
The page number of the file in which the annotation exists. For example, for a single-page TIFF, this is page 1. For a multi-page TIFF, this is the page number that the annotation is on. |
| annotation_type |
Text |
255 |
Yes |
Redaction or highlight. |
| annotation_name |
Text |
255 |
Yes |
The name of the annotation. |
| label |
Text |
255 |
No |
Label for the redaction or highlight. |
| color |
Text |
255 |
Yes |
The color of the redaction or highlight. |
| theNote |
Text |
255 |
|
Currently blank and not available. |
| note_parent_id |
Text |
255 |
|
Currently blank and not available. |
| private |
Text |
255 |
|
Currently blank and not available. |
| x1 |
Number |
|
Yes |
The x1 coordinate of the annotation. |
| x2 |
Number |
|
Yes |
The x2 coordinate of the annotation. |
| y1 |
Number |
|
Yes |
The y1 coordinate of the annotation. |
| y2 |
Number |
|
Yes |
The y2 coordinate of the annotation. |
| loginname |
Text |
255 |
Yes |
The login name of the user who created the annotation. |
| datestamp |
Date/Time |
|
Yes |
The date/time the annotation was created or updated. |
| full_page |
Text |
|
|
Currently defaults to 0 if x/y coordinates exist, otherwise -1 to indicate a full-page annotation. |