This
call 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 GlobalIndexes and extracted text. For example, if the User
specifies “a*” in Document Name, then
all the documents whose Name begins with “a” is fetched. Search Results can be sorted in ascending or
descending order of Document Name, Revised Date and Time etc. Search Results are returned in batches and
the Tag <MaximumHitCount></MaximumHitCount> returns the maximum
number of records that fulfils the search criteria irrespective of the Rights
on individual documents. The tag
<MaximumHitCountFlag></MaximumHitCountFlag> in input XML retrieves
this value. Specifying the Search Text can also make Full Text Search.
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
Option |
Root |
Unique option for
the call. |
NGOSearch DocumentExt |
|
CabinetName |
Root |
Name of the Cabinet
to which the User wants to connect. |
|
|
UserDBId |
Root |
User Database ID, which
is returned in the NGO Connect Cabinet call. |
|
|
LookInFolder |
Root |
Index of the folder
in which search is to be performed based on the input criterions. More than
one LookIn Folders can be
specified. In that case, Search will be performed in all the specified
folders. |
Integer > = 0 |
Search will be made
on entire cabinet |
IncludeSubFolder |
Root |
Indicates if search
is to be performed on the subfolders of the specified LookIn Folder or not. This
tag is of significance only when LookIn Folder is
specified. |
‘Y’ – Yes ‘N’ – No |
‘N’ |
Name |
Root |
Name of the
document to be searched. Supports Wild Card search. |
|
Search criteria
will not include the criterion. |
Author |
Root |
Author of the
document. |
|
Search criteria
will not include the criterion. |
Owner |
Root |
Owner of the
document. |
|
Search criteria
will not include the criterion. |
SearchText |
Root |
Text for making
Full Text Search. |
|
Full Text Search
will not be done. |
Rank |
Root |
Indicates whether
Results of the Full Text Search are to be ranked in terms of how close it was
to the actual Search Text supplied. |
‘Y’ – Yes ‘N’ – No |
‘N’ |
SearchOnPrevious Versions |
Root |
Indicates if search
is to be performed on previous Versions of document also or only the latest
Versions of the documents are to be included in the search. |
‘Y’ – Yes ‘N’ – No |
‘N’ |
|
|
|
|
|
CreationDateRange |
Root |
This call will
search for those documents that have the Creation Date in the range specified
in this tag apart from meeting other criteria 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 the 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 in the call. |
Condition, Date |
Search criteria
will not include the criterion. |
ExpiryDateRange |
Root |
Specifies Expiry
Date Range in the same way as Creation DateRange. |
Condition, Date |
Search criteria
will not include the criterion. |
AccessedDateRange |
Root |
Specifies Access
Date Range in the same way as Creation DateRange |
Condition, Date |
Search criteria
will not include the criterion. |
RevisedDateRange |
Root |
Specifies Revised
Date Range in the same way as Creation DateRange |
Condition, Date |
Search criteria
will not include the criterion. |
DataDefinitions |
Root |
Specifies
information about the Data Classes on which search is to be made. |
|
Search criteria
will not include the criterion. |
DataDefIndex |
Data Definitions |
Index of the Data
Class associated with document, which are to be considered for search. Search
will result in those document for which given Data Class is associated |
|
|
DataDefCriterion |
Root |
Specifies the
search criteria regarding Data Classes. |
|
|
DataDefIndex |
DataDef Criterion |
Index of the Data
Class associated with document, which are to be considered for search. Search
will be made for the fields of the given Data Definition index |
|
|
DataDefCriteria |
DataDef Criterion |
This tag encloses
the actual Data Class criteria for search. |
|
|
DataDefIndex |
DataDef Criteria |
It is just a flag
if value is specified then only search will be made on the criteria given
below |
|
|
IndexId |
DataDef Criteria |
Index of Data Class
Field on which the criterion is to be applied. |
|
|
Operator |
DataDef Criteria |
Comparison operator
for search criterion |
>, <, =,
Like, >=, <=,<> |
|
IndexValue |
DataDef Criteria |
Value for
comparison in search criterion |
|
|
JoinCondition |
DataDef Criteria |
This tag is used
when multiple criterions on Data Class field values are to be given. For the
last criterion the tag should be empty else it should have a value ‘AND’. |
|
|
SearchScope |
Root |
Indicates whether a
new search is to be made, or more refined search on the previously returned
search results is to be made 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 |
PreviousList |
Root |
Results of the
previous search are sent in the tag, if more refined search is to be made. |
|
|
Document |
PreviousList |
Contains
information about the document of the previous list. |
|
|
DocumentIndex |
Document |
Index of the
document |
|
|
ParentFolderIndex |
Document |
Index of the Parent
Folder of the document |
|
|
Reference |
Document |
Reference Flag of the
document |
‘O’
– Original ‘R’
– Reference |
|
OrderBy |
Root |
Indicates the field
on which the search results will be sorted e.g. Name of document, Owner,
Created Date Time etc. |
Integer
1
– Document Index 2
– Name 3
– Owner 4
– CreatedDate Time 5
– RevisedDate Time 6
– AccessDate Time 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 |
|
SearchOnAlias |
Root |
Indicates whether
search is to be performed on aliases of the keyword or not. |
‘Y’ – Yes ‘N’- No |
‘N’ |
Keywords |
Root |
Contains
information about the keywords on which search is to be made. |
|
Search criteria
will not include the criterion. |
Keyword |
Keywords |
Specifies the
keywords on which search is to be made. |
|
|
GlobalIndexCriterion |
Root |
Contains
information about the GlobalIndex Criteria on which search is to be made. |
|
Search criteria
will not include the criterion. |
GlobalIndexCriteria |
GlobalIndex Criterion |
Contains single
GlobalIndex criteria |
|
|
IndexType |
GlobalIndex Criteria |
Type of the Global
Index |
‘I’ – Integer ‘B’- Boolean ‘D’- Date ‘F’-Float ‘L’- Long ‘S’-String ‘T’- Text ‘X’- LinkedDoc |
|
IndexId |
GlobalIndex Criteria |
Index of the Global
Index |
Integer > 0 |
|
Operator |
GlobalIndex Criteria |
Comparison operator
for the criteria |
>, <, =,
Like, >=, <= |
|
IndexValue |
GlobalIndex Criteria |
Value for
comparison |
|
|
JoinCondition |
GlobalIndex Criteria |
This tag is used
when multiple criterions on GlobalIndex values are to be given. For the last
criterion the tag should be empty else it should have a value ‘AND’. |
|
|
ReferenceFlag |
Root |
Indicates whether
Only Original documents or References of Documents or Both are to be fetched
in the call. |
‘O’ – Original ‘R’ - Reference ‘B’ - Both |
‘O’ |
SortOrder |
Root |
Indicates whether
search results are to be sorted in Ascending order or Descending order. |
‘A’ – Ascending ‘D’- Descending |
‘A’ |
MainGroupIndex |
Root |
This parameter is
reserved .The default value can be sent. |
Integer >= 0 |
0 |
DocumentType |
Root |
Type of the
document to be searched |
‘I’ - Image ‘N’- Non Image ‘A’
– Reserved |
Search criteria will
not include the criterion. |
DocumentSizeCriteria |
Root |
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 the
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 the criterion. |
NoOfPagesCriteria |
Root |
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 the 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 the criterion. |
CreatedByAppName |
Root |
Application with
which the document was created, i.e. the extension of the document |
|
Search criteria
will not include the criterion. |
StartFrom |
Root |
Used for fetching
search results in batches. Value of the tag will be (Batch Size *
(Current Batch-1)) + 1 |
|
|
NoOfRecordsToFetch |
Root |
Specifies the
Number of records to be fetched in the current batch. |
|
|
CheckOutStatus |
Root |
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 the criterion. |
CheckOutByUser |
Root |
If CheckOut Status tag is ‘Y’
then the call returns all documents, which are checked out by the User
specified in the tag. |
|
Search criteria
will not include the criterion. |
MaximumHitCountFlag |
Root |
Specifies whether
in the search results MaximumHit Count tag is required or not. MaximumHit Count tag indicates
number of records that fulfill the search criteria irrespective of rights on
individual documents. |
‘Y’ – Yes ‘N’ - No |
‘N’ |
ObjectTypes |
Root |
Contains
information about the objects which shall be included while making a Full
text Search |
|
Search criteria
will not include the criterion. |
ObjectType |
Object Types |
Specifies the
object, which shall be included while making Full Text Search. |
1- Document 2 –Ordinary Notes 3- Ordinary Attachments 4- Message 5- Subject 6- Forwarding Note 7- Response 8- FreeText 9- Reserved 10- Reserved 11- Keywords 12- GlobalIndexs 13- DataClass 14- Document Name 15- Author 16- Owner 17- General (All of the above) If more than one
object is to be included for FTS then multiple ObjectType tags can be given
but if all object types mentioned above are to be included for FTS then value
17 can be sent in the tag instead of sending the multiple tags. |
|
DataAlsoFlag |
Root |
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’ |
ThumbNailAlsoFlag |
Root |
Specifies whether
Thumb Nail Data of the documents is also fetched in the search results or not |
‘Y’ –Yes ‘N’ - No |
‘N’ |
AnnotationFlag |
Root |
Annotation flag of the document. |
Y or N |
N |
LinkDocFlag |
Root |
Flag that specifies whether Link
document information should be fetched. |
Y or N |
N |
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. |
SearchResults |
Root |
Encloses
information about the search results fetched in the current batch. |
NoOfRecordsFetched |
SearchResults |
Number of records
fetched in the current batch. |
TotalNoOfRecords |
SearchResults |
Used for getting
search results in batches. The value for the TotalNoOfRecords fetched in
output will be one greater than the NoOfRecordsFetched; if more records exist
in the database otherwise both the values will be same. |
MaximumHitCount |
SearchResults |
Indicates number of
records that fulfill the search criteria irrespective of rights on individual
documents. |
|
Root |
Indicates if
TextValue returned in Full Text Search results is in encoded form or not. |
SearchResult |
Search Results |
Contains
information about a single search result. |
Document |
Search Result |
Contains
information about one document of the search result. |
DocumentIndex |
Document |
Index of the
document. |
ParentFolderIndex |
Document |
Index of the Parent
Folder of the document |
DocumentVersionNo |
Document |
Version of the
current document |
NoOfPages |
Document |
Number of pages of
the document |
DocumentName |
Document |
Document Name |
Owner |
Document |
Owner of the
document |
OwnerIndex |
Document |
Index of the Owner
of the document |
CreationDateTime |
Document |
Date and Time of
creation of the document. |
RevisedDateTime |
Document |
Date and Time when
document was last revised. |
AccessDateTime |
Document |
Date and Time when
document was last accessed. |
ExpiryDateTime |
Document |
Date and Time when
document was last revised. |
ReferenceFlag |
Document |
Indicates whether
the document fetched is an Original document or Reference of a document. |
VersionFlag |
Document |
Indicates whether
Versioning is allowed for the document. |
DocumentType |
Document |
Type of the
document, Image, Non Image. |
CreatedByAppName |
Document |
Extension of the
Document e.g. jpg, gif |
ISIndex |
Document |
a unique
Combination of volume index and
imageindex, separated by #, of a document stored on image server
e.g. 3#79 |
DocumentSize |
Document |
Size of the
document, in bytes |
DocOrderNo |
Document |
Order in which the
document was added in the folder |
EnableLog |
Document |
Indicates whether
Log will be generated for operations performed on the document. |
DocumentLock |
Document |
Indicates whether
or not the document is locked. |
Comment |
Document |
Any Comment
associated with the document |
Author |
Document |
Author of the
document |
FTSFlag |
Document |
Reserved |
DocStatus |
Document |
Indicates whether
the document is read or unread. |
FinalizedFlag |
Document |
Indicates whether
the document has been finalized or not. |
FinalizedBy |
Document |
Name of the User
who has finalized the document. |
FinalizedDateTime |
Document |
Date and Time when
the document was finalized. |
LoginUserRights |
Document |
Rights of login
User on the document |
FiledByUser |
Document |
Name of the User
who has filed the document |
CheckoutStatus |
Document |
Indicates whether
some User has checked out the document or not. |
CheckoutBy |
Document |
User by whom the Document is being checked out. |
LockByUser |
Document |
User by whom the Document is being locked. |
OriginalFolderLocation |
Document |
|
LinkDocFlag |
Document |
This indicates whether the Document is being
linked with someother document or not. |
AnnotationFlag |
Document |
This indicates whether there
are any Annotations on the Document or not. |
PullPrintFlag |
Document |
PullPrint flag associated with the document. Its valid values are: Y – pullprint generated P – Pending F – Failed I – Insoview generated. |
DataDefinition |
Document |
Contains
information about the Data Class associated with the document. |
DataDefIndex |
Data Definition |
Index of the Data
Class associated with the document. |
DataDefName |
Data Definition |
Name of the Data
Class associated with the document. |
Fields |
Data Definition |
Contains
Information about various fields of the Data Class. |
Field |
Fields |
Contains
Information about single fields of the Data Class. |
IndexId |
Field |
Index of the Data
Class field. |
IndexName |
Field |
Name of the Data
Class field. |
IndexType |
Field |
Type of the Data
Class field. |
IndexLength |
Field |
Length of the Data
Class field. |
IndexAttribute |
Field |
Attribute of the
Data Class Field. |
IndexFlag |
Field |
Specifies whether
the given field is global or specific
to the Data Class. |
IndexValue |
Field |
Value of the Data
Class field associated with the document. |
UsefulInfoFlag |
Field |
This indicates
whether Usefulinfo is present or not. ‘Y’
– Yes ‘N’
– No |
UsefulInfosize |
Field |
Contains the size
of the usefulinfo. |
Keywords |
Document |
|
KeywordProperty |
Keywords |
|
Keyword |
KeywordProperty |
|
ThumbNailFlag |
Document |
Specifies whether
Thumbnail data is present or not |
ThumbNail |
Document |
Contains the data
required for thumbnail view |
PageNo |
ThumbNail |
Page Number of
which Image Data is retrieved |
ImageData |
ThumbNail |
Binary data for
thumbnail view |
Hits |
|
Contains
information about the Full Text Search hits |
Hit |
Hits |
Contains
information about single FTS Hit |
ObjectIndex |
Hit |
Index of the object
on which FTS Hit has occurred |
ObjectType |
Hit |
Type of the object
on which hit has occurred e.g. Document Name or Owner or Keywords etc. |
Rank |
Hit |
Rank of FTS Hit in
terms of how close it was to the actual text supplied for FTS. |
TextValue |
Hit |
First 255
characters of the Document which has been matched for the search. |
Code |
Message |
Comments |
-50074 |
Invalid parameters. |
Some parameters
given to the call are invalid. e.g. if search scope is 1 or 2 and
PreviousList is empty . This error can also
occur if ordering of search results is to be done on some Data Class field
type and search criteria includes some other field type. |
-50046 |
Invalid Field type. |
Field type of some
field (global index / field of a data
class ) on which the search is made is not valid. |