NGOAddDocument

This call is used to logically add a document to a folder. Physical addition of a document in the System should be done by using AddDocument function of Image Server API, prior to making this JTS call. Data Definition and Keywords can be associated at the time of addition of the document. User can also set FTS Data at the time of addition of document, by specifying the flag “TextAlso” as ‘Y’.

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.	NGOAdd Document	N/A
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
GroupIndex	Root	This parameter is reserved. Default value can be sent.		0
Document	Root	It specifies the complete information about the document using various tags.
ParentFolderIndex	Document	Specifies the Index of the Parent Folder of the document.		0
NoOfPages	Document	Specifies the number of pages in the document.		0
AccessType	Document	Specifies the scope of accessing the document.	S – Shared P – Private I – Inherited	S
DocumentName	Document	Name of the document.		New Document (Incremental no) For example, if a document with document name, new document(1) is already there and new document is created with name new document(2).
CreationDateTime	Document	Creation Date and Time of the document.		Current Date and Time of the Server.
VersionFlag	Document	Specifies whether Auto Versioning of document is allowed.	Y – Versioning is allowed. N – Versioning is not allowed.	Y
DocumentType	Document	Specifies the Type of the document.	I – Image N – Non Image A – Reserved	N
DocumentSize	Document	Size of the document in bytes.		0
CreatedByApp	Document	Reserved for internal use.		0
CreatedByApp Name	Document	Extension of the Document. For example, JPG, GIF etc.		Blank
ISIndex	Document	Specifies a unique Combination of Image Index and Volume Index for a document stored on Image Server separated by #. Example, 3#79		1# Volume Index of the Parent Folder
TextISIndex	Document	Reserved for internal use.
FTSDocument Index	Document	Reserved for internal use.
ODMADocument Index	Document	Reserved for internal use.
Comment	Document	Comments added by the User on the document.		Blank
Author	Document	Name of the author of the document.		Blank
OwnerIndex	Document	Index of the Owner of the document.		User Index of the logged in User
EnableLog	Document	Flag that specifies whether to generate log for the document added.	Y – Log is generated. N – Log not generated.	Y
FTSFlag	Document	Reserved for internal use.
NameLength	Document	The maximum length of 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. The Document Name, if larger than this NameLength, will then be truncated to the specified length.		255
DataDefinition	Document	It contains the data regarding the Data Class to be associated with the document and its fields and their values.		N/A
DataDefIndexName	DocumentDataDefinition	IndexName of the Data Class associated with the document.		N/A
Fields	DataDefinition	It contains the information about the fields in the dataclass		N/A
Field	Fields	Description containing information regarding particular field		N/A
IndexId	Field	Index of the Field associated with the Data Class
IndexType	Field	The type of data that the field would store in the Field
IndexValue	Field	The actual data to be stored in the field
ImageData	Document	Document data in binary format.		N/A
VersionComment	Document	Comment to be put for a version of the document		Blank
Keywords	Document	Specifies the list of keywords that are to be added with the document.		N/A
Keyword	Keywords	Specifies the keyword that is to be added with the document.		N/A
TextAlsoFlag	Root	Specifies whether the FTS data is to be set. Y – FTS Data is to be set. N – FTS Data is not set.		N
DuplicateName	Root	Reserved for internal use.
Data	Root	Data for the FTS, which is also to be set.		BLANK
ImageData	Root	Document data in binary format.		N/A
ThumbNailFlag	Root	Specifies whether Thumbnail generation has been completed or not. ‘Y‘– Yes ‘N’ – No.	‘Y’ or ‘N’	N

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.
Document	Root	It specifies the complete information about the document using various tags.
DocumentIndex	Document	Index of the document that is added.
ParentFolderIndex	Document	Specifies the Index of the Parent Folder of the document.
DocumentVersionNo	Document	Specifies the current version of the document.
NoOfPages	Document	Specifies the number of pages in the document.
DocumentName	Document	Name of the document added.
Owner	Document	Name of the Owner of the document.
OwnerIndex	Document	Index of the Owner of the document.
CreationDateTime	Document	Creation Date and Time of the document.
RevisedDateTime	Document	Revision Date and Time of the document.
AccessDateTime	Document	Date and Time when the document was last accessed.
ExpiryDateTime	Document	Date and Time when the document will expire.
VersionFlag	Document	Specifies whether Versioning of document is allowed. Y – Versioning is allowed. N – Versioning is not allowed.
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
CreatedByApp	Document	Not used.
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 #. Example, 3#79.
TextISIndex	Document	Not used.
DocumentSize	Document	Size of the document in bytes.
DocOrderNo	Document	Order of the document in the Folder where it is added.
FTSDocumentIndex	Document	Not used.
ODMADocumentIndex	Document	Not used.
EnableLog	Document	Flag that specifies whether to generate log for the document added. 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.
LockByUser	Document	Index of the User who has locked the document.
Comment	Document	Comments added by the User on the document.
Author	Document	Name of the Author of 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 this document.
FinalizedFlag	Document	Flag that specifies whether the document is finalized. Y – Document is finalized. N – Document is not finalized.
FinalizedBy	Document	Index of the User who has finalized the document.
FinalizedDateTime	Document	Date and Time when the document was finalized.
LoginUserRights	Document	Rights of the logged in User on the document.
CheckOutStatus	Document	Indicates whether the document has been checked out or not ‘N’ – No, ‘Y’ – Yes
ACLMoreFlag	Document	Reserved for internal use.
PullPrintFlag	Document	Reserved for internal use.
ThumbNailFlag	Document	Specifies whether Thumbnail related information is present. Y – Contains data related to Thumbnail View. N – Do not contain the data related to Thumbnail View.
ACL	Document	For Internal Use.
DataDefinition	Document	It contains the data regarding the Data Class associated with the document and its fields and their values.
DataDefIndex	DataDefinition	The Index of the Data Definition associated with the document.
DataDefName	DataDefinition	The name of the Data Definition associated with the document.
Fields	DataDefinition	Contains the value corresponding to various fields of the associated Data Definition.
Field	Fields	Contains information about individual fields of Data Definition.
IndexId	Field	Field Index.
IndexName	Field	Name of the field.
IndexType	Field	Type of the field. I – Integer Type T – Text Type S – String Type L – Long Type D – Date Type B – Boolean Type F – Float Type X – LinkedDoc
IndexLength	Field	Length of field.
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
IndexValue	Field	Value associated with the field.
MainGroupIndex	Root	This parameter is Reserved.

Errors returned from call

Code	Message	Comments
-50074	Invalid parameters.	The value for some input parameter is not correct or is invalid.
-50016	Group not found.	Group in which document is to be added does not exist.
-50058	Specified User does not exist.	Owner Index specified in input does not exist in the system.
-50017	Folder not found.	The folder in which the document has to be added does not exist.
-50133	Folder has been deleted.	The folder in which the document has to be added has been deleted.
-50104	Invalid Folder type.	Folder in which the User wants to add document is of invalid type. For example, Trash. User cannot add folder to Trash Folder.
-50021	Folder is in use.	The folder where the document has to be added is currently in use.
-50019	Properties of the Folder has been finalized.	Folder Properties has been finalized. Document cannot be added to folder that has been finalized.
-50028	Data Class not found.	Data Class which was to be associated with the document does not exist
-50018	Insufficient rights for the current operation.	User does not have Rights to add document to the current folder. The User must have atleast Write Rights on the folder.
-50124	Object with this name already exists.	Document with the name sent in the call already exist.
-50076	Invalid object access type.	Access type of folder in which document is to be added is improper. This error arises in the process of rights checking on the folder.
-50023	Document not found.	Document to which the keywords are to be added does not exist.
-50132	Document has been deleted.	Document to which keywords are to be added has been deleted or moved to Trash.
-50086	Document has expired.	Document to which keywords are to be added has expired.
-50071	Document has been checked out.	Document to which keywords are to be added is checked out.
-50027	Properties of the Document has been finalized.	Properties of the document to which keywords are to be added are finalized.