Doc Assistant Environment Variables

To make Doc Assistant the default documentation tool for all help calls, set the value of the CDA_ENABLE environment variable to true. This is useful when both Cadence Help and Doc Assistant are installed and Cadence Help is the default help viewer.

In case your tool's installation and Doc Assistant installation are in different directories, set the CDA_EXE_CUSTOM_PATH environment variable to point to the directory where Doc Assistant is installed.

To make Offline Documentation the default mode when Doc Assistant is launched:

• Set the CDA_OFFLINE environment variable to true.
• Specify the CDA_OFFLINE variable in the help.ini file in a new line.

On a Linux machine, if you don't have write permissions to the Doc Assistant install directory, set the CDA_HOME_AUTOINDEX environment variable to true to create the search index in the user home directory.

On a Windows machine, Doc Assistant creates a search index in the user home directory by default. To disable this behavior, set the CDA_DISABLE_HOME_AUTOINDEX environment variable to true.

Set the value of the CDA_API_DEBUG environment variable to debug to log Doc Assistant API debug information to the CDA_API_log.txt file in the $HOME/.config/cadence directory.

Set the value of the CDA_DEBUG environment variable to debug to log the Doc Assistant debug information to the cdaLogger.txt file in the $HOME/.config/cadence directory.

When you use a 4K or higher resolution monitor, to avoid any issues with the text and images displayed in Doc Assistant, set the CDA_NOHIGHDPI environment variable to true.

If Doc Assistant is installed on a network location, you might have more than one user accessing Doc Assistant. If multiple users need to access different document libraries, you can set a CDS_SITE environment variable that points to a common help.ini file and specify multiple libraries in this file. The CDS_SITE environment variable ensures that all the libraries in the help.ini file can be accessed by more than one user accessing Doc Assistant installed on a network location.

If your Doc Assistant installation location is mentioned in the PATH environment variable, you can specify the USE_PATH entry in the  help.ini  file in a new line. This enables Doc Assistant to load all the document libraries from the hierarchies in the PATH environment.

To load multiple document hierarchies, set the CDA_DOC environment variable as follows:

• On a Windows machine, set the value of the variable as:
  "<install_dir1>\doc;<install_dir2>\doc"
• On a Linux machine, set the value of the variable as:
  "<install_dir1>/doc:<install_dir2>/doc"