NGOAddGlobalIndex

This call is used to add a new Global Indexes or Data field to the System. This call can also be used to check only the existence of that GlobalIndex. If the GlobalIndex with the same Name exist, then a Warning code is returned and with the existing GlobalIndex. User must have Privilege to add Global Index to the System.

 

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.

NGOAdd

GlobalIndex

 

CabinetName

Root

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

 

 

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect

Cabinet call.

 

 

CheckExistence

Only

Root

Flag that specifies specifies whether to check for the existence of the Global Index.

Y- Check existence only.

N- Do not check the existence and add the Global Index to the System.

N

Field

Root

Contains the information about a particular field.

 

N/A

IndexName

Field

Name of the Data Field.

 

N/A

IndexType

Field

Type of the Data 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

N/A

IndexLength

Field

Length of the field. Used only in case of String field and User has to send the value

 

N/A

IndexFlag

Field

Index flag of the field.

 

“D” – Data Field

“G” – Global Index

N/A

 

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 the call is successful.

IndexId

Root

Index of the Data field.

 

Errors returned from call

Code

Message

Comments

-50043

GlobalIndex not found.

Global Index not found in the System. This exception is raised when checkexistenceonly flag is “Y” and Global Index is not found in the System.

-50096

Insufficient rights for the current operation.

User does not posses Privileges to add Global Index to the System.

-50047

Invalid Field length.

This exception is raised only in case of string and if the specified length is > 255.

-50046

Invalid Field Type.

Field type specified in input is invalid.

-50044

GlobalIndex already exist.

This exception is raised for Index flag of type “G” when Global Index already exists on the System.

-50074

Invalid parameters.

This exception is raised when Field Name is not specified in the input.