NGOFTSSetFTSData

This call sets FTS text data for a document and populates the full-text catalog. This data is useful in performing Full Text Search.

 

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

NGOFTSSetFTS

Data

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 NGOConnectCabinet call.

 

N/A

CurrentDate

Time

Root

Date and time when the FTS Data is set.

 

 

ObjectIndex

Root

Index of the object whose data is being set.

Integer > 0

 

ObjectType

Root

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

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- GlobalIndexes

13- DataClass

14- Document

Name

15- Author

16- Owner

17- General

(All of the above)

1

FolderIndex

Root

Main folder index

 

 

FTSFlag

Root

Possible values of this flag are:

N – Not valid

F – Failed

T – Successfully set.

 

‘F’

FTSData

Root

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

 

 

DoIndexing

Root

Whether indexing is to be done or not.

‘Y’ or ‘N’

‘N’

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

NGOFTSSetFTSData

Status

Root

Status of the call. If the Status is 0, then the call is successful.

 

Errors returned from call

Code

Message

Comments

-50146

Invalid session.

Session corresponding to the UserDBId sent in the call is invalid.

-50006

User account has expired.

The user’s account has expired.

-50010

User not alive.

The user is not alive.

-50125

Cabinet has been locked for Administrative purposes.

The Cabinet has been locked by some user for Administrative purposes.

-50022

Insufficient rights for the current operation.

The login user does not have rights for the given operation.

-50074

Invalid parameters.

If the ObjectType is < 1  or > 10.

-50023

Document not found.

The specified document does not found.

-50071

Document has been checked out.

The given document has been checked out.

-50027

Properties of the Document has been finalised.

The properties of the given document have been finalized.

-50086

Document has expired.

The given document has expired.

-50060

Annotation not found.

The annotation group not found.

-50065

Attachment does not exist.

The Attachment does not exist.