Add Folder

Function Name: getAddFolderXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This function is used to add a subfolder to an existing Folder. Data Class can be associated at the time of creation of a Folder. Access Type can also be set for the Folder, that is, whether the Folder is Shared or Private or will inherit its Access Type from its Parent Folder.

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

Prototype:

public String getAddFolderXml( String cabinetName, String userDbId,

String parentFolderIndex, String folderName,

String createdDateTime, String accessType,

String imageVolIndex, String folderType,

String mappedDirectory, String location,

String versioningFlag, String comment,

String ownerIndex, String finalizedFlag,

String finalizedBy, String dataDefName,

String enableLogFlag, String enableFTS,

String ExpiryDate, String NameLength,

String NoOfDocuments, String NoOfSubFolders,

String DuplicateName, String LimitCount)

Overloaded Function:

public String getAddFolderXml( String cabinetName, String userDbId,

String parentFolderIndex, String folderName,

String createdDateTime, String accessType,

String imageVolIndex, String folderType,

String mappedDirectory, String location,

String versioningFlag, String comment,

String ownerIndex, String finalizedFlag,

String finalizedBy, String dataDefName,

String enableLogFlag, String enableFTS,

String ExpiryDate, String NameLength,

String NoOfDocuments, String NoOfSubFolders)

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 after the execution of getConnectCabinetXml call.		N/A
parentFolderIndex	Index of the Folder in which the new Folder is to be added.If it is 0, then folders are added at root level.	Integer >= 0	0
FolderName	Name of the new Folder.	Any String (Valid)	New Folder (Incremental number)
createdDateTime	Date and Time at which, the new Folder was added.	Valid Date in the format- yyyy-mm-dd hh:mm:ss	Current Date and Time.
AccessType	Indicates whether the new Folder will be Shared or Private or will Inherit the Access Type from its Parent Folder.	‘S’ - Shared ’P’ - Private ‘I’ - Inherit	‘S’ - Shared
imageVolIndex	Volume Index of the Image Server where the documents of this new Folder will be physically stored. This information is particularly useful if no Volume Index is sent in the call while adding a document in this Folder. In that case, documents are by default, added in the Volume specified by the Volume Index of the Folder.	Integer > 0	Image Volume Index of the Parent Folder.
FolderType	Indicates the Type of the new Folder to be added.	‘G’- General ‘A’ - Reserved	‘G’
mappedDirectory	This parameter is reserved and it can be used with the default value.	Null	null
Location	This parameter is reserved and it can be used with the default value.	Null	null
versioningFlag	Indicates whether Versioning will be allowed for the documents that are to be added in this new Folder or not.	‘Y’ – Yes ‘N’ -– No	Version Flag of Parent Folder.
Comment	The comments which are to be associated with the new Folder.	Any String (Valid)	Null
ownerIndex	Index of the User who is to be made the Owner of the new Folder.	Integer > 0	Index of Logged in User.
finalizedFlag	This parameter is reserved and it can be used with the default value.	Null	Null
FinalizedBy	This parameter is reserved and it can be used with the default value.	Null	null
dataDefName	Name of the Data Class to be associated with the Folder.	Any String (Valid)	No Data Class will be associated with the Folder.
enableLogFlag	Indicates whether Log will be maintained for the various operations performed on this Folder or not.	‘Y’ - Yes ‘N’ - No	‘Y’
ExpiryDate	Set this to the expiryDate field for this folder		29^th Dec 2099
NameLength	To limit the length of the folder name.	‘Y’ - Yes ‘N’ - No	‘Y’
NoOfDocuments	No of documents present in the new Folder. (Currently not in Use)
NoOfSubFolders	No of subfolders present in the new Folder. (Currently not in Use)
EnableFTSFlag	Whether Full Text Search is enabled or not.	‘Y’ - Yes ‘N’ - No	‘Y’
DuplicateName	Whether a duplicate name is to be generated for the given folder or not.	‘Y’ - Yes ‘N’ - No	‘Y’
LimitCount	Limit on the number of Folders that can be added in the given Parent Folder.	Integer > 0	No check is made for limit on number of folders in the Parent Folder.

Output Parameters:

An inputXmlInputXml string of the NGOAddFolder call.