Troubleshooting

The following sections provide further guidance on how to use QUBEdocs effectively.

QUBEdocs Log files

During the process of generating the QUBEdocs documentation, issues with QUBEdocs or useful information about the state of the model will be logged in the QUBEdocsServer.log file. 

QUBEdocs logs are stored in the “%ProgramData%\QUBEdocs\Logs” directory.

The different error statuses are given below:

• Info – processing information predominately related to the generation of the documentation.
• Warn – Issues or exceptions with QUBEdocs which may result in incorrect documentation being generated or may affect the usability of the QUBEdocs interfaces.
• Fatal – anything that stops the generation of a QUBEdocs version.

Frequently Asked Questions

Some frequently asked questions are given below, along with their answers.

Why isn’t the documentation complete after installing QUBEdocs?

The “QUBEdocs Update” process needs to run before the documentation is complete as this outputs a couple of key files that QUBEdocs picks up. This will populate relationships between cubes and dimensions, bring through any user-defined information, such as object definitions and application details, and will bring through documentation for elements and attributes.

Why are my QUBEdocs webpages not refreshing correctly?

QUBEdocs uses caching at various levels to improve performance.  In some cases, the cache may need to be cleared if the documentation does not appear to be refreshed in its entirety.  To do this, navigate to the “About QUBEdocs” link in the left hand pane and select the “Clear Cache” button.

Why am I experiencing slow performance times or unexpected results?

QUBEdocs typically performs very well, however, if there is no RAM available on the server the pages cannot be rendered correctly and slow performance times may result. To resolve this, ensure that the solution is running in line with the requirements set in the prerequisites section.

Why doesn’t my documentation generate silently through the TM1 / PA Interface?

Why doesn’t my documentation generate silently through the TM1 / PA Interface?

There needs to be an account associated with TM1 / PA service in order for the documentation to be generated silently. The account should have local admin permissions to the server and output directory.  In addition, the account running the application pool associated with the QUBEdocs website (NETWORK SERVICE by default) needs access the server being documented.

Where is the QUBEdocs log file?

QUBEdocs logs are stored in the “%ProgramData%\QUBEdocs\Logs” directory. W

Why were there errors when I ran the QUBEdocs Update process for the first time?

In some cases there may be errors when the “QUBEdocs Update” process is run for the first time. This will not cause any subsequent issues or cause the documentation to fail. If it runs without an error the second time everything should be working as expected.

How do I log a product defect, ask a question or submit a feature request?

You can contact support@QUBEdocs.com if you have any product related queries.