This call is used to add a folder to an existing Folder. Data Class can be associated while creating a Folder. User can also set Access Type for the Folder (whether the Folder will be Shared or Private or will inherit its Access Type from its Parent Folder).
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOAddFolder |
N/A |
|
CabinetName |
Root |
Name of the Cabinet to which the User wants to connect. |
|
N/A |
|
UserDBId |
Root |
UserDatabase ID, which is returned in the NGOConnectCabinet call. |
|
N/A |
|
Folder |
Root |
Information about the new Folder, which is to be added. |
|
|
|
ParentFolderIndex |
Folder |
Index of the folder in which new Folder is to be added.If it is 0, then folders are added at root level. |
Integer >= 0 |
0 |
|
FolderName |
Folder |
Name of the new Folder. |
|
New folder (Incremental no). For example, if new Folder(1) is present already then, a folder is created with name new Folder(2). |
|
CreationDateTime |
Folder |
Date and Time at which, the new Folder is added. |
Valid Date in the format: yyyy-mm-dd hh:mm:ss. |
Current Date and Time. |
|
ExpiryDateTime |
Folder |
Date and Time after which the new Folder will expire. |
Valid Date in the format- yyyy-mm-dd hh:mm:ss |
12/31/2099 |
|
AccessType |
Folder |
Indicates whether the new Folder will be Shared / Private or will Inherit the Access Type from its Parent Folder. |
‘S’ - Shared ’P’ - Private ‘I’ - Inherit |
‘S’ - Shared
|
|
ImageVolumeIndex |
Folder |
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 Parent Folder. |
|
FolderType |
Folder |
Indicates the type of the new Folder to be added. |
‘G’ - General ‘A’ – Reserved |
‘G’ |
|
VersionFlag |
Folder |
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 |
Folder |
The comments that are to be associated with the new Folder. |
|
|
|
OwnerIndex |
Folder |
Index of the User who is to be made the Owner of the new Folder. |
Integer > 0 |
Index of logged in User. |
|
NameLength |
Folder |
The maximum length of the Folder Name supported by JTS is 255 characters but, if the User wishes that the maximum length of folders added is lesser than 255 characters, then it can be specified in this tag .If the Folder Name is larger than the NameLength then, it is truncated to the specified length. |
Integer < 255 |
|
|
LimitCount |
Folder |
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. |
|
LogGeneration |
Folder |
Indicates whether Log will be maintained for the various operations performed on this folder or not. |
‘Y’ - Yes ‘N’ - No |
‘Y’ |
|
EnableFtsFlag |
Folder |
Whether FTS is enabled or not. |
‘Y’ - Yes ‘N’ - No |
‘Y’ |
|
DuplicateName |
Folder |
Whether a duplicate name is to be generated for the given folder or not. |
‘Y’ - Yes ‘N’ - No |
‘Y’ |
|
DataDefinition |
Folder |
Information about the Data Class to be associated with the document. |
|
No Data Definition is associated with the Folder. |
|
DataDefName |
Data Definition |
Name of the Data Class to be associated with the Folder. |
|
|
|
Fields |
Data Definition |
Contains all the fields of this data class. |
|
|
|
Field |
Fields |
Contains the information about a particular field. |
|
|
|
IndexId |
Field |
Index of the data class field. |
Integer > 0 |
|
|
IndexValue |
Field |
Value of the data class field. |
|
|
|
IndexType |
Field |
Type of the data class field. |
|
|
|
Name |
Parent Tag |
Description |
|
Option |
Root |
Unique option for the call. |
|
Status |
Root |
Status of the call. If the Status is 0, then the call is successful. |
|
LoginUserRights |
Root |
Rights of the User who has logged on to the new Folder. |
|
Folder |
Root |
It contains information about the new Folder that is added through this call. |
|
FolderIndex |
Folder |
Index of the new Folder. |
|
ParentFolderIndex |
Folder |
Index of the Parent Folder in which the new Folder has been added. |
|
NoOfSubFolders |
Folder |
No of subfolders present in the new Folder. |
|
NoOfDocuments |
Folder |
No of documents present in the new Folder. |
|
NoOfReferenced Documents |
Folder |
No of referenced documents present in the new Folder. |
|
FolderName |
Folder |
Name of the new Folder. |
|
Owner |
Folder |
Name of the Owner of the Folder. |
|
OwnerIndex |
Folder |
Index of the Owner of the Folder. |
|
CreationDateTime |
Folder |
Date and time at which, the new Folder was created. |
|
RevisedDateTime |
Folder |
Date and time at which, the new Folder was last modified. |
|
AccessDateTime |
Folder |
Date and time at which, the new Folder was last accessed. |
|
DeletedDateTime |
Folder |
Date and time at which, the new Folder was deleted. |
|
DataDefinition Index |
Folder |
Index of the data class associated. |
|
AccessType |
Folder |
Indicates whether the new Folder is a Shared Folder or Private Folder or Inherits its Access Type from its Parent Folder. |
|
ImageVolumeIndex |
Folder |
Volume Index of the Image Server where the documents added to the folder will be added, if no Volume Index is supplied in the Add Document call. |
|
FolderType |
Folder |
Indicates the Type of the new Folder namely General, Inbox, SentItems, Trash etc. |
|
FolderLock |
Folder |
Indicates whether any User has locked the new Folder. |
|
LockByUser |
Folder |
Index of the User who has locked the new Folder. |
|
Location |
Folder |
Folder Type of its Parent Folder namely Root, General, Inbox, SentItems, Trash etc. |
|
ExpiryDateTime |
Folder |
Date and Time after which the new Folder will expire. |
|
VersionFlag |
Folder |
Indicates whether Versioning will be allowed for the documents added in the new Folder or not. |
|
Comment |
Folder |
Comments associated with the folder. |
|
FinalizedFlag |
Folder |
Indicates whether the Folder is finalized or not. |
|
FinalizedBy |
Folder |
Index of the User who has finalized the Folder. |
|
FinalizedDateTime |
Folder |
Date and time when the Folder was finalized. |
|
ACLMoreFlag |
Folder |
Not Used. |
|
EnableFtsFlag |
Folder |
Reserved for internal use. |
|
LockMessage |
Folder |
Message that the user will get when trying to access a locked folder |
|
ACL |
Folder |
For Internal Use |
|
DataDefinition |
Folder |
Contains information about the Data Class associated with the Folder, if any. |
|
Fields |
DataDefinition |
Contains the value corresponding to various fields of the associated Data Definition. |
|
Field |
Fields |
Contains information about individual fields of Data Definition. |
|
IndexId |
Field |
Field Index. |
|
IndexName |
Field |
Name of the field. |
|
IndexType |
Field |
Type of the field. I – Integer Type T – Text Type S – String Type L – Long Type D – Date Type B – Boolean Type F – Float Type X – LinkedDoc |
|
IndexLength |
Field |
Length of field. |
|
IndexAttribute |
Field |
Attribute of the field in the given class. 0 – Null 1 – Not Null 2 – Unique and Null 3 – Unique and not Null 4- Null and indexing done 5 – Not Null and indexing done 6 – Unique and Null and indexing done |
|
IndexValue |
Field |
Value associated with the field. |
|
Code |
Message |
Comments |
|
-50058 |
Specified User does not exist. |
The User, who is to be made the Owner of the Folder, does not exist. |
|
-50017 |
Folder not found. |
The Parent Folder, in which, the new Folder is to be added is not found. |
|
-50021 |
Folder is in use. |
The Parent Folder, in which, the new Folder is to be added, is locked. |
|
-50019 |
Properties of the Folder have been finalized. |
The Parent Folder in which new Folder is to be added has been finalized. |
|
-50028 |
Data Class not found. |
Data Class that is to be associated with the folder does not exist. |
|
-50118 |
Cannot add Folder to the specified location. |
Folder cannot be added at the specified location. |
|
-50173
|
Limit on number of Folders exceeded. |
The limit on the number of folders in the Parent Folder has been exceeded. |
|
-50018 |
Insufficient Rights for the current operation. |
Folder cannot be added because of insufficient Rights on the Parent Folder. |