This version of the SonarQube documentation is no longer maintained. It relates to a version of SonarQube that is not active.

PDF reports

Setting up PDF reports in SonarQube Server.

Project and application PDF reports

PDF reports are available as part of the Enterprise Edition and above.

As a system administrator, you can change the PDF report subscription frequency of all projects and applications or for each project or application individually:

  • Global-level:To change the frequency setting globally, navigate to Administration > General Settings > Governance. Under Project and Application PDF Reports, select an option from the PDF Reports Frequency drop-down menu.

  • Project-level: To change the frequency setting for a specific project, navigate to the project’s home page then Project Settings > General Settings > Governance. Under Project and Application PDF Reports, select an option from the PDF Reports Frequency drop-down menu.

  • Application-level: To change the frequency setting for a specific application, navigate to the application’s home page then Application Settings > Application Report Settings, and select an option from the Application Reports Frequency drop-down menu.

You have the following options for subscription frequency:

  • Daily

  • Weekly

  • Monthly (default)

Users can only download or subscribe to a PDF report for a permanent branch. To set a branch as permanent, go to Project Settings > Branches and Pull Requests and make sure that the Keep when inactive toggle is on for that branch.

Portfolio PDF reports

As a system administrator, you can configure the subscription frequency for all portfolios globally or for each portfolio individually.

  • Global-level: To change the frequency setting at a global level, navigate to Administration > General Settings > Governance, and in the Portfolio PDF reports section, select a frequency from the drop-down menu.

  • Portfolio-level: To change the frequency setting for a specific portfolio, navigate to the portfolio’s home page then Portfolio Settings > Executive Report and select an option under Frequency.

You have the following options for subscription frequency:

  • Daily: report is sent during the first portfolio calculation of the day (if any)

  • Weekly: report is sent during the first portfolio calculation of the week (if any) from Monday

  • Monthly (default): report is sent during the first portfolio calculation of the month (if any), starting from the first day of the current month

Sending portfolio PDF reports to non-SonarQube Server users

Users with administrative rights on a portfolio can send the portfolio PDF report to non-SonarQube Server users by adding their email in the Other Recipients field at Portfolio Settings > Executive Report.

Last updated

Was this helpful?