In some rare scenarios, the RapidDox Desktop Application gets stuck or breaks in the middle of generating documentation for a file. This could be due to various reasons. For e.g, from time to time, when Tableau or Microsoft changes the format of their metadata files, RapidDox application code will also need to change accordingly to generate the documentation correctly.  In these situations, it is possible that the application will break or get stuck.

The RapidDox application comes with a configuration on the Settings page to enable writing the errors to a log file, which can then be shared with our product team to help them identify and fix the problem.

Follow the steps below to enable error logging and to share the log file with the support team.

Enable Error Logging

  • Click on the Settings link on the Left Hand Side navigation menu.
  • Check the checkbox that says “Enable Error Logging” as shown below.

  • Click on Home and then process the file that results in the problem as usual.
  • Go to the below folder after replacing <<yourusername>> with your local machine’s user name,
    • On Windows, go to C:\Users\<<yourusername>>\AppData\Local\RapidDox
    • On macOS, go to /Users/<<yourusername>>/Library/Preferences/Rapiddox
  • In this folder, you will find the file rapiddox.log
  • Share that file with our support team through a ticket.
  • IMPORTANT: Please disable the error logging by unticking the box in the settings tab.  Leaving the error logging on will slow down the performance of the RapidDox app.