NGOFTSSetFTSDataEx

This call sets extracted data for a document that is useful in performing FTS.

 

Input Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

Errors and Warnings

 

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call.

NGOFTSSet

FTSDataEx

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID, which is returned in the NGOConnect

Cabinet call.

 

N/A

CurrentDate Time

Root

Current Date and Time.

 

N/A

DocumentIndex

Root

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

Integer > 0

N/A

FolderIndex

Root

Reserved for internal use.

 

 

ObjectType

Root

Type of the object related to the specified document, for which Full tText eExtraction is done.

1- Document

2 –Ordinary

 Notes

3- Ordinary

Attachments

4- Message

5- Subject

6-

Forwarding

Note

7- Response

8- FreeText

9- Reserved

10- Reserved

11- Keywords

12-

GlobalIndexs

13- DataClass

14-

Document

Name

15- Author

16- Owner

17- General

(All of the above)

1

FTSFlag

Root

Flag, which that specifies the status of fFull tText eExtraction on the document . It, consists of two bits. First bit indicates the status of extraction of the contents of the document and the second bit indicates the status of extraction of the document Document pProperties. Possible values for the individual bits are:

P – Pending

N – Not valid

F – Failed

T – Successfully extracted.

2 bits having individual value from among P, N, T, F

Previous FTS flag of the document is retained.

FTSData

Root

Data obtained after Full Text Extraction on the object specified, on the document.

 

 

ObjectIndex

Root

Index of the object.

Integer > 0

 

DoIndexing

Root

Reserved for its internal use.

 

 

 

Output Parameters description

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.

 

Errors returned from call

Code

Message

Comments

-50023

Document not found.

Document for which Full tText eExtraction data is to be set does not exist in the sSystem.

-50071

Document has been checked out.

Document for which Full tText eExtraction data is to be set has been checked out.

-50027

Properties of the Document has been finalized.

Document for which Full tText eExtraction data is to be set has been finalized.

-50086

Document has expired.

Document for which Full tText eExtraction data is to be set has expired.

-50060

Annotation not found.

Annotation, for which extracted text Text is to be set, doesn’t exist in the system.

-50065

Attachment does not exist.

Attachment, for which extracted text is to be set, does not exist in the systemSystem.

-50074

Invalid parameters.

IInvalid value is supplied in FTSFlag some invalid value is supplied or object Object type Type is inot valid.

-50022

Insufficient rights for the current operation.

A sSupervisor User can only perform the operation.