Document reports
You can generate document reports for multiple entities. You can customize the details shown in the reports and save them in Word and PDF formats.
New document reports
This section describes how to create a report.
To create a report:
- Open the Settings menu and select Reports > Document report. The Generate document report window opens.
- If you have a saved template, select it from the Autofill dropdown.
-
Click the Settings tab. Provide general information for the report:
- Add a title and description.
- Choose whether to show the author and date. By default, this is enabled.
- Provide a file name and format (Word or PDF).
- Set the orientation to portrait (default) or landscape.
-
Upload a logo. Click the Logo Image placeholder to upload a logo for your report. To edit, remove, or restore the default logo, hover over the logo and expand the More information menu . Choose an option: Update, Reset to default, or Remove.
Tip: When you create a new workspace, you are prompted to choose a logo and header for your reports.
- Add header and footer text.
-
In the Content tab, click the Add Section button .
- Choose an entity type, such as Defects, Epics, Features, or a Custom section. Each time you make a selection, a new section is added to the report.
-
Add one of the following special sections:
- Custom section. Use this to add sections with rich text capabilities, such as diagrams, tables, images, and links. It can function as a placeholder for specific report sections to be filled in at a later time. Custom sections can be independent or linked sub-sections, and can be duplicated.
- Widget. Adds one of the built-in or customized widgets. First specify a section header. Then expand the drop downs to select a dashboard favorite and dashboard widget.
-
In the main pane, for each section, define the following configurations:
-
Repeat the above step to add additional sections to the report.
Note: The order of the sections in the generated report corresponds to their order in the Generate Document Report window.
-
To add a related item as a sub item to a first level entity, hover over the parent entity and click the Add button . The dropdown contents differ, based on the selected entity.
For the Last Test Runs sub item, you can indicate whether to include descendants. Select the Include test runs of each <entity type>'s descendants option to include all last runs related to the entity or one of its children. Clear the option to show only those last runs directly related to the entity.
- (Optional) Click the Save as template button to save the current configuration as a template.
- Click Generate. A message in the banner indicates that your report is being processed.
The generated report is downloaded to your default Downloads folder with the file name you specified in the Settings tab. When the report is ready, the My Work module displays a direct link to the report under the Notifications tab.
Document report headers and footers
The administrator can create a document report default for each space that includes a custom header, footer, and logo.
To create a report template:
- Open the Settings menu , click Spaces, and select a space.
- Open More Settings > Document report.
-
Upload a logo and add header and footer text.
This header, footer, and logo is used by default when creating a report in the selected space.
Customizations and permissions
Admins can configure document report setting and their permissions in the Settings area or through parameters.
Admin permissions for document report creation
Admins can control the creation of document reports by setting the following permissions in the Permissions tab > General System Actions:
-
Generate a document report
-
Manage Document Report Configuration
-
Manage Document Report Contents
-
Override Default Document Report Format
For details, see Roles and permissions.
Configuration parameters
The following table lists parameters that admins can use to configure document report settings.
Parameter name | Description |
---|---|
DOCUMENT_REPORT_AMOUNT_OF_ALLOWED_WIDGETS |
This parameter lets you control the number of widgets in a report. By default, users can include up to 20 widgets. |
DOCUMENT_REPORT_LINK_IMG_DOMAINS_ALLOWED_LIST |
By default, images added to the Custom section as URLs are not embedded in the report. Your admin can enable embedding images, added as URLs, by listing the URL domains in this parameter separated by semicolons. |
DOCUMENT_REPORT_LOGO_FILE_EXTENSIONS | The default extensions for logo images are JPG, JPEG, PNG, and BMP. |
DOCUMENT_REPORT_LOGO_MAX_SIZE | By default, logo image sizes are limited to 5 MB. |
DOCUMENT_REPORT_MAX_ATTACHMENTS_NUMBER |
This parameter lets you limit the number of embedded image attachments in a document report. The default is 100 embedded attachments and the maximum 400. Caution: If you exceed 100 embedded attachments, CPU usage may increase substantially and performance will be affected. |
DOC_REPORT_COLORED_TEST_SCRIPT |
By default, users can generate reports with color for scripts or steps in Gherkin and manual tests. To block this capability, set the parameter to false. |
MAX_CONCURRENT_REPORTS_PER_USER | By default, each user can send a maximum of 5 report requests at a time. Requests for more reports can only be processed after the previously requested reports are generated. |
MAXIMUM_DOCUMENT_REPORT_PAGES | The maximum number of allowed pages in a document report. The default is 1000 pages. |
For details, see Configuration parameters.
Troubleshooting
The following table addresses possible issues with document reports.
Issue | Solution |
---|---|
Embedding widgets |
If you encounter problems embedding widgets in a document report, refer to the troubleshooting methods described in KM000001556. This KB refers to the Share Public Link feature, which uses similar mechanisms as document reports. Rather than the parameters mentioned in the KB, use the following:
If this does not help, contact Support for further instructions. |
See also: