Search Document

Function Name: getSearchDocumentExtXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This function is used for searching the documents in the System, based on certain criterion. Wild Card Search is allowed on Name, Owner, Keywords, and IndexValue for Data Fields and Global Indexes. For example, if a User specifies a* in the ‘Document Name’ for the Search, then all the documents whose Name begins with ‘a’ are fetched. Search Results can be sorted in ascending or descending order on Document Name, RevisedDateTime etc. Search Results are returned in Batches.

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

Prototype:

public String getSearchDocumentExtXml( String cabinetName, String userDbId,

String lookInFolderList,

String addSubFolderFlag,

String name, String owner,

String rankFlag, String searchText,

String versionFlag,

String createdDateTimeCriteria,

String expiryDateTimeCriteria,

String accessDateTimeCriteria,

String revisedDateTimeCriteria,

String dataDefIdList, String dataDefCriterion,

String searchScope, String prevDocList,

String searchOnAlias, String keywordList,

String globIdCriteriaList, String referenceFlag,

String sortOrder, String groupIndex,

String startFrom, String noOfRecordsToFetch,

String orderBy , String documentType ,

String docSizeRes,

String noOfPagesCriteria,

String appNameRes,

String checkOutStatus, String totalhitcount,

String checkOutBy, String objectType,

String dataAlsoFlag, String documentsize,

String createdbyappname,String Author,

String AnnotationFlag, String LinkDocFlag))

Input Parameters:

Name	Description	Valid Values	Default Behaviour
cabinetName	Name of the Database Cabinet to which the User wants to connect.		N/A
UserDBId	UserDatabse ID, which is returned in the ConnectCabinet call.		N/A
lookInFolderList	Index of the Folder in which search is to be performed based on the input criterions. More than one LookInFolders can be specified .In that case, Search will be made in all the specified Folders. This List can be obtained using the helper function, getLookInFolderXml.	Integer > = 0	Search will be made on entire cabinet
addSubFolderFlag	Indicates if Search is to be performed on the subfolders of the specified LookInFolder or not. This tag is of significance only when LookInFolder is specified.	‘Y’ – Yes ‘N’ – No	‘N’
Name	Name of the document to be searched. Supports Wild Card Search.		Search criteria will not include this criterion.
Owner	Owner of the document.		Search criteria will not include this criterion.
RankFlag	Reserved for internal use.	Null
SearchText	Text for making Full Text Search.	Null
VersionFlag	Indicates if Search is to be made on previous Versions of the document or only on the latest Versions of the document.	‘Y’ – Yes ‘N’ – No	‘N’
CreatedDateTime Criteria	This function searches for those documents that have the Creation Date in the range specified by this tag, apart from meeting other criteria Condition and Dates for specifying the range have to be supplied in this tag separated by a comma. Condition can be any of the following operators - Between, >, >=, =, <, <= If operator ‘between’ is used, then two Dates should be specified. Date Format - dd/mm/yyyy Example, if information given in this tag is “ BETWEEN, 12/12/1998,12/12/1999”, then all those documents which meet the other criteria and whose Creation Date lies between the two specified Dates will be returned .	Condition, Date	Search criteria will not include this criterion.
ExpiryDateTimeCriteria	Specifies Expiry Date Range in the same way as createdDateTimeCriteria.	Condition, Date	Search criteria will not include this criterion.
AccessDateTimeCriteria	Specifies Access Date Range in the same way as createdDateTimeCriteria.	Condition, Date	Search criteria will not include this criterion.
RevisedDateTimeCriteria	Specifies Revised Date Range in the same way as createdDateTimeCriteria.	Condition, Date	Search criteria will not include this criterion.
dataDefIdList	Index of the Data Class on which Search is to be performed. This List can be obtained using the helper function, getDataDefIdXml.		Search criteria will not include this criterion.
dataDefCriterion	Specifies the Search criteria regarding Data Classes. Xml can be generated using the functions getDataDefCriterionXml and getDataDefCriteriaXml.		Search criteria will not include this criterion.
SearchScope	Indicates whether a new Search or more Refined Search on the previously returned Search Results is to be performed or the previous Search Results are to be returned along with new Search Results.	Integer value 0 - New Query 1 – Append to previous list 2 – Search in previous list	0
prevDocList	If more Refined Search is to be performed, the Results of the previous Search are sent in this tag.	List of document indexes separated by #.	If search scope is 0 then Search criteria will not include this criterion.
searchOnAlias	Indicates whether Search is to be performed on Aliases of the Keyword or not.	‘Y’ – Yes ‘N’- No	‘N’
KeywordList	Specifies the search criteria regarding Keywords. Xml can be generated using the function getKeywordXml.		Search criteria will not include this criterion.
globIdCriteriaList	Specifies the search criteria regarding Global Indexes. Xml can be generated using the function getGlobIdCriteriaXml.		Search criteria will not include this criterion.
referenceFlag	Indicates whether Only Original documents or References of Documents or Both are to be fetched in this call.	‘O’ – Original ‘R’ - Reference ‘B’ - Both	‘O’
SortOrder	Indicates whether Search Results are to be sorted in Ascending order or Descending order.	‘A’ – Ascending ‘D’- Descending	‘A’
GroupIndex	This parameter is reserved. The default value can be sent.	Integer >= 0	0
StartFrom	A number starting from which the Objects are to be taken from the Records in the Result Set.	Integer > 0	N/A
NoOfRecordsToFetch	Specifies the Number of Records to be fetched in the current batch.		N/A
OrderBy	Indicates the field on which the Search Results will be sorted. Example, Name of document, Owner, CreatedDateTime etc.	Integer 1 – Document Index 2 – Name 3 – Owner 4 – CreatedDate time 5 –RevisedDate Time 6 –Accessed DateTime 7 – DataDefinition Index 8 – Document Type 9 – AppName 10 – NoOfPages 11-DocumentSize 12-Document Lock 13 – DocStatus 14 – ExpiryDate Time 15-FinalisedFlag 16-FinalizedDate Time 17- CheckOut Status 18- Document OrderNo	N/A
documentType	Type of the document to be searched.	‘I’ - Image ‘N’- Non Image ‘A’ – Reserved	All type of documents irrespective of type will be fetched.
DocSizeRes	Reserved for internal use.	Null
noOfPagesCriteria	Specifies the search criteria regarding the number of pages of the document. Condition and number of pages for specifying the range, all comma separated; have to be supplied in this tag. Condition can be any of the following operators - Between, > ,>= , = , < , <= If operator ‘between’ is used then two values should be specified.	Condition, NoOfpages	Search criteria will not include this criterion.
AppNameRes	Reserved for internal use.	Null
CheckOutStatus	Indicates whether Search is to be performed only on the Checked Out documents or on the non-Checked Out documents.	‘Y’ – Yes ‘N’ - No	Search criteria will not include this criterion.
Totalhitcount	Specifies whether in the Search Results MaximumHitCount tag is required or not. MaximumHitCount tag indicates number of Records that fulfill the search criteria irrespective of Rights on individual documents.	‘Y’ – Yes ‘N’ – No	‘N’
CheckOutBy	If CheckOutStatus tag is ‘Y’, then this call returns all documents, which are Checked Out by the User specified in this tag.		Search criteria will not include this criterion.
ObjectType	Reserved for internal use.	Null
DataAlsoFlag	Specifies whether the Data Class field values associated with a document will also be returned in the Search Results or Only the Data Class associated will be returned.	‘Y’ –Yes ‘N’ – No	‘N’
Documentsize	Specifies the search criteria regarding the size of the document. Condition and size for specifying the range, all comma separated; have to be supplied in this tag. Condition can be any of the following operators - Between, >, >=, =, <, <= If operator ‘between’ is used then two values should be specified. Size to be specified in bytes.	Condition, size	Search criteria will not include this criterion.
Createdbyappname	Application with which the document was created, that is, the Extension of the document.	JPEG, GIF etc	Search criteria will not include this criterion.
Author	Name of the author of the document
AnnotationFlag	If this parameter has value Y then the tag with same name is returned with Y/N Indicating whether the document has annotation or not.	Y-Yes N-No	Y/N
LinkDocFlag	It tells whether the linked documents should be included in the search result or not.	‘Y’ – Yes ‘N’ – NO	‘N’

Output Parameters:

Input Xml of call NGOSearchDocumentExt.