NGOMoveDocumentExt

This transaction is meant for moving the document from one folder to another.

 

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.

NGOMove

DocumentExt

N/A

CabinetName

Root

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

The name of the Cabinet.

N/A

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect

Cabinet call.

 

N/A

DestFolderIndex

Root

Folder Index of the destination folder to which the documents have to be moved.

Integer >=0

N/A

NameLength

Root

The maximum length of the Document Name supported by JTS is 255 characters but if the User wishes that the maximum length of the document to be copied is lesser than 255 characters, then it can be specified in this tag. If the Document Name is larger than the specified NameLength, then it is truncated to the specified length.

Integer >=0

 

CurrentDateTime

Root

The Date and Time at which the documents are being moved.

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

The current Date and Time.

DeleteReference

AlsoFlag

Root

Whether the references of the documents being moved are to be deleted are not, this is checked only when the document is move to the Trash Folder.

‘Y’ – Yes

‘N’ – No

‘N’

DuplicateName

Root

This flag indicates whether a new name is to be generated for the given document.

‘Y’ – Yes

‘N’ – No.

‘Y‘ or ‘N’

‘Y’

Documents

Root

Contains information about the documents to be moved.

 

 

Document

Documents

Contains information about the document to be moved.

 

 
DocumentIndex

Document

Document Index of the document being moved.

Integer >=0

N/A

ParentFolderIndex

Document

Folder Index of the Parent Folder of the document.

Integer >=0

NULL

 

Output Parameters description

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.

Documents

Root

Contains information about the documents that have been moved.

Document

Documents

Contains information about the document to be moved.

DocumentIndex

Document

Document Index of the document being moved.

ParentFolderIndex

Document

Folder Index of the Parent Folder of the document.

DocumentVersionNo

Document

The Version Number of the document that has been moved (Current Version).

DocumentName

Document

The name of the document that has been moved.

CreationDateTime

Document

Date and Time when the document is created.

RevisedDateTime

Document

Time of revision of the Document Property.

AccessDateTime

Document

Date and Time when the document is accessed.

VersionFlag

Document

Signifies whether the Versions of the moved document exist or not.   ‘Y’ – Yes, ‘N’ – No

DocumentType

Document

Type of the moved document.

‘I’ – Image, ‘N’ – Non image, ‘X’ – First view

CreatedByAppName

Document

The extension of the moved document.

ISIndex

Document

The Image and Volume Index of the moved document separated by #.

NoOfPages

Document

Number of pages in the document.

DocumentSize

Document

Size of the document moved in bytes.

DocOrderNo

Document

The order in which the document is added to a Folder.

Comment

Document

Comments that were added to the moved document while adding or changing its Properties.

FTSFlag

Document

This two character flag indicates whether the contents and annotations of the moved document have been extracted and Indexed. The first flag is for the document and the second flag is for Annotation.

‘P’ – Pending

‘F’ – Extraction Failed

‘T’ – Extracted

‘N’ – Not to be Ftsed

DocStatus

Document

The Status of the moved document.

 ‘A’ – Added, ‘R’ – Read

ACL

Document

String comprising the Rights of Users / Groups on the current document.

CheckOutStatus

Document

Whether the specified document is checked out or not.

PullPrintFlag

Document

Indicates the status of the document. The valid values are:

Y – Pullprint generated.

P – Pending.

F – Failed.

I – Insoview generated.

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.

Author

Document

Name of the Author of the object.

ExpiryDateTime

Document

Date and Time when the Object Expires.

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.

FailedDocuments

Root

Contains the information about the documents that could not be moved.

FailedDocument

Failed

Document

Contains information about the documents that could not be moved.

DocumentIndex

Failed

Document

Document Index of the document that could not be moved.

StatusCode

Failed

Document

Contains the Error code that is returned when the move operation of the document failed.

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameters.

This error occurs when the list of documents to be moved is not supplied.

-50017

Folder not found.

The folder to which documents are being moved does not exist.

-50133

Folder has been deleted.

The folder to which the documents are being moved has been deleted.

-50076

Invalid object access type.

This Error occurs while checking the Rights on the document and the Access Type of few documents is improper.

 

Warnings returned from call

Code

Message

Comments

5001

Not all Documents Moved.

Some of the documents could not be moved.

 

Codes returned in the form of status code

Code

Message

Comments

-50170

Document is deleted or moved.

Document to be moved has already been deleted or moved.

-50132

Document has been deleted.

Document to be moved has been deleted. This exception comes when document is in User’s Trash.

-50072

Document already exists.

Document already exists in the folder.

-50136

Document reference already exists.

Reference of the document already exists.

-50133

Folder has been deleted.

Parent Folder of the document to be moved has been deleted.

-50068

Cannot move document.

Document could not be moved as Folder Type of either the source or destination folder is improper.

-50023

Document not found.

Document to be moved does not exist.

-50026

Document is in use.

Document could not be moved as the document has been locked for some purpose.

-50071

Document has been checked out.

Document could not be moved as the document has been checked out.

-50022

Insufficient rights for the current operation.

Invalid Rights on the document.

-50018

Insufficient rights for the current operation.

Invalid Rights on the folder.

-50009

User with the same name already exists.