This
call is used to get a report on the status of the Cabinet. It is also used to
get the FTS status of the Cabinet or the general status of the Cabinet
depending upon the flag, passed by User. By default, it retrieves the general
status of the Cabinet like Total Groups, Total Folder etc.
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for
the call. |
NGOGetCabinet Report |
N/A |
|
CabinetName |
Root |
Name of the Cabinet
to which the User wants to connect. |
|
N/A |
|
UserDBId |
Root |
UserDatabse ID,
which is returned in the NGOConnectCabinet call. |
|
N/A |
|
FTSInfoFlag |
Root |
It is a flag to
indicate whether it is required to get the Status of FTS documents of the
Cabinet or not. |
Y - Yes N – No |
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. |
|
NoOfFTSedDocuments |
Root |
It indicates
the number of documents for which FTS has been performed in the Cabinet. |
|
TotalNoOfDocuments |
Root |
It indicates
the total number of documents in the Cabinet. |
|
NoOfUnFTSedDocuments |
Root |
It indicates
the number of documents for which FTS operation has not yet been performed in
the Cabinet. |
|
FTSIndexingFlag |
Root |
This flag
indicates whether Full-text search is enabled on the specified Cabinet or
not. |
|
NoOfFolders |
Root |
It indicates
the number of folders in the Cabinet. This number also includes the Inbox,
SentItems and Trash folders. |
|
NoOfDocuments |
Root |
It indicates
the number of documents in the Cabinet. |
|
NoOfDataDefinitions |
Root |
It indicates
the number of Data Classes in the Cabinet. |
|
NoOfAuthorizedKeywords |
Root |
It specifies
the number of Authorized Keywords in the Cabinet. |
|
NoOfUnAuthorizedKeywords |
Root |
It specifies
the number of Unauthorized Keywords in the Cabinet. |
|
NoOfGlobalIndexes |
Root |
It indicates
the number of Global Indexes available in the Cabinet. |
|
NoOfDataTypeIndexes |
Root |
Number of data
fields in the system. |
|
NoOfUsers |
Root |
It specifies
the number of Users in the Cabinet. |
|
NoOfGroups |
Root |
It specifies
the number of Groups in the Cabinet. |
|
DataSize |
Root |
Total size of
documents in the Cabinet. |
|
NoOfFolderReferences |
Root |
Number of Folder
References present in the Cabinet. |
|
NoOfDocumentReferences |
Root |
Number of Document
References present in the Cabinet. |