NGOChangeDocumentProperty

This transaction is meant for changing the Properties of an existing document. Only those tags should be sent which are to be changed. If the Data Definition is to be removed from the document, then the IndexId sent for the first field of Data Definition should be “–1”. In case of Global Indexes, all the fields must be sent. If the User does not pass any value, then the previous values for the document are retained.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml
Errors and Warnings

Input Parameters description

Name	Parent Tag	Description	Valid Values	Default Values
Option	Root	Unique option for the call.	NGOChange Document Property
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
Document	Root	Information about the Document is placed under this tag.		N/A
GroupIndex	RootDocument	Index of the Group. Reserved for internal use. The User should send the default value.	Integer >0	0
ParentFolderIndex	RootDocument	Index of the Parent Folder of the document.	Integer >0
SupAnnotVersion	RootDocument	To suppress carry forwarding of Annotation to the new Version. ‘Y’-to enable suppressing Annotation. ‘N’-To disable suppressing Annotation.	‘Y’ ‘N’	N
VersionComment	Document	Comment to be added to the document for this version.
LimitCount	Document
GenerateLogFlag	Document	Flag to specify whether to generate log or not.	Y – Yes N - No
DocumentIndex	Document	Index of the document.	Integer >0	N/A
NoOfPages	Document	Number of pages in the document.	Integer >0
DocumentName	Document	Name of the document.
NameLength	Document	The maximum length of the Document Name supported by JTS is 255 characters but if the User wishes that the maximum length of Document added is lesser than 255 characters, then it can be specified in this tag. If the Document Name is bigger than the NameLength, then it is truncated to the specified length.	Integer >0
Owner	Document	The User Index of the Owner of document.
AccessDateTime	Document	Date and Time when the document was last accessed.	Yyyy-mm-dd hh:mm:ss
ExpiryDateTime	Document	Date and Time when the document will expire.	Yyyy-mm-dd hh:mm:ss
VersionFlag	Document	To indicate whether the Versions are allowed.	‘Y’ ‘N’
AccessType	Document	Specifies the scope of accessing the document.	S – Shared P – Private I – Inherited
DocumentType	Document	Specifies the Type of the document.	I – Image N – Non Image A – Reserved	N/A
CreatedByApp Name	Document	Extension of the Document. For example JPG, GIF etc.
ISIndex	Document	Specifies a unique Combination of Image Index and Volume Index for a document stored on the Image Server separated by #. For example, 3#79
DocumentSize	Document	Size of the document in bytes.
EnableLog	Document	Flag that specifies whether Log is to be generated for the document.	Y – Log is generated. N – Log not generated.	‘Y’
Comment	Document	Comments added by the User on the document.
Author	Document	Name of the Author of the document.
FinalizedFlag	Document	Flag that specifies whether the document is finalized.	Y- Document is finalized. N – Document is not finalized.
Keywords	Document	It as an outer tag, which contains the list of keywords that are attached with the object. Keywords are returned in <KeywordProperty> and </KeywordProperty> Tag.
KeywordProperty	Keywords	It is the outer tag that contains the various parameters attached with a particular keyword attached with an object.
Keyword	Keywords	It contains the keyword attached to the object. (Send µ (char 181) to remove all keywords)
DataDefinition	Document	It is an outer tag that contains the data regarding the Data Class associated with the object, its fields and their values.
DataDefIndex	Data Definition	Index of the Data Class associated with the object.
DataDefName	Data Definition	Name of the Data Class associated with the document.
Fields	Data Definition	It as an outer tag that contains the list of fields in the associated Data Class. Fields are given in <Field> and </Field> Tag.
Field	Fields	It is an outer tag that contains the information related to a particular field using different tags.
IndexId	Field	Index of the data field.
IndexNameIndexValue	Field	ValueName of the data field.
IndexType	Field	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
GlobalIndexes	Document	It is an outer tag that contains a list of various fields and their values.
Field	Global Indexes	It is an outer tag that contains the information related to a particular field.		N/A
IndexId	Global Indexes	Index of the Global Index.
IndexValue	Global Indexes	Value of the Field associated with the Document.
ImageData	Document	Document data in binary format.		N/A
PageNo	Document	The Page Number for which the next Thumbnail will be generated.	Integer > 0	N/A
ThumbNailFlag	Document	Indicates whether Thumbnail generation has been completed or not. ‘Y‘– Yes ‘N’ – No.	Y or N	N
DuplicateName	Document	This flag indicates whether a new name is to be generated for the given document. ‘Y’ – Yes ‘N’ – No.	Y or N	Y

Output Parameters description

Name	Parent Tag	Description
Option	Root	Unique Option of the call.
Status	Root	Status of the call. If the Status is 0, then call is successful.
Document	Root	It is an outer tag and its inner tags contain the Properties of the document.
DelImageIndex	Root	If the specified document’s image is changed then the previous image is deleted if no other document is associated with it.
LoginUserRights	Root	Rights of the logged in User on the Document.
DocumentIndex	Document	Index of the Document.
DocumentType	Document	Type of Document. Whether Image or Non Image.
ExpiryDateTime	Document	Date and Time when the document would expire.
UsefulInfo	Document	Information associated with the Document
ParentFolderIndex	Document	Index of the Parent Folder of the document.
DocumentVersionNo	Document	Version of the document.
NoOfPages	Document	Number of pages in the document.
DocumentName	Document	Name of the document.
Owner	Document	Owner of the document.
OwnerIndex	Document	Index of the owner of the document.
RevisedDateTime	Document	Time of revision of the Document Property.
AccessDateTime	Document	Date and Time when the document is accessed.
CreationDateTime	Document	Date and Time when the document is created.
VersionFlag	Document	Specifies whether Versioning is allowed. Y – Versioning is allowed. N – Versioning is not allowed.
AccessType	Document	Specifies the scope of accessing the object. S – Shared P – Private I – Inherited
DocumentType	Document	Specifies the Type of the document. I – Image N – Non Image A – Reserved
CreatedByApp	Document	Reserved for internal use.
CreatedByAppName	Document	Extension of the Document. For example, JPG, GIF etc.
ISIndex	Document	Specifies a unique Combination of Image Index and Volume Index for a document stored on the Image Server separated by #. For example, 3#79
TextISIndex	Document	Reserved for Internal Use.
DocumentSize	Document	Size of the document in bytes.
DocOrderNo	Document	The order in which the document is added in the folder.
FTSDocumentIndex	Document	Reserved for internal use.
ODMADocumentIndex	Document	Reserved for internal use.
EnableLog	Document	Flag that specifies whether Log is to be generated for the object. Y – Log is generated. N – Log not generated.
DocumentLock	Document	Flag that specifies whether any User has locked the Object. Y – Object is locked. N – Object is not locked.
Comment	Document	Comments added by User on the object.
Author	Document	Name of the Author of the object.
LockByUser	Document	Name of the user who has locked the document.
FTSFlag	Document	Reserved for internal use.
DocStatus	Document	Specifies the Status of the document. R – Read A – Unread
CheckoutBy	Document	Index of the User who has checked out the document.
FinalizedFlag	Document	Flag that specifies whether the object is finalized. Y- Object is finalized. N – Object is not finalized.
FinalizedDateTime	Document	Date and Time when the object was finalized.
FinalizedBy	Document	Index of the User who has finalized the object.
ThumbNailFlag	Document	Indicates whether Thumbnail generation has been completed or not. ‘Y‘– Yes ‘N’ – No.
Keywords	Document	It as an outer tag, which contains a list of keywords that are attached with the object. Keywords are returned in <KeywordProperty> and </KeywordProperty> Tag.
KeywordProperty	KeywordsDocument	It is the outer tag, which contains the various parameters attached with a particular keyword attached with an object,
Keyword	KeywordPropertyDocument	It contains the keyword attached with the object
ACL	Document	String comprising the Rights of Users / Groups on the current document.
ACLMoreFlag	Document	Reserved
CheckoutStatus	Document	Flag that specifies the checked out status of the document. Y – Document is checked out. N – Document is not checked out.
PullPrintFlag	Document	Reserved for internal use.
DataDefinition	Document	It is an outer tag, which contains the data regarding the Data Class associated with the object, its fields and their values.
DataDefName	DataDefinition	Name of the Data Class associated with the object.
DataDefIndex	DataDefinition	Index of the Data class associated with the given document.
Fields	DataDefinition	It as an outer tag, which contains list of fields in the associated Data Class. Fields are given in <Field> and </Field> Tag.
Field	Fields	It is an outer tag, which contains the various information related to a particular field using different tags.
IndexId	Field	Index of the data field.
IndexName	Field	Name of the data field.
IndexType	Field	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
IndexLength	Field	Length of the field in the given Class.
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 7 – Unique and not Null and indexing done
IndexValue	Field	Value of the field.
GlobalIndexes	Document	Consists of all the global indexes associated with the given document.
Fields	GlobalIndexes	Contains the global index information.
Field	Fields	Contains information of a particular global index.
IndexId	Field	Index of the Data field.
IndexName	Field	Name of the global index.
IndexType	Field	Type of the global index.
IndexLength	Field	Length of the field. Used only in case of String field and User has to send the value.
IndexFlag	Field	Index flag of the field.
IndexValue	Field	Value of the field for this document.

Errors returned from call

Code	Message	Comments
-50139	Expiry date cannot be less than current date.	User has specified an Expiry Date that cannot be less than the Current Date.
-50023	Document not found.	Document for which the User wants to change the Property does not exist in the System.
-50132	Document has been deleted.	Document for which the User wants to change the Property has been deleted from the System.
-50086	Document has expired.	Document for which the User wants to change the Property has been expired from the System.
-50022	Insufficient rights for the current operation.	User does not have Rights for changing the Document Property.
-50071	Document has been checked out.	User cannot change the Property of the document that has been checked out by some User.
-50138	User not Owner or supervisor.	Only Owner or Supervisor can change the Document Property.
-50003	User does not exist.	When the User wants to change the Owner of the document and has specified some User Index, which does not exist in the System.
-50006	User account has expired.	When the User wants to change the Owner of the document and has specified some User, who has expired from the System.
-50010	User not alive.	When the User wants to change the Owner of the document and has specified some User who has been temporarily suspended from the System.
-50027	Properties of the Document have been finalized.	User cannot change the Document Properties that has been finalized.
-50026	Document is in use.	Some User has locked the document.
-50032	Insufficient rights for the current operation.	User must have changed the Rights on the document for changing its Properties.
-50028	Data Class not found.	Document Class that User wants to associate with the document, does not exist in the System.
-50074	Invalid parameters.	Some parameter passed in input is invalid.
-50116	Insufficient privileges for the current operation.	This error occurs when the Access Type of the document is being changed and the User is not the Owner of the document and also does not have Privilege to Add / Delete / Modify Rights.
-50174	Limit on number of Versions exceeded.	Document Version could not be created as number of Versions exceeds the limit.
-50053	Check rights failed.	Process of getting the Rights of the logged in User on document failed.
-50045	GlobalIndex not found.	Data fields supplied by the User do not belong to the Data Definition supplied.
-50081	Data not available	Information about the Data Definition not found.
-50076	Invalid object access type.	Access type of document whose property is to be changed or of the data class to be associated with the document is improper . This error arises in the process of rights checking on the document or the data class.