This
call gets the List of documents of a Folder that are not yet extracted for FTS,
in batches. This call can also fetch a particular document, if FoldDocFlag is
sent as ‘D’ and Document Index is sent in FoldDocIndex. FoldDocIndex is not
mandatory if foldocflag is not provided.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOFTSGet DocForFTS |
N/A |
|
CabinetName |
Root |
Name of the Cabinet to which the
User wants to connect. |
|
N/A |
|
UserDBId |
Root |
UserDatabase ID that is returned in the NGOConnect Cabinet call. |
|
N/A |
|
FoldDocIndex |
Root |
Index of the folder whose non – extracted documents are to
be fetched. Index of a document can also be sent if a particular document is
to be fetched. |
Integer > 0 |
N/A |
|
CurrentDate Time |
Root |
Current Date and Time. |
|
|
|
FoldDocFlag |
Root |
Flag that indicates whether Index passed in FoldDocIndex
tag is of a document or folder. |
‘F’ – Folder ‘D’ – Document |
Next document in the system whose Full text Extraction is
pending will be returned irrespective of the FoldDocIndex supplied. |
|
DocumentType |
Root |
Type of the documents that are to be fetched. |
Not Used |
|
|
IncludeSub Folder |
Root |
Indicates whether documents in subfolders of the given
folder are to be returned or not. Relevant only if FoldDocFlag is ‘F’. |
‘Y’ – Yes ‘N’ – No |
‘N’ |
|
NoOfRecordsTo Fetch |
Root |
Number of documents to be fetched in a batch. Relevant
only if FoldDocFlag is ‘F’. |
Integer > 0 |
|
|
PreviousIndex |
Root |
Previous document index in case of batch fetching. |
Integer >= 0 |
0 |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
Unique option for the call. |
|
Status |
Root |
Status of the call. If the Status is 0, then the call is
successful. |
|
TotalNoOfRecords |
Root |
Not used. |
|
FTSDocuments |
Root |
Information about all the documents which are retrieved
for Full
Text Extraction. |
|
FTSDocument |
FTSDocuments |
Information about the document retrieved for Full Text E |
|
FTSIndex |
FTS Document |
Index of the FTS document. |
|
DocumentIndex |
FTS Document |
Index of the document. |
|
DocumentName |
FTS Document |
Name of the document. |
|
DocumentType |
FTS Document |
Type of the document. |
|
CreatedByAppName |
FTS Document |
Extension of the document. |
|
FTSFlag |
FTS Document |
Flag that specifies whether the document has been
extracted for FTS or not .It consists of two bits. First bit indicates
whether the contents of the object are extracted or not and the second bit
indicates whether the Properties of the object are extracted or not Possible values for the individual bits: P – Pending N – Not valid F – Failed T – Successfully extracted. |
|
ISIndex |
FTS Document |
A unique Combination of Volume Index and Image Index,
separated by #, of the document stored on Image Server. For example, 3#79 |
|
Code |
Message |
Comments |
|
-50022 |
Insufficient rights for the current operation. |
Administrator can only perform the operation. |
|
-50112 |
No data found. |
No documents to be extracted found in the specified
folder. |
|
-50134 |
Folder has expired. |
The document that is to be obtained for Full Text
Extraction has expired. |
|
-50071 |
Document has been checked out. |
The document that is to be obtained for Full Text
Extraction is checked out. |
|
-50026 |
Document is in use. |
The document that is to be obtained for Full Text
Extraction is locked. |
|
-50027 |
Properties of the Document have been finalized. |
The document that is to be obtained for Full Text
Extraction has been finalized. |
|
-50017 |
Folder not found. |
The folder for which the List of documents to be extracted
is obtained does not exist in the System. |
|
-50023 |
Document not found. |
The document that is to be obtained for Full Text
Extraction does not exists in the System. |