<< Click to Display Table of Contents >> You are here: Capture > Importer > Standard Import > Import Specification |
Data Table Details
Documents Table |
Data Type |
Notes |
---|---|---|
ID |
Integer |
Auto-generated Unique Identifier. Use this number in the DocumentIndex and DocumentPages records to link the respective child records to the parent document. |
DocumentTypeID |
Integer |
Corresponds to the Sage Paperless Construction DocumentTypeID which is how this document will be entered. Required if document is not being sent to Queue. |
IndexDate |
Date/Time |
Optional. The date to use as the index Date should be left blank unless preserving index date from another imaging system. |
IndexedByUserID |
Integer |
Optional. Corresponds to the Sage Paperless Construction UserID which is how this document should be indexed. If not provided, this value will default either from import job settings or to the user who is logged in to Sage Paperless Construction and executing the import. |
VaultID |
Integer |
Optional. VaultID for the Vault in which the document will be indexed. If not provided, this value will default either from import job settings or to the current vault into which the user is logged. |
LinkDocumentID |
String |
Optional. Use this field to provide a unique key back to the document's source from which it was generated. |
Notes |
String |
Optional. Any text provided here will be added as a note to the document when imported. |
DocumentCaptureID |
Integer |
Optional. Corresponds to a Document Capture ID which is defined in Sage Paperless Construction. If not provided, will default to the Document Import's Capture ID. |
QueueID |
Integer |
Optional. Corresponds to the ID of the queue where the document should be placed. |
Imported |
Boolean |
Status field which will be populated during the import process. |
ErrorText |
String |
Error Message(s) logged by the import process on failure. |
DocumentIndex Table |
Data Type |
Notes |
---|---|---|
ID |
Integer |
Unique Number. |
DocumentID |
Integer |
Foreign Key. Links to ID in Document Table. |
IndexTypeID |
Integer |
ID of the IndexType from Sage Paperless Construction for this index record. |
IndexValue |
String |
The Value to be indexed. |
DocumentFiles Tables |
Data Type |
Notes |
---|---|---|
ID |
Integer |
Unique Number. |
DocumentID |
Integer |
Foreign Key. Links to ID in Document Table. |
Sequence |
Integer |
Order for this file to be applied to the document. |
FilePath |
String |
Required. Can send a fully qualified UNC path to the document file, a relative path to the document, or if sending in binary* this field should be populated with the original filename of the source file. |
*BinaryDate is not currently supported.
Sample Schema
Click the link to access the Standard Import Schema.