This call is used for changing the Properties of an existing folder. Tags for only those parameters should be sent which are to be changed; remaining values will be retained from the folder. IndexId for the first field of DataDefinitionshould be sent –1 if the DataDefinition is to be removed from the Folder.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOChange FolderProperty |
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 NGOConnect Cabinet call. |
|
N/A |
|
Folder |
Root |
Outer tag contains information about the Properties of the folder to be changed. |
|
N/A |
|
FolderIndex |
Folder |
Index of the folder. |
Integer > 0 |
N/A |
|
FolderName |
Folder |
Name of the folder. |
|
|
|
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 .The Folder Name, if larger than the NameLength, then it is truncated to the specified length. |
Integer < 255 |
|
|
AccessDateTime |
Folder |
Date and Time when the folder was last accessed. |
Valid date in the format yyyy-mm-dd hh:mm:ss |
|
|
AccessType |
Folder |
Indicates the Access Type of folder. |
‘S’ – Shared ‘P’ – Private ‘I’ - Inherited |
|
|
ImageVolume Index |
Folder |
Volume Index of the Image Server where the documents added in this folder will be added, if no Volume Index is supplied in the Add Document call. |
Integer > 0 |
|
|
VersionFlag |
Folder |
Indicates whether Versioning is to be allowed on documents added to the folder or not. |
‘Y’ – yes ‘N’ – No |
|
|
Comment |
Folder |
Any comments associated with the folder. |
|
|
|
FinalizedFlag |
Folder |
Indicates whether the folder is finalized or not. |
‘Y’ – yes ‘N’ – No |
|
|
Owner |
Folder |
Owner name of the folder. |
|
|
|
DuplicateName |
Folder |
Whether duplicate name is to be generated or not. |
Y or N |
N |
|
LogGeneration |
Folder |
Whether log is to be generated for this action or not. |
Y or N |
Y |
|
EnableFtsFlag |
Folder |
Reserved for internal use. |
|
|
|
ExpiryDateTime |
Folder |
Specifies the Date and Time when the Folder Expires. |
|
|
|
DataDefinition |
Folder |
Outer tag contains information about Data Definition to be associated with the folder. |
|
|
|
DataDefIndex |
Data Definition |
Index of the Data Definition to be associated with the folder. |
|
|
|
DataDefName |
Data Definition |
Name of the Data Definition to be associated with the folder. |
|
|
|
Fields |
Data Definition |
Outer tag containing information about the fields of the Data Class to be associated with the folder. |
|
|
|
Field |
Fields |
Information about the single Data Class field. |
|
|
|
IndexId |
Field |
Index of the Data class field.
|
Index > 0 -1 should be sent to remove the Data Class. |
|
|
IndexType |
Field |
Type of the Data Class field. |
|
|
|
IndexValue |
Field |
Value of the Data Class field associated with the folder. |
|
|
|
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. |
|
Folder |
Root |
Outer tag that contains information about the folder. |
|
FolderIndex |
Folder |
Index of the folder. |
|
ParentFolderIndex |
Folder |
Index of parent of the folder. |
|
NoOfSubFolders |
Folder |
Number of subfolders present in the folder. |
|
NoOfDocuments |
Folder |
Number of documents present in the folder. |
|
FolderName |
Folder |
Name of the folder. |
|
Owner |
Folder |
Owner of the folder. |
|
OwnerIndex |
Folder |
Index of the Owner of the folder. |
|
CreationDateTime |
Folder |
Date and Time at which the folder was created. |
|
RevisedDateTime |
Folder |
Date and Time at which the folder was last modified. |
|
AccessDateTime |
Folder |
Date and Time at which the folder was last accessed. |
|
DeletedDateTime |
Folder |
Date and Time of deletion of the folder. |
|
AccessType |
Folder |
Indicates whether the folder is a Shared folder / Private folder / Inherits its Access Type from its Parent Folder. |
|
ImageVolumeIndex |
Folder |
Volume Index of the Image Server where the documents added in this folder will be added, if no Volume Index is supplied in the Add Document call. |
|
FolderType |
Folder |
Indicates the Type of the folder. |
|
FolderLock |
Folder |
Indicates if any User has locked the folder. |
|
LockByUser |
Folder |
Index of the User who has locked the folder. |
|
Location |
Folder |
Folder Type of the Parent Folder of this folder. |
|
ExpiryDateTime |
Folder |
Date and Time after which the folder will expire. |
|
VersionFlag |
Folder |
Indicates whether Versioning will be allowed for the documents added in this 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. |
|
LoginUserRights |
Root |
Rights of the logged in User on the folder. |
|
ACLMoreFlag |
Folder |
Reserved for internal use. |
|
EnableFtsFlag |
Folder |
Reserved for internal use. |
|
ACL |
Folder |
Reserved for Internal use. |
|
LockMessage |
Folder |
Message to be sent to the user if the Folder is locked. |
|
NoOfReferencedDocuments |
Folder |
Number of Referenced Documents present in the Folder. |
|
DataDefinition |
Folder |
Information of the Data Class associated with the folder. |
|
DataDefIndex |
DataDefinition |
Index of the Data Class associated with the folder. |
|
DataDefName |
DataDefinition |
Name of the Data Class associated with the folder. |
|
Fields |
DataDefinition |
Outer Tag that contains information about fields of this Data Class. |
|
Field |
Fields |
Outer Tag that contains information about a single field of this Data Class. |
|
IndexId |
Field |
Index of the Data Class field. |
|
IndexName |
Field |
Name of the Data Class field. |
|
IndexType |
Field |
Type of the Data Class field. |
|
IndexLength |
Field |
Length of the Data Class field. |
|
IndexAttribute |
Field |
Attribute of the Data Class Field. |
|
IndexValue |
Field |
Value of the Data Class field associated with the folder. |
|
Code |
Message |
Comments |
|
-50017 |
Folder not found. |
The Folder whose Property is to be changed do not exists. |
|
-50133 |
Folder has been deleted. |
The Folder whose Property is to be changed has been deleted. |
|
-50119 |
System defined properties cannot be changed. |
Properties of the System Folders like Inbox, Trash and SentItems cannot be changed. |
|
-50139 |
Expiry date cannot be less than current date. |
Expiry Date specified in input xml should be a date greater than the Current Date. |
|
-50019 |
Properties of the Folder have been finalized. |
Folder Properties could not be changed as folder has been finalized. |
|
-50018 |
Insufficient Rights for the current operation. |
Logged in User has insufficient Rights on the folder whose Property is to be changed. |
|
-50028 |
Data Class not found. |
Data Class to be associated with the folder does not exist. |
|
-50032 |
Insufficient Rights for the current operation. |
This error is thrown when the User, specified as Owner of the folder has None Rights on the folder or User do not have Rights on Data Class which is to be associated with the folder. |
|
-50120 |
Folder with the same name already exists. |
Folder with similar name already exists. |
|
-50138 |
User not Owner or Supervisor. |
This error occurs, when the Ownership of the folder is to be changed and the logged in User is neither a member of the Supervisor Group nor is the Owner of the folder. |
|
-50003 |
User does not exist. |
User who is to be made the new Owner of the folder does not exist. |
|
-50006 |
User account has expired. |
Account of the User who is to be made the new Owner of the folder has already expired. |
|
-50010 |
User not alive. |
User who is to be made the new Owner of the folder is not alive. |
|
-50116 |
Insufficient privileges for the current operation. |
This error occurs when the Access Type of the folder is being changed and the User does not have Privilege to add / delete / modify Rights. |
|
-50021 |
Folder is in use. |
Some User, other than the logged in User locks the folder whose Properties are to be changed. |
|
-50045 |
GlobalIndex not found. |
Data fields supplied by the User do not belong to the Data Definition supplied. |
|
-50076 |
Invalid object access type. |
Access type of folder whose property is to be changed or of the data class to be associated with the folder is improper . This error arises in the process of rights checking on the folder or the data class. |
|
-50081 |
Data not available |
Information about the Data definition not found. |