Add Global Index

Function Name: getAddGlobalIndexXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This function is used to add a new Global Index or data field to the System. It can also be used to check only the existence of the Global Index that is to be added. If the GlobalIndex with the same Name already exists, then a Warning Code is returned. User must have Privilege to add Global Index to the System.

Input Parameters	Sample InputXML
Output Parameters	Sample OutputXML
View xml API::NGOAddGlobalIndex

Prototype:

public String getAddGlobalIndexXml	(
		String cabinetName,
		String userDbId,
		String checkExistenceOnly,
		String indexName,
		String indexType,
		String indexLength,
		String indexFlag
	)

Input Parameters:

Name	Description	Valid Values	Default Behaviour
cabinetName	Name of the Cabinet to which the User wants to connect.		N/A
userDbId	UserDatabase ID, which is returned after the execution of getConnectCabinetXml call.		N/A
checkExistenceOnly	Flag, which specifies whether to check existence for the Global Index alone or add the Global Index.	Y- Check existence only. N- Do not check existence add Global Index to the System.	N
indexName	Name of the data Field.		N/A
indexType	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	Length of the field. Used only in case of String field and user has to send the value.
indexFlag	Flag indicating whether field to be added is a part of a Data Definition or is a Global Field.	“D” – Data Field “G” – Global Index

Output Parameters:

An inputXml string of the NGOAddGlobalIndex call.