FTSSetFTSDataEx

Function Name: getFTSSetFTSDataXml_EX

 

Class: com.newgen.dmsapi.DMSInputXml

 

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

 

Input Parameters                                                 Sample InputXML

Output Parameters                                              Sample OutputXML

View xml API::NGOFTSSetFTSDataEx

 

Prototype:

public String getFTSSetFTSDataXml_EX (

                                                                             String cabinetName,

                                                                             String userDBId,

                                                                             String currentDateTime,

                                                                             String docIndex,

                                                                             String foldIndex,

                                                                             String objectType,

                                                                             String ftsFlag,

                                                                             String ftsData,

                                                                             String objectIndex,

                                                                             String doIndexing

                                                                           )

 

Function Overloaded:

public String getFTSSetFTSDataXml_EX (

                                                                              String cabinetName,

                                                                              String userDBId,

                                                                              String docIndex,

                                                                              String foldIndex,

                                                                              String objectType.

                                                                              String ftsFlag,

                                                                              String ftsData,

                                                                              String objectIndex,

                                                                              String doIndexing

                                                                          )

 

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

docIndex

Index of the document for which Full Text Extracted data is to be set.

Integer > 0

N/A

ftsFlag

Possible values of this flag are:

N – Not valid

F – Failed

T – Successfully set.

 

'F'

ftsData

FTS Data to be set on the object specified on the document.

Integer > 0

 

 

currentDateTime

Date and time when the FTS Data is set.

 

 

ObjectType

Type of the object related to the specified document, for which Full Text Data is to be set.

-Document2 –Ordinary Notes3- Ordinary Attachments4- Message5- Subject6- ForwardingNote7- Response8- FreeText9- Reserved10- Reserved11- Keywords12- GlobalIndexes13- DataClass14- DocumentName15- Author16- Owner17- General (All of the above)

1

foldIndex

Reserved for internal use.

 

 

objectIndex

Index of the object.

 

 

doIndexing

Reserved for its internal use.

 

 

 

Output Parameters:

 

An inputXml string of the NGOFTSSetFTSData call.