NGOGetNextThumbnailDoc

This call is used to get the information about the document whose tThumbnail has not been generated yet. The tThumbnail of a document is said to be generated only when the tThumbnails of all the pages are stored. This call locks all the documents that are returned in the resultsResults. They are unlocked only when the thumbnailThumbnail of the last page is stored using the call NGOSetThumbnailThumbnail. Alternatively, NGOProcessLocks can also be used to unlock the document.

 

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.

NGOGetNext

ThumbNail

Doc

N/A

CabinetName

Root

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

The name of the cabinet.

N/A

UserDBId

Root

UserDatabase ID, which that is returned in the NGOConnect

Cabinet call.

 

N/A

CurrentDate

Time

Root

Date and Time when the call is being executed.

Valid Date in the format- yyyy-mm-dd hh:mm:ss

Current sSystem dDate and tTime.

NoOfRecordsTo

Fetch

Root

Number of documents to be fetched.

Integer > 0

1

FoldDocIndex

Root

Folder iIndex of that fFolder whose documents have to be fetched.

Integer > =0

If not specified then the documents from whole database are fetched.

FoldDocFlag

Root

This flag  mustFlag must be set when FoldDocIndex is sent.

‘F’ – Folder

 

NULL implies whole cabinet Cabinet is to be searched.

PreviousIndex

Root

The dDocument iIndex of the last document of the previous batch.

Integer >=0

0

IncludeSub

Folder

Root

Specifies whether subfolders of the f specified older specified areFolder are to be included in search Search or not.

‘N’  - No

‘Y’ – Yes

‘N’

DocumentType

Root

Specifies the Type of the document.

I – Image

N – Non Image

A – Reserved

NULL implies all kinds of documents whose thumbnailThumbnail has not yet been generated.

 

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.

NoOfRecordsFetched

Root

No.umber of documents to be fetched.

ThumbNail

Documents

Root

Contains the documents whose thumbnailThumbnails have not been generated yet.

Document

ThumbNail

Documents

Contains information about one particular document whose thumbnailThumbnail has not been generated yet.

DocumentIndex

Document

Document index of the document whose thumbnailThumbnail has to be generated.

VersionNo

Document

Version of the document for which the information has been fetched.

DocumentName

Document

Name of the document whose thumbnailThumbnail has to be generated.

ISIndex

Document

The image server index of the document.

ThumbNailFlag

Document

ThumbnailThumbnail fFlag specifies whether thumbnailThumbnail of the document has been generated or not.

‘Y’- Yes, ‘N’ – No

DocumentType

Document

The type of document fetched.

‘I’ – Image, ‘N’ – Non Image

CreatedByAppName

Document

The Extension of the fetched document.

NoOfPages

Document

Number of pages in the Document.

PullPrintFlag

Document

Not in use.

NextPage

Document

Page number from which the thumbnail generation has to take place.

 

Errors returned from call

Code

Message

Comments

-50022

Insufficient rights for the current operation.

The User does not possess sufficient rRights on the fetched document.

-50017

Folder not found.

The folder with the specified iIndex does not existexist.

-50112

No data found.

No documents, satisfying the specified parameters, could be found.