Change Data Definition

 

Function Name: getChangeDataDefinitionXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to modify the Properties or fields of a Data Definition. The Field List, specified with this XML will be treated as Final List for fields of that Data Definition; it will overwrite the previous fields associated with the Data Definition. The fields those have to be changed alone should be sent in this tag else null is sent. The values of fields for which null is sent will be retained. If all the fields have to be deleted, then–1 is sent in the first IndexId tag.

 

Input Parameters

Sample InputXML

Output Parameters

Sample OutputXML

View xml API::NGOChangeDataDefinition

 

 

Prototype:

 

public String getChangeDataDefinitionXml

(

 

 

 

String cabinetName,

 

 

String userDbId,

 

 

String dataDefIndex,

 

 

String dataDefName,

 

 

String type,

 

 

String groupId,

 

 

String extra,

 

 

String fieldList,

 

 

String checkExistenceOnly

 

)

 

 

Input Parameters:

Name

Description

Valid Values

Default Behaviour

cabinetName

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

 

N/A

userDbId

UserDatabase ID, which is returned in the ConnectCabinet call.

 

N/A

dataDefIndex

Index of the Data Definition.

Integer > 0

N/A

dataDefName

New Name of the Data Definition.

 

 

type

Type of the Data Class.

ACT (Reserved), or blank

Blank

groupId

Group Index that is associated with the Data Definition.

Integer > 0

0

extra

Extra information stored with the Data Definition

 

Blank

fieldlist

Contains the information about Fields List. This List can be generated using the function getDataDefFieldXml.

 

N/A

checkExistenceOnly

Flag that checks the existence of the Data Definition.

Y/N

N

 

Output Parameters:

An inputXml string of the NGOChangeDataDefinition call.