In this blog post I want to sharing some useful DQL and IAPI queries that I am using all the time. They are more dedicated to Documentum support/debug and grouped by components. In order to use them, I recommend Qdman: it is the best tool I know to use DQL and IAPI scripts.
It regroups both the search engine and the index management.
This query will perform a search just as if you put the ‘manual.doc’ in the search field of DA. It can be used to check if the dsearch is working fine and if the indexing has been performed correctly. If not, it will return 0 results for a document that you know does exist in the docbase.
This query will return the number of items waiting to be indexed since 15 minutes. The parameter can be changed to 60 minutes or whatever, you just have to change the ’15’ in bold in the previous query.
This one is similar to the previous, but it returns the number of ‘in progress’ indexing requests. Note that the parameter can still ne changed.
This query lists the number of indexes by state:
- blank -> awaiting indexing
- aquired -> in progress
Sometimes I noticed there are indexing requests on deleted documents. In fact, it can happen if someone saved a document, then deleted it right after. The indexing request remains in the queue for life. Thus, you may want to delete it. First, check if the file is deleted by running the IPAI: dump,c,09xxxxxxxxxxxxxx. If an error occurs telling the document doesn’t exist anymore, you can delete it.
This query returns your configured index agent information. It is useful for the IAPI command returning the index agent status (see below).
This script returns the Index Agent Status (Running, Stopped, and so on). Note that you have to replace the Indey Agent information in the first line by your Index Agent. You can get these information thanks to the DQL query above.
This one simply puts an indexing request in the queue. You have to replace 09xxxxxxxxxxxxxxx by the r_object_id of the document you want to queue.
For this one you have to go to the xPlore server, it shows the configured dsearch port.
2. Rendering (ADTS)
The following queries concern the rendition component. It regroups the rendition queue check and the way to manually ask a rendition through IAPI.
As the indexing request, this one puts a PDF rendition request in the queue. It can be useful when scripting or in DFC programs.
This returns the rendition requests by state.
This query returns all documents present in the rendering queue. That means all document waiting for rendition.
This Query returns the failed renditions. Be aware of the date_sent field, because this queue is not cleared. This means that if a rendition request failed 3 times in a row and succeed the last time, there will be 3 rows in the failed queue, but the rendition did succeed. So you should verify that the rendition did succeed and if so, you can delete the row form of the failed queue.
This query checks if a rendition is present for the given DOCUMENT name. If the pdf rendition exists, it returns its r_object_id. If no rendition is present for the given document, it returns nothing.
3. Audit Trail
This query displays the number of failed logons in the docbase per user since 60 minutes. The parameter 60 can be changed.
This statement purges the audit trail queue by deleting all logon failure entries. Be aware that it can take a while depending on the number of entries you have.
This query simply shows the number of logon failures in the queue.
This query flushes caches, it can be used when trying to install ADTS dars and fails due to version mismatch.
Go to the ADTS installer directory and issue this query. It shows the version of the installer.
This one encrypts the dm_bof_registry password in order to use it in dfc.properties. Not that the encryption process is different on xPlore and ADTS but you can use it on the content server and all DFC related programs. Replace the PASSWORD in the query by your clear password.