FTSGetDocForFTS

Function Name: getFTSGetDocForFTSXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This call gets the extracted Text for the specified Document.

 

Input Parameters                                                 Sample InputXML

Output Parameters                                              Sample OutputXML

View xml API::NGOFTSGetDocForFTS

 

Prototype:

public String getFTSGetDocForFTSXml (

                                                                           String cabinetName,

                                                                           String userDBId,

                                                                           String foldDocIndex,

                                                                           String currentDateTime,

                                                                           String foldDocFlag,

                                                                           String docType,

                                                                           String includeSubFolder,

                                                                           String noOfRecordsToFetch,

                                                                           String prevIndex

                                                                     )

 

Function Overloaded:

public String getFTSGetDocForFTSXml (

                                                                            String cabinetName,

                                                                            String userDBId,

                                                                            String foldDocIndex,

                                                                            String foldDocFlag,

                                                                            String noOfRecordsToFetch

                                                      )

 

Input Parameters:

 

Name

Description

Valid Values

Default Behavior

CabinetName

Name of the Cabinet to which the User wants to connect.

 

N/A

userDBId

UserDatabase ID, which is returned after the execution of getConnectCabinetXml call.

 

N/A

foldDocIndex

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

foldDocFlag

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.

noOfRecordsToFetch

Number of documents to be fetched in a batch. Relevant only if FoldDocFlag is ‘F’.

Integer > 0

 

currentDateTime

Current date and time

 

 

docType

Type of the documents that are to be fetched.

Not Used

 

includeSubFolder

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

 

PrevIndex

Previous document index in case of batch fetching.

Integer >= 0

 

 

Output Parameters:

 

An inputXml string of the NGOFTSGetDocForFTS call.