Accessing Doc Assistant

This topic lists certain corner cases where the required content might not be displayed in the Doc Assistant.

Doc Assistant Does Not Launch

If you are not able to open Doc Assistant from your tool, ensure that the installed doc folder has write permissions. Follow these instructions:
1. Delete the .config file.
2. Launch Doc Assistant from the tool.
3. If the problem persists, check if there is any help process running in the background. If yes, kill the process and launch Doc Assistant. Ensure to wait till indexing finishes.

Path to Doc Assistant Could Not be Found

You might not be able to access Doc Assistant if the tool path is not correctly provided to Doc Assistant API while launching it from the tool. Specify the correct path to your tool or to Doc Assistant in the CDA_EXE_CUSTOM_PATH environment variable.

Doc Assistant Opens Up in Standalone Mode

If Doc Assistant does not display help from the Cadence tools and opens up in standalone mode (where you see the default view of Doc Assistant), follow these troubleshooting methods:

Check your process table and kill any running Doc Assistant process, and re-launch Doc Assistant.
If the problem persists, contact your IT team to check if the communication ports are blocked on the machine from which you are accessing Doc Assistant. Try launching Doc Assistant after the ports are enabled.

Context-Specific Help Topic Is Not Loaded

If Doc Assistant does not display context-specific help topics, follow these troubleshooting methods:

Ensure you have read access to the documentation directory (INST_DIR/doc) and all the sub-directories. Once you enable it, try to launch help from the dialog box or tool interface where you got the error.
If the problem persists, create the debug files (see Debugging Doc Assistant) after running the steps where you faced the issue and send them to Cadence Customer support.

Doc Assistant License Check Fails

If the Doc Assistant licensing check fails, use the following environment variables to a specify a valid licensing server:

setenv CDS_LIC_FILE severName

setenv LM_LICENSE_FILE serverName