Set As Latest Version

 

Function Name: getSetAsLatestVersionXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function will set the selected Version of document as the Current Version. The Version Number, which the User wants to set as the Current Version has to be supplied in the InputXml. 

 

Input Parameters

Sample InputXML

Output Parameters

Sample OutputXML

View xml API::NGOSetAsLatestVersion

  

 

Prototype:

public String getSetAsLatestVersionXml(String cabinetName, String userDbId, String currentDateTime,

String docIndex, String versionNo, String versionComment, String nameLength, String limitCount, String supAnnotVersion)

 

OverLoaded Functions:

public String getSetAsLatestVersionXml(String cabinetName, String userDbId,

String currentDateTime, String docIndex,

String versionNo, String versionComment)

 

public String getSetAsLatestVersionXml(String cabinetName, String userDbId,

String docIndex, String versionNo

String versionComment)

Input Parameters:

Name

Description

Valid Values

Default Behavior

cabinetName

Name of the Database Cabinet to which the User wants to connect.

 

N/A

userDbId

UserDatabase ID, which is returned in the NGOConnectCabinet call.

 

N/A

currentDateTime

It indicates the CurrentDateTime when the call is made.

Valid date in the format yyyy-mm-dd hh:mm:ss

CurrentDateTime

docIndex

 It indicates the unique Index of the document.

 

N/A

versionNo

It indicates the Version Number of the document that is to be set as the Current Version.

 

N/A

versionComment

Any Comment associated with the document while setting it as the Latest Version.

 

Blank

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

 

LimitCount

Maximum number of Versions that can be created for the document.

 

 

supAnnotVersion

Specifies whether to suppress the carry forwarding of Annotations with the object Version.

Y – Do not keep the annotations previously added when a new Version is added

N – Keep the annotations of the old Version when a new Version is added

 

 

Output Parameters:

An inputXml string of the NGOSetAsLatestVersion call.