This call is used for searching
the folders in the system based on certain criterion. Wild Card Search is
allowed on Name, Owner, and IndexValue for Data Fields. Search results can be sorted
in ascending or descending order on Folder Name, Folder Index etc. Search results are returned in batches and
the Tag <MaximumHitCount></MaximumHitCount> will return Maximum
number of records that fulfill the search criteria irrespective of Rights on individual
folders. The tag in input XML <MaximumHitCountFlag></MaximumHitCountFlag>,
retrieves this Value.
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
Option |
Root |
Unique option for the call. |
NGOSearch Folder |
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 |
LookInFolder |
Root |
Index of the folder in which search
is to be made based on the input criterions. More than one LookInFolders can
be specified. In that case, Search will be made in all the specified folders.
|
Integer > = 0 |
Search will be made on the entire
Cabinet. |
IncludeSubFolder |
Root |
Indicates if search is to be made on
the subfolders of the specified LookInFolder. This tag is of significance
only when LookInFolder is specified. |
Y Yes N No |
N |
Name |
Root |
Name of the folder to be searched.
Supports Wild Card Search. |
|
Search criteria will not include
this criterion. |
Owner |
Root |
Owner of the folder. |
|
Search criteria will not include
this criterion. |
CreationDate Range |
Root |
This call will search for the
folders that have the Creation Date in the range specified in this tag.
Condition and the Date, separated by a comma, are specified in this tag. 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 For example, If the information
provided in this tag is BETWEEN,
12/12/1998, 12/12/1999 then all those folders which meet
the other criteria and whose Creation
Date lies between the two specified Dates will be returned in this
call. |
Condition, Date |
Search criteria will not include
this criterion |
ExpiryDateRange |
Root |
Specifies the Expiry Date Range in
the same way as CreationDate Range. |
Condition, Date |
Search criteria will not include
this criterion |
AccessDateRange |
Root |
Specifies the AccessDateRange in the
same way as CreationDate Range. |
Condition, Date |
Search criteria will not include
this criterion |
RevisedDate Range |
Root |
Specifies the Revised Date Range in
the same way as CreationDate Range. |
Condition, Date |
Search criteria will not include this
criterion |
DataDefinitions |
Root |
Specifies information about the Data
Classes on which search is to be made. |
|
Search criteria will not include
this criterion |
DataDefIndex |
Data Definitions |
Index of the Data Class associated
with folder, which are to be considered for search. Those folders will be
searched, for which the given Data Class is associated. |
|
|
DataDefCriterion |
Root |
Specifies the search criteria
regarding Data Classes. |
|
|
DataDefCriteria |
DataDef Criterion |
This tag encloses the actual Data
Class criteria for search. |
|
|
DataDefIndex |
DataDef Criteria |
Index of the Data Class associated
with folder, which are to be considered for search. Search will be made on
the fields of the give Data Definition Index. |
|
|
IndexId |
DataDef Criteria |
Index of Data Class Field on which,
this 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
this tag should be empty, else it should have a value AND. |
|
|
OrderBy |
Root |
Indicates the field on which, the search results
will be sorted. For example, Name of folder, Owner, CreatedDate Time etc. |
1-FolderIndex 2-Name 3-Owner 4-Created Datetime 5-Revised DateTime 6-Accessed DateTime 7-Data Definition Index 8-FolderType 9- FolderLock 10-ExpiryDate Time 11-Finalised Flag |
1 |
SortOrder |
Root |
Indicates whether the search results
are to be sorted in ascending order or descending order. |
A- Ascending D- Descending |
A |
SearchScope |
Root |
Indicates whether a new search /
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 |
PrevFolderList |
Root |
If more refined search is to be
performed, then the results of the previous search are sent in this tag. |
List of folder Indexes separated by
# |
|
ReferenceFlag |
Root |
Indicates whether Only Original
folders / References of folders / Both are to be fetched in this call. |
O Original R Reference B- Both |
O |
StartFrom |
Root |
Used for fetching search results in
batches. Value of this tag will be (Batch Size * (Current Batch- 1)) +
1 |
|
N/A |
NoOfRecords ToFetch |
Root |
Specifies the Number of records to
be fetched in the current batch. |
|
N/A |
MaximumHitCount Flag |
Root |
Specifies whether in the search
results, MaximumHit Count tag is required or not.
MaximumHit Count tag indicates the number of
records that fulfill the search criteria irrespective of Rights on individual
folders. |
Y Yes N No |
N |
FolderType |
Root |
Indicates
type of folders to be searched. |
S
System G
General A
Reserved |
G |
GlobalIndex Criterion |
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 |
GlobalIndexCriteria |
Type
of the Global Index |
I Integer B- Boolean D- Date F-Float L- Long S-String T- Text X-
LinkedDoc |
|
IndexId |
GlobalIndexCriteria |
Index
of the Global Index |
Integer
> 0 |
|
Operator |
GlobalIndexCriteria |
Comparison
operator for the criteria |
>,
<, =, Like, >=, <= |
|
IndexValue |
GlobalIndexCriteria |
Value
for comparison |
|
|
JoinCondition |
GlobalIndexCriteria |
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. |
|
|
DataAlsoFlag |
Root |
This
tag specifies whether the associated data class with the folder should be
returned or not. |
Y
Yes N
- No |
|
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. |
Folders |
Root |
Encloses information about the
folders fetched in the current batch. |
NoOfRecordsFetched |
Folders |
Number of records fetched in the
current batch. |
TotalNoOfRecords |
Folders |
Used for
getting search results in batches. If more records exist in the database, the
value for the TotalNoOfRecords fetched in output will be one greater than the
NoOfRecordsFetched otherwise both the values will be same. |
MaximumHitCount |
Folders |
Indicates the number of records that
fulfill the search criteria irrespective of Rights on individual folders. |
Folder |
Folders |
Outer tag that contains information
about a single folder of the current batch. |
FolderIndex |
Folder |
Index of the folder. |
ParentFolderIndex |
Folder |
Index of parent of the folder. |
NoOfSubFolders |
Folder |
No of subfolders present in the
folder. |
NoOfDocuments |
Folder |
No of documents present in the
folder. |
FolderName |
Folder |
Name of the folder. |
Owner |
Folder |
Owner of the folder. |
OwnerIndex |
Folder |
Index of the Owner of the folder. |
CreationDateTime |
Folder |
Date and Time at which the folder
was created |
RevisedDateTime |
Folder |
Date and Time at which the folder
was last modified. |
AccessDateTime |
Folder |
Date and Time at which the folder
was last accessed. |
DeletedDateTime |
Folder |
Date and Time when the folder was
deleted. |
ReferenceFlag |
Folder |
Indicates whether the folder is
Original or Referenced. |
AccessType |
Folder |
Indicates whether the folder is a
Shared folder / Private folder / Inherits its Access Type from its Parent
Folder. |
ImageVolumeIndex |
Folder |
Volume Index of the Image Server
where the documents of this folder will be added. |
FolderType |
Folder |
Indicates the Type of the folder. |
FolderLock |
Folder |
Indicates if any User has locked the
folder. |
Location |
Folder |
It specifies the location where the folder is
present. |
ExpiryDateTime |
Folder |
Date and Time after which the folder
will expire. |
VersionFlag |
Folder |
Indicates whether Versioning will be
allowed for the documents added in this folder or not. |
ACL |
Folder |
String comprising the Rights of
Users / Groups on the current document. |
LockByUser |
Folder |
Name of the user
who has locked the folder. |
Comment |
Folder |
Comments associated with the folder. |
FinalizedFlag |
Folder |
Indicates whether the Folder is
finalized or not. |
FinalizedBy |
Folder |
Index of the User who has finalized
the folder. |
FinalizedDateTime |
Folder |
Date and Time when the folder was
finalized. |
LoginUserRights |
Folder |
Rights of the login User on the
folder. |
ACLMoreFlag |
Folder |
Not Used. |
DataDefinition |
Root |
Information of the Data Class
associated with the folder. |
DataDefIndex |
Data Definition |
Index of the Data Class associated
with the folder. |
DataDefName |
Folder |
Name of the data class associated
with this folder. |
Fields |
Folder |
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. |
IndexFlag |
Field |
Specifies whether
the given field is global or specific
to the Data Class. |
UsefulInfoFlag |
Field |
This indicates
whether Usefulinfo is present or not. Y Yes N No |
UsefulInfoSize |
Field |
Contains the size
of the usefulinfo. |
IndexAttribute |
Field |
Attribute of the
Data Class Field. |
IndexValue |
Field |
Value of the Data
Class field associated with the document. |
Code |
Message |
Comments |
-50074 |
Invalid Parameter |
Some of the Input parameters supplied, are invalid.
For example, searchscope supplied is other than the valid values 0,1,2 or
IncludeSubFolder is other than Y or N. 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. |
-50053 |
Check Rights failed. |
The process of finding Rights on the folder obtained
in search result failed. |
-50076 |
Invalid object access type. |
Access type of folder obtained in search result is
improper. This error arises in the process of rights checking on the folders. |