NGOGetGlobalIndexFromDocument

This transaction will return all the GlobalIndexes associated with 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.

NGOGet

GlobalIndex

From

Document

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID, which that is returned in the NGOConnect

Cabinet call.

 

N/A

DocumentIndex

Root

Index of the Document.

 

N/A

IndexFlag

Root

GlobalIndexes for that particular scope (i.e., ‘G’ Global or ‘D’ Data type).

‘G’ Global,

‘D’ Data type,

*(all).

*(all).

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique Option for the Call.

Status

Root

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

NoOfRecordsFetched

Root

Noumber of gGlobal iIndexes associated with the document.

GlobalIndexes

Root

It is an outer tag whichtag that contains a lList of various fields and their values.

Field

GlobalIndexes

It is an outer tag which that contains the various information related to a particular field using different tags.

IndexId

Field

Index of the data Data fieldField.

IndexName

Field

Name of the Data Fielddata field.

IndexType

Field

Type of the Data Fielddata field.

I – Integer Type

T – Text Type

S – String Type

L – Long Type

D – Date Type

B – Boolean Type

F – Float Type

X – Document Index

IndexLength

Field

Length of the field in the given cClass.

IndexFlag

Field

Specifies whether the given index Index is global Global or specific to the Data Class.

G – Global

D – Data Class specific

IndexValue

Field

Value of the field.

 

Errors returned from call

Code

Message

Comments

-50023

Document not found.

Document index Index for which the User wants to get GlobalIndexes, does not exist in the Ssystem.

-50132

Insufficient rights for the current operation.

Insufficient rights Rights on Data Definition associated with the document. User must have read Read rights Rights on Data Definition associated with document.

-50022

Insufficient rights for the current operation.

Insufficient Rightsrights on document. User must have Readread Rightsrights on Document.