Document Link Types

ReadySuite's core functionality enables you to work with documents by importing them from load, image, native, text, and delimited text files or a combination of all of these.

Documents consist of one or more of the below properties:

Page Files / Page Links

Page files are representations of the images a document represents.

For example, a document may consist of five (5) image files representing five (5) total pages (i.e. single-page images). Or, a document may consist of one (1) image file representing five (5) total pages (i.e. a multi-page images).

In both cases above, a page represents each image in a document - and provides information such as the page (bates) identifier, file path, file extension, image type, and other image properties.

The following are all page level fields, whose data is populated by a page file or page link.

Page Level Field Name	Description
AttachIDs*	Contains a delimited list of child documents values using the DocID* field.
AttachRange*	Combines values of BegAttach* and EndAttach* separated by a hypen.
BegAttach*	The starting attachment range; value is empty if document is not a part of an attachment group.
BegDoc*	Starting (bates) number assigned to the document based on the page information.
EndAttach*	The ending attachment range; value is empty if document is not a part of an attachment group.
EndDoc*	Ending (bates) number assigned to the document based on the page information.
PageCount*	Number of pages in the document. If the document is empty, the value shown will be 0.
PageFileExt*	The file extension of the first page for the document. If document has no pages, value is empty.
PageFileName*	The file name of the first page for the document. If document has no pages, value is empty.
PageLevel*	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.
PageFileNameNoExt*	The file name without the file extension of the first page for the document. If document has no pages, value is empty.
HasPages*	Indicates if the document has any page or images linked to it.

Text Files / Text Links

Text files are representations of either the extracted text of a native file reference and/or the OCR text of the images from the document. A document can consist of a single text reference (i.e. document-level text) or multiple text references (i.e. page-level text).

The following are all text level fields, whose data is populated by a text file or text link:

Text Level Field Name	Description
HasText*	Indicates if the document has any text files linked to it.
TextLevel*	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.
TextFilePath*	The relative path of the first text file linked to the document.
TextFileName*	The first file name linked to the document.

Native Files / Native Links

A native file represents the source or originating file of the document. In the case of scanned images, this property is typically not populated. For electronic files, it may represent the file the document was originally authored with.

The following are all native level fields, whose data is populated by a native file or native link:

Native Level Field Name	Description
FileExt*	The file extension of the native file linked to the document.
FileFolder*	The relative file folder of the native file linked to the document.
FileHash*	The MD5 hash value of the native file linked to the document. Use 'Check Resources' to populate hash value.
FileName*	The file name of the native file linked to the document.
FileNameNoExt*	The file name without the file extension of the native file linked to the document.
FilePath*	The relative file path of the native file linked to the document.
FileSize*	The file size in bytes of the native file linked to the document. Use 'Check Resources' to populate size value.
HasNative*	Indicates if the document has an associated native file linked to it.

Fielded Data / Metadata

Fielded data or metadata represent the properties or descriptions assigned to documents. A document may consist of internal fields (built into ReadySuite) as represented on the Field Description or custom fields (imported by the user). For example, fielded data of a document may consist of the date and time a document was created or modified.