Overview
This article will describe how to retrieve IDOL cluster information via MFIDOLConsole (previously MFAutonomyConsole). The first example is about getting information of the whole cluster (DAH). The second example shows how to get information about individual engine, such as the amount of objects in its database so you can monitor that they do not exceed 1 million.Keywords: IDOL, MFIDOLConsole, getstatus
Notice: M-Files recommends using Smart Search as a search engine over IDOL. This is due to easier build and maintenance, which is basically none.
Impacted Products and Versions
IDOL 12.0. and later.Sample Case 1 - Get information of the whole cluster (DAH)
Prerequisites
- You are logged into IDOL frontend server
- You have IDOL installation package extracted in the server
Steps
- Open Windows Explorer and go to Console folder in IDOL installation package. The path might be like:
C:\Users\john\Downloads\IDOL12_SetupTools_20221010_full_with_pwd\Installer\Shared\Console
- Copy and paste config.example.txt and rename the copy to config.txt.
- Open config.txt in text editor.
- Change IDOLServerACIPort value to the ACI port of DAH and save the file.
You can get the port from dah.cfg (example path: C:\IDOL12\bin\PROD-dahdih-19000\dah):
- Go back to Windows Explorer and Console folder.
- Click the address bar once. The whole address is selected.
- Write cmd and hit Enter. The command prompt will open to that specific folder.
- Write the following command and hit Enter.
MFIDOLConsole cfg=config.txt a=getstatus > gs.xml
- Gs.xml file has been written to the folder.
- Open the file with Edge browser.
- Make sure that <product> value is DAH. If it is not, you have a wrong port, likely some other IDOL component.
- The number of all documents in the cluster is in property <documents>.
For the overall situation, you will see a structure similar to
<autnresponse ....>
...
<responsedata>
<documents>total count here</documents>
For induvial engines (because each should host up to about 1 million items), you can see that under their database and name further down:
<databases>
...
<database>
<name>the engine name</name>
<documents>count of items on this engine</documents>
Sample Case 2 - Get information of the single engine (Daily)
Prerequisites
- You are logged into IDOL frontend server
- You have IDOL installation package extracted in the server
Steps
- Open Windows Explorer and go to Console folder in IDOL installation package. The path might be like:
C:\Users\john\Downloads\IDOL12_SetupTools_20221010_full_with_pwd\Installer\Shared\Console
- Copy and paste config.example.txt and rename the copy to config.txt.
- Open config.txt in text editor.
- Change IDOLServerACIPort value to the ACI port of Daily and save the file. Usually Daily uses port 9000.
You can get the port from content.cfg (example path: C:\IDOL12\bin\PROD-Daily-9000).
- Go back to Windows Explorer and Console folder.
- Click the address bar once. The whole address is selected.
- Write cmd and hit Enter. The command prompt will open to that specific folder.
- Write the following command and hit Enter.
MFIDOLConsole cfg=config.txt a=getstatus > gs.xml
- Gs.xml file has been written to the folder.
- Open the file with Edge browser.
- Make sure that <product> value is CONTENT. If it is not, you have a wrong port, likely some other IDOL component.
Reference Documents
IDOL - MFAutonomyConsole
