Change Document Property

Function Name: getChangeDocumentPropertyXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This function is meant for modifying the Properties of an existing Document.

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

Prototype:

public String getChangeDocumentPropertyXml	(
		String cabinetName,
		String userDbId,
		String groupIndex,
		String documentIndex,
		String noOfPages,
		String documentName,
		String owner,
		String accessDateTime,
		String expiryDateTime,
		String versionFlag,
		String accessType,
		String documentType,
		String createdByApp,
		String documentSize,
		String createdByAppName,
		String docImageIndex,
		String textImageIndex,
		String enableLog,
		String ODMADocumentIndex,
		String documentLock,
		String comment,
		String documentAuthor,
		String FTSFlag,
		String docStatus,
		String finalizedBy,
		String finalizedDateTime,
		String loginUserRights,
		String keywordPropList,
		String dataDefList,
		String globIdList,
		String versionComment,
		String parentFolderIndex
		String nameLength
		String imageData
		String pageNo
		String thumbNailFlag
		String duplicateName
	)

Overloaded Function:

public String getChangeDocumentPropertyXml	(
		String cabinetName,
		String userDbId,
		String groupIndex,
		String documentIndex,
		String noOfPages,
		String documentName,
		String owner,
		String accessDateTime,
		String expiryDateTime,
		String versionFlag,
		String accessType,
		String documentType,
		String createdByApp,
		String documentSize,
		String createdByAppName,
		String docImageIndex,
		String textImageIndex,
		String enableLog,
		String ODMADocumentIndex,
		String documentLock,
		String comment,
		String documentAuthor,
		String FTSFlag,
		String docStatus,
		String finalizedBy,
		String finalizedDateTime,
		String loginUserRights,
		String keywordPropList,
		String dataDefList,
		String globIdList,
		String versionComment,
		String parentFolderIndex
	)

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
GroupIndex	Index of the Group. Reserved default value should be send by User.	Integer >0	0
documentIndex	Index of the document.	Integer >0	N/A
NoOfPages	Number of pages in the document.	Integer >0	null
documentName	Name of the document.	Any String (Valid)
Owner	User Index of the Owner of the document.	Integer > 0	null
accessDateTime	Date and Time when the document was last accessed.	Valid Date and Time in the format yyyy-mm-dd hh:mm:ss	null
expiryDateTime	Date and Time when the document will expire.	Valid date and time in the format yyyy-mm-dd hh:mm:ss	null
VersionFlag	To indicate whether the Versions are allowed.	‘Y’ ‘N’
AccessType	Specifies the scope of accessing the Object.	S – Shared P – Private I – Inherited
documentType	Specifies the Type of the document.	I – Image N – Non Image A – Reserved	N/A
createdByApp	This parameter is reserved and it can be used with the default value.	Null	null
documentSize	Size of the document in bytes.	Integer >= 0	null
CreatedByApp Name	Extension of the Document. For example, JPG, GIF etc.		null
docImageIndex	Specifies a unique Combination of Image Index and Volume Index for a document stored on Image Server separated by #. Example, 3#79.		null
textImageIndex	This parameter is reserved and it can be used with the default value.	Null	null
EnableLog	Flag, which specifies whether Log is to be generated for the Object.	Y – Log is generated. N – Log not generated.	‘Y’
ODMADocument Index	This parameter is reserved and it can be used with the default value.	Null	null
documentLock	Flag, which specifies whether the Object has been locked by some User.	Y – Object is locked. N – Object is not locked.	null
Comment	Comments added by the User on the Object.	Any String (Valid)	null
documentAuthor	Name of the Author of the Object.		null
FTSFlag	This parameter is reserved and it can be used with the default value.	null	null
DocStatus	Status of the document on the basis of which the count has to be calculated.	‘A’ – Added ‘R’ - Read	Any value other than ‘A’ would be treated as ‘R’.
FinalizedFlag	Flag, which specifies whether the Object is finalized.	Y- Object is finalized. N – Object is not finalized.	null
FinalizedBy	Index of the User who has finalized the Object.	N – Object is not finalized.	null
finalizedDateTime	Date and Time when the Object was finalized.		null
loginUserRights	Rights of the logged in User on the Object.		null
keywordPropList	Contains information about the Keywords that are to be associated with the document. This List can be generated using the functions getKeywordXml and getKeywordPropertyXml.		N/A
DataDefList	Contains information about the DataDefinition that is to be associated with document. This List can be generated using the functions GetChangeDocPropFieldXml and GetChangeDocPropDataDefXml.		N/A
GlobIdList	List containing Global Indexes that the Users want to associate with the document. This List can be generated using the function appendGlobalIndexProperty.		N/A
versionComment	Comment appended by the User on adding new Version.		null
ParentFolderIndex	Parent Folder Index of the document.	Integer >0
NameLength	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
ImageData	Document data in binary format.		N/A
PageNo	The Page Number for which the next Thumbnail will be generated.	Integer > 0	N/A
ThumbNailFlag	Indicates whether Thumbnail generation has been completed or not. ‘Y‘– Yes ‘N’ – No.	Y or N	N
DuplicateName	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:

Input Xml of call NgoChangeDocumentPropertyXML.