This call will set the specified Version as the current Version of the document. The Version Number of the document that is to be made as the current Version has to be supplied in the InputXml.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
Option |
Root |
Unique option for the call. |
NGOSetAs LatestVersion |
|
|
CabinetName |
Root |
Name of the Cabinet to which the User wants to connect. |
|
|
|
UserDBId |
Root |
UserDatabase ID that is returned in the NGOConnectCabinet call. |
|
|
|
CurrentDateTime |
Root |
It indicates the current Date and Time when the call is made. |
CurrentDate Time |
|
DocumentIndex |
Root |
It indicates the unique Index of the document. |
|
|
VersionNo |
Root |
It indicates the Version Number of the document that is to be set as the Current Version. |
|
|
|
Root |
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 |
Root |
Maximum number of Versions that can be created for the document. |
|
|
|
Comment |
Root |
Any Comment associated with the document while setting it as the latest Version. |
|
|
|
SupAnnotVersion |
Root |
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 |
|
|
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. |
|
Document |
Root |
A list of information about the document is given between the <Document> and </Document> tags. |
|
DocumentIndex |
Document |
It indicates the unique Index of the document. |
|
ParentFolderIndex |
Document |
Index of the Parent Folder of the document. |
|
DocumentVersionNo |
Document |
Version of the current document. |
|
DocumentName |
Document |
It specifies the Document Name. |
|
Owner |
Document |
Specifies the Owner of the document. |
|
CreationDateTime |
Document |
It indicates the creation Date and Time of the document. |
|
RevisedDateTime |
Document |
Date and Time when the folder was last revised. |
|
AccessDateTime |
Document |
Date and Time when the object was last accessed. |
|
|
Document |
|
|
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. |
|
DocumentSize |
Document |
Size of document in bytes. |
|
DocumentType |
Document |
It indicates the type of the document. |
|
DocumentLock |
Document |
Flag to indicate whether the document is locked or not. |
|
Finali |
Document |
Flag that specifies whether the object is finalized. Y- Object is finalized. N – Object is not finalized. |
|
DocStatus |
Document |
Specifies the Status of the document. R – Read A – Unread |
|
CheckOutStatus |
Document |
Flag that specifies the CheckOut status of the document. Y – Document is checked out. N – Document is not checked out. |
|
LockByUser |
Document |
Index of the User who has locked the object. |
|
DocOrderNo |
Document |
The order in which the document is added to the folder. |
|
PullPrintFlag |
Document |
Reserved for internal use. |
|
OMDADocumentIndex |
Document |
Reserved for internal use. |
|
CreatedByAppName |
Document |
It indicates the Extension of the Document. For example, JPG, GIF etc. |
|
EnableLog |
Document |
Flag that specifies whether Log is to be generated for the object. Y – Log is generated. N – Log not generated. |
|
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. |
|
CreatedByApp |
Document |
Reserved for internal use. |
|
NoOfPages |
Document |
Number of pages in the document. |
|
FTSDocumentIndex |
Document |
Reserved for internal use. |
|
Comment |
Document |
Comments added by User on the object. |
|
Author |
Document |
Name of the Author of the object. |
|
FTSFlag |
Document |
Reserved for internal use. |
|
ExpiryDateTime |
Document |
Date and Time when the document would expire. |
|
FinalizedDateTime |
Document |
Date and Time when the object was finalized. |
|
ACL |
Document |
String comprising the Rights of Users / Groups on the current document. |
|
ACLMoreFlag |
Document |
Reserved |
|
ThumbNailFlag |
Document |
Indicates whether Thumbnail generation has been completed or not. ‘Y‘– Yes ‘N’ – No. |
|
FinalizedBy |
Document |
Index of the User who has finalized the object. |
|
CheckoutBy |
Document |
Index of the User who has checked out the document. |
|
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 |
Keywords |
It is the outer tag, which contains the various parameters attached with a particular keyword attached with an object, |
|
Keyword |
KeywordProperty |
It contains the keyword attached with the object |
|
GlobalIndexes |
Document |
Consists of all the global indexes associated with the given document. |
|
Field |
GlobalIndexes |
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. |
|
Code |
Message |
Comments |
|
-50023 |
Document Not Found |
Document for which the User wants to set latest Version does not exist. |
|
-50111 |
Invalid Version For Document |
The Document Version that the User has specified to set, as the latest Version does not exist. |
|
-50174 |
Limit on number of Versions exceeded. |
Document Version could not be created as the number of Versions exceeded the limit. |
|
-50023 |
Document not found. |
Document whose Version is to be created does not exist. |
|
-50132 |
Document has been deleted. |
Document whose Version is to be created has been deleted. |
|
-50053 |
Check rights failed. |
Process of retrieving the Rights of the logged in User on the document failed. |
|
-50022 |
Insufficient rights for the current operation. |
Logged in User does not have sufficient Rights on the document whose Version is to be created. |
|
-50026 |
Document is in use. |
Document whose Version is to be created has been locked. |
|
-50027 |
Properties of the Document have been finalized. |
Document whose Version is to be created has been finalized. |
|
-50071 |
Document has been checked out. |
Document whose Version is to be created is checked out. |