Field Descriptions
The fields in the following table are built-in to ReadySuite. Fields built-in to ReadySuite are always suffixed with an asterik (*) character at the end of the field name. These are also referred to as system fields.
Note: System fields cannot be directly edited on the Document Grid View or by using the Document Fields.
| Field Name | Field Type | Level | Grid Visible | Description |
|---|---|---|---|---|
| Selected* | Boolean | Document | Y | Indicates if the document is marked/checked in the checkbox. |
| FileCategory* | Text | Document | Y | File category assigned to the document based on the native file extension. |
| DocID* | Text | Document | Y | Document identifier or control number. Default overlay field. |
| BegDoc* | Text | Document | Y | Starting (bates) number assigned to the document based on the page information. |
| EndDoc* | Text | Document | Y | Ending (bates) number assigned to the document based on the page information. |
| BegAttach* | Text | Document | Y | The starting attachment range; value is empty if document is not a part of an attachment group. |
| EndAttach* | Text | Document | Y | The ending attachment range; value is empty if document is not a part of an attachment group. |
| AttachIDs* | Text | Document | Y | Contains a delimited list of child documents values using the DocID* field. |
| AttachRange* | Text | Document | Y | Combines values of BegAttach* and EndAttach* separated by a hypen. |
| DataSource* | Text | Document | Y | Name of the file, folder, or volume used to import or create the document record. |
| ParentID* | Text | Document | Y | For child records, value is from the parent DocID* field. All other records value is empty. |
| GroupID* | Text | Document | Y | For parent or child records, value provided is from the parent DocID* field. If no family information, value is empty. |
| LoadOrder* | Number | Document | Y | Indicates the position of the record from it's originating source file. Can be used to sort in load file order. |
| PageCount* | Number | Document | Y | Number of pages in the document. If the document is empty, the value shown will be 0. |
| PageLevel* | Text | Document | Y | Indicates if the page files for the document are single ('Per Page') or multi-page ('Per Document'). Value is empty if no page information exists. |
| HasPages* | Boolean | Document | Y | Indicates if the document has any page or images linked to it. |
| PageFileExt* | Text | Document | Y | The file extension of the first page for the document. If document has no pages, value is empty. |
| PageFileName* | Text | Document | Y | The file name of the first page for the document. If document has no pages, value is empty. |
| PageFileNames* | Text | Document | Y | Contains a delimited list of all the unique page file names in the document. |
| PageFileNameNoExt* | Text | Document | Y | The file name without the file extension of the first page for the document. If document has no pages, value is empty. |
| NumAttach* | Number | Document | Y | If the document is a part of a family, the number of child/attach records is provided. Otherwise the value will be 0. |
| FileFolder* | Text | Document | Y | The relative file folder of the native file linked to the document. |
| FileName* | Text | Document | Y | The file name of the native file linked to the document. |
| FileNameNoExt* | Text | Document | Y | The file name without the file extension of the native file linked to the document. |
| FilePath* | Text | Document | Y | The relative file path of the native file linked to the document. |
| FileSize* | Number | Document | Y | The file size in bytes of the native file linked to the document. Use 'Check Resources' to populate size value. |
| FileExt* | Text | Document | Y | The file extension of the native file linked to the document. |
| FileHash* | Text | Document | Y | The MD5 hash value of the native file linked to the document. Use 'Check Resources' to populate hash value. |
| HasColor* | Boolean | Document | Y | Indicates if any page in the document has been detected as a color page. Use 'Check Resources' to run color detection. |
| HasBlank* | Boolean | Document | Y | Indicates if any page in the document has been detected as a blank page. Use 'Check Resources' to run blank page detection. |
| HasNative* | Boolean | Document | Y | Indicates if the document has an associated native file linked to it. |
| HasFamily* | Boolean | Document | Y | Indicates if the document has any family or grouping data associated to it (e.g. is an attachment or a parent of a document) |
| IsParent* | Boolean | Document | Y | Indicates if the document is a parent document. |
| IsAttach* | Boolean | Document | Y | Indicates if the document is an attachment or child of a parent document. |
| TextLevel* | Text | Document | Y | Indicates if the text files for the document are single ('Per Page'), multi-page ('Per Document'), or contained in a PDF ('PDF'). Value is empty if no text information exists. |
| HasText* | Boolean | Document | Y | Indicates if the document has any text files linked to it. |
| TextFileName* | Text | Document | Y | The first file name linked to the document. |
| TextFilePath* | Text | Document | Y | The relative path of the first text file linked to the document. |
| Page BitDepth* | Number | Page | N | The number of bits per pixel. Common values: 1 is black/white; 8 is grayscale; 16 or 32 indicates color image. |
| Page Compression* | Text | Page | N | For TIFF images, possible values are: Uncompressed, "CCITT modified Huffman RLE, CCIT Group 3, CCIT Group 4, LZW, JPEG 6.0 (old-style), JPEG DCT (new-style), PackBits / Macintosh RLE, or Deflate. Otherwise value is empty. |
| Page FileExt* | Text | Page | N | The file extension of the image file. |
| Page FileFolder* | Text | Page | N | The relative file folder of the image file. |
| Page FileName* | Text | Page | N | The relative file name of the image/page file. |
| Page FilePath* | Text | Page | N | The relative file path of the image file. |
| Page FileSize* | Number | Page | N | The file size in bytes of the image file. |
| Page HasColor* | Boolean | Page | N | Indicates if the page has been detected as a color page. Use 'Check Resources' to run color detection. |
| Page Height* | Decimal | Page | N | The height of the image in inches. |
| Page Identifier* | Text | Page | N | Bates number assigned to the page. |
| Page IsBlank* | Boolean | Page | N | Indicates if the image has been detected as a blank page. Use 'Check Resources' to run blank page detection. |
| Page MD5Hash* | Text | Page | N | The MD5 hash value of the image file. Use 'Check Resources' to populate hash value. |
| Page Number* | Number | Page | N | Page number for the page in the document. This is the order in sequence when multipl page files are associated to a document. |
| Page ResolutionX* | Decimal | Page | N | Horizontal resolution (dots per inch or DPI) of the image. |
| Page ResolutionY* | Decimal | Page | N | Vertical resolution (dots per inch or DPI) of the image. |
| Page Widtrh* | Decimal | Page | N | The width of the image/page in inches. |
| Text Contents* | Memo | Text | N | The text or data contents of the text file. New lines are automatically replaced with the new line ® symbol. |
| Text FileExt* | Text | Text | N | The file extension of the text file. |
| Text FileFolder* | Text | Text | N | The relative file folder of the text file. |
| Text FileName* | Text | Text | N | The file name of the text file. |
| Text FilePath* | Text | Text | N | The relative file path of the text file. |
| Text FileSize* | Number | Text | N | The file size in bytes of the text file. |
| Text MD5Hash* | Text | Text | N | The MD5 hash value of the text file. Use 'Check Resources' to populate hash value. |
| Text Number* | Number | Text | N | Number or order in sequence when multple text files are associated to a document. |