Overview
IDOL index info gives data about the status of indexing. It can be used for example for determining whether the initial indexing round has been finished or how long is the M-Files side indexing queue. Before May'20 release (20.5.x), the index info was on M-Files server hard disk e.g. C:\Program Files\M-Files\Server Vaults\[vault name]\Indexes\Combined\M-Files. After the release the index info has moved into its own index in IDOL.
This document describes how to retrieve index info from IDOL.
NOTE 1! This document is valid for IDOL version 10.9 and beyond.
NOTE 2! Using this document requires basic understanding of IDOL components and terminology.
Keywords: IDOL, index info
1. Process
1. Get the database GUID from admin tool. Configurations > Advanced Vault Settings > Configuration > Search > Indexes > Index GUID e.g. C_... Select Advanced tab and from JSON copy the value of generatedIndexName or PredefinedIndexName.
2. We are using IndexInfo.ps1 Power Shell script that is located in IDOL installation package (\IDOL12_SetupTools_20200402_full_with_pwd\Installer\Shared\Scripts). Make sure that IndexInfo.ps1 ja CommonMethods.ps1 are at least version 12.4. The whole Shared folder with the right file versions is linked to the end of this article. That can be used as a stand alone component.
3. Open Power Shell command prompt and go into Scripts folder.
4. Run following command. It lists full index objects by partition:
powershell -nologo -noprofile -executionpolicy bypass -file .\IndexInfo.ps1 `
-dailyHost [IDOL hostname, IP address or just localhost if the script runs in IDOL server] `
-dailyACIPort [Daily ACI port] `
-listByPartition `
-indexdb "[database GUID]"
Example:
powershell -nologo -noprofile -executionpolicy bypass -file .\IndexInfo.ps1 `
-dailyHost localhost `
-dailyACIPort 9000 `
-listByPartition `
-indexdb "MF-{17E2AF7E-D782-4573-84EF-94CAE7CD30A0}"
The result will include three sections, IndexID, RebuildInfo and TimestampCmbinedV6. In RebuildInfo you can see when the initial indexing was started and ended. TimestampCmbinedV6's first integer value is the timestamp we need for backups and getting the M-Files side indexing queue length.
Example of the output of running IndexInfo.ps1 (sections on bold black and meaningful info on bold red):
Partition 0:
MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}_INTERNAL-InternalData-IndexInfo-IndexID-0
DREDBNAME: MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}_INTERNAL
DREREFERENCE: MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}_INTERNAL-InternalData-IndexInfo-IndexID-0
IDOLSECURITY: MF_V4
MFACL: GX:M:UG0::UG1::UG2::
MFINTERNALDATA_AT: 2020-07-02 08:34:23
MFINTERNALDATA_TAG: IndexID
MFINTERNALDATA_VALUE:
0MFVERSION_20_8_9231_0
{
"indexVersion": "6",
"mfVersion": "20.8.9231.0",
"indexedData": "3",
"capabilities": [
"HasCheckedOutRecords",
"HasIndexObjectData",
"HasACLWithDeny"
]
}
MFMETA_INTERNALDATA_INTERNAL: 0MFYES
MFMETA_INTERNALDATA_REPOSITORY: -1
MFMETA_INTERNALDATA_TYPE: 0MFINTERNALDATA
MFMETA_INTERNALDATA_TYPE: 0MFIndexInfo
MFMETA_INTERNALDATA_TYPE: 0MFIndexID
MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}_INTERNAL-InternalData-IndexInfo-RebuildInfo-0
DREDBNAME: MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}_INTERNAL
DREREFERENCE: MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}_INTERNAL-InternalData-IndexInfo-RebuildInfo-0
IDOLSECURITY: MF_V4
MFACL: GX:M:UG0::UG1::UG2::
MFINTERNALDATA_AT: 2020-07-02 08:36:21
MFINTERNALDATA_TAG: RebuildInfo
MFINTERNALDATA_VALUE:
0MFVERSION_20_8_9231_0
{
"startedAt": "2020-07-02T08:34:26.364Z",
"completedAt": "2020-07-02T08:36:21.375Z",
"metadataOnly": false
}
MFMETA_INTERNALDATA_INTERNAL: 0MFYES
MFMETA_INTERNALDATA_REPOSITORY: -1
MFMETA_INTERNALDATA_TYPE: 0MFINTERNALDATA
MFMETA_INTERNALDATA_TYPE: 0MFIndexInfo
MFMETA_INTERNALDATA_TYPE: 0MFRebuildInfo
MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}_INTERNAL-InternalData-IndexInfo-TimestampCombinedV6-0
DREDBNAME: MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}_INTERNAL
DREREFERENCE: MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}_INTERNAL-InternalData-IndexInfo-TimestampCombinedV6-0
IDOLSECURITY: MF_V4
MFACL: GX:M:UG0::UG1::UG2::
MFINTERNALDATA_AT: 2020-07-02 11:08:23
MFINTERNALDATA_TAG: TimestampCombinedV6
MFINTERNALDATA_VALUE:
0MFVERSION_20_8_9231_0
{
"timestamp": {
"timestampType": "integer",
"timestamp": {
"integer": {
"values": [
"1071",
"132381489137300000",
"0",
"0"
]
}
}
},
"changeTracking": [
"220",
"219"
],
"remoteIndexName": "MF-{F517D000-DAF7-40D7-B4CD-F7D8A27B06A3}"
}
MFMETA_INTERNALDATA_INTERNAL: 0MFYES
MFMETA_INTERNALDATA_REPOSITORY: -1
MFMETA_INTERNALDATA_TYPE: 0MFINTERNALDATA
MFMETA_INTERNALDATA_TYPE: 0MFIndexInfo
MFMETA_INTERNALDATA_TYPE: 0MFTimestampCombinedV6
ATTACHMENT: Shared-folder (Shared.zip)
