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:

  1. Click Settings on the main banner, and select Reports > Document report. The Generate document report window opens.
  2. If you have a saved template, select it from the Autofill dropdown.

  3. Click the Settings tab. Provide general information for the report:

    1. Add a title and description.
    2. Choose whether to show the author and date. By default, this is enabled.
    3. Provide a file name and format (Word or PDF).
    4. Set the orientation to portrait (default) or landscape.

    5. 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.

    6. Add header and footer text.

  4. In the Content tab, click + Add in the left pane.

    1. 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.

    2. 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.

    3. In the right pane, for each section, define the following configurations:

      Configuration Description
      Section Header Specify a name, or accept the default, the entity name.
      Format Select Table or Details.
      Filters Click + Add Filter to add field values by which the report generation is guided. Some fields allow you to define cross-filters. Fields that support cross-filtering are marked with the cross-filter arrow button .
      Order by Select a sorting method and indicate ascending or descending.
      Fields

      Some fields are predefined.

      To add additional fields:

      • Click + Add Fields and select fields whose values you want to include in the report.
      • For cross fields, you can also choose the related fields. Click the cross fields arrow button  next to the field, and select the related fields that you want to include in the report.

      Reorder the fields by dragging them to the desired location. In the generated report, the order of the fields corresponds to their order in the Content tab.
      Clear all fields except for ID Click the X next to the Add Fields button. To remove a specific field, hover over it and click the x symbol.
      Include

      Indicate whether to include additional item components, such as attachments and scripts, in the content of the report.

      The Include section only shows components that are applicable to the item. For example, for manual tests, you can include run steps. Script inclusion is only available for nodes that include scripts. It uses the latest version of the script.

      Version 24.3 and later: When including image attachments, by default they are represented by a link in the attachments section. To embed the actual image in the report, select the Display the images inline in the attachments section option.

      Note: Including items is only available when using the Details report format. Including items in the report increases its size and generation time.

  5. 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.

  6. To add a related item as a sub item to a first level entity, hover over the parent entity and click Add . 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.

  7. (Optional) Click in the top banner to save the current configuration as a template.
  8. Click Generate in the bottom right corner of the dialog box. 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.

Back to top

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:

  1. Click Settings on the main banner, and select a space.
  2. Open Defaults > Document report.

  3. 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.

Back to top

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 General System Actions area of the Permissions tab:

  • 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 Type Description
DOCUMENT_REPORT_AMOUNT_OF_ALLOWED_WIDGETS Site/Space

This parameter lets you control the number of widgets in a report. By default, users can include up to 20 widgets.

Available in versions: 24.1 and later
DOCUMENT_REPORT_ATTACHMENTS_SIZE_LIMIT Site This parameter lets you control the size of all of the report's attachments in MB. The default is 16 MB for the entire report.
DOCUMENT_REPORT_LINK_IMG_DOMAINS_ALLOWED_LIST Site/Space

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 Site/Space The default extensions for logo images are jpg, jpeg, png, and bmp.
DOCUMENT_REPORT_LOGO_MAX_SIZE Site/Space By default, logo image sizes are limited to 5 MB.
DOCUMENT_REPORT_MAX_ATTACHMENTS_NUMBER Site/Space

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.
DOCUMENT_REPORT_READER_PAGE_SIZE Site By default, each document report is limited to 1,000 pages. If the document size exceeds 1,000 pages, you can apply a filter to remove some content.
DOC_REPORT_COLORED_TEST_SCRIPT Site/Space

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 Site/Space 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 Site/Space The maximum number of allowed pages in a document report. The default is 1000 pages.

For details, see Configuration parameters.

Back to top

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:

  • CHROME_DRIVER_SERVICE_CUSTOM_CHROME_OPTIONS

  • CHROME_DRIVER_SERVICE_SSL_CERTIFICATE_ENFORCEMENT

If this does not help, contact Support for further instructions.
Fonts on Linux

To generate PDF and Word files properly, make sure that the Arial Unicode MS font is installed on the server at the following location: site\storage\site\fonts or site\storage\sharedspaces\...\fonts.

If additional fonts are missing, the admin should add them at the same location.

Back to top

See also: