Skip to content

Commit

Permalink
qa 'share your Findings'
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Osinski authored and paulOsinski committed Jan 7, 2025
1 parent 000728a commit 781dc0c
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 183 deletions.
129 changes: 0 additions & 129 deletions docs/content/en/open_source/integrations

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Connect To Jira"
title: "Send Findings To Jira"
description: "Send DefectDojo Findings to one or more Jira Projects"
summary: ""
date: 2023-09-07T16:06:50+02:00
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Using the Report Builder"
description: "Build and publish custom reports for external audiences, or your own records"
weight: 1
---

DefectDojo allows you to create Custom Reports for external audiences, which summarize the Findings or Endpoints that you wish to report on. Custom Reports can include branding and boilerplate text, and can also be used as **[Templates](https://docs.defectdojo.com/en/pro_reports/working-with-generated-reports/)** for future reports.
Expand Down Expand Up @@ -45,6 +46,32 @@ Widgets are content elements of a report which can be added by dragging and drop
* Widgets can also be collapsed by clicking on the grey header, for ease in navigation through a report builder.
* The Findings Widget, WYSIWYG Widget and the Endpoints widget can be used more than once.

For more information about Report Widgets, see our [Report Widget index](./#report-widget-index).

## Step 3: Publish and view your Report

Once you have finished building your report, you can generate it by clicking the green ‘**Run’** button at the bottom of the **Report Format** section.

This will automatically take you to the Generated Reports page, and your report will begin to generate in the background. You can check on the Status of your report by reading the Status column next to it, and refreshing the page periodically.

Once your report has generated, you can view it by either clicking on the **Status** (which will be set to ‘Complete: View Report’), or by opening the **** menu next to your report and selecting **View Report**.

![image](images/Using_the_Report_Builder_14.png)

## Step 4: Exporting a Report

Only DefectDojo users will have access to Reports stored in the software, but Reports are set up in a way where they can be exported or printed easily.

The easiest method to use is to Print To PDF \- with an HTML Report open, open a **Print** dialog in your browser and set **Save To PDF** as the **Print Destination**.

![image](images/Using_the_Report_Builder_15.png)

## Report formatting suggestions

* WYSIWYG sections can be used to contextualize or summarize Finding lists. We recommend using this widget throughout your report in between Findings or Vulnerable Endpoints widgets.

## Report Widget Index

### Cover Page Widget

The Cover Page Widget allows you to set a Heading, Sub heading and additional metadata for your report. You can only have a single Cover Page for a given Report.
Expand Down Expand Up @@ -124,26 +151,4 @@ Select the parameters for the Endpoints you wish to include here and click the *

This Widget will render a light grey horizontal line to divide between sections.

![image](images/Using_the_Report_Builder_13.png)

## Step 3: Publishing and viewing your Report

Once you have finished building your report, you can generate it by clicking the green ‘**Run’** button at the bottom of the **Report Format** section.

This will automatically take you to the Generated Reports page, and your report will begin to generate in the background. You can check on the Status of your report by reading the Status column next to it, and refreshing the page periodically.

Once your report has generated, you can view it by either clicking on the **Status** (which will be set to ‘Complete: View Report’), or by opening the **** menu next to your report and selecting **View Report**.

![image](images/Using_the_Report_Builder_14.png)

## Step 4: Exporting a Report

Only DefectDojo users will have access to Reports stored in the software, but Reports are set up in a way where they can be exported or printed easily.

The easiest method to use is to Print To PDF \- with an HTML Report open, open a **Print** dialog in your browser and set **Save To PDF** as the **Print Destination**.

![image](images/Using_the_Report_Builder_15.png)

## Report formatting suggestions

* WYSIWYG sections can be used to contextualize or summarize Finding lists. We recommend using this widget throughout your report in between Findings or Vulnerable Endpoints widgets.
![image](images/Using_the_Report_Builder_13.png)
Original file line number Diff line number Diff line change
@@ -1,68 +1,46 @@
---
title: "Working with Generated Reports"
title: "Templates and Historical Reports"
description: "Use a report as a template, or re-run an existing report with updated data"
weight: 2
---

Once you have created one or more **Reports** in DefectDojo you can take further actions, including:


* Using a report as a template for subsequent reports
* Re\-running a report with updated data
* Deleting an old or unused reportsa
* Re-running a report with updated data
* Deleting an old or unused reports

![image](images/Working_with_Generated_Reports.png)

# Use a report as a Template

## Use a report as a Template

DefectDojo allows you to easily create Report templates with your team logo, boilerplate text and a standardized content order.



If you want to change the way a report is set up, or create a new one with a similar layout, you can re\-open the Report Builder by selecting **View Template** from the **** menu next to the report you wish to use as a template.



There are two places where you can find a Report Template to use:


1. From the **Generated Reports** page, where you can see a list of completed reports
2. From the **Report Templates** page, where you can see a list of previously run reports, including reports which were deleted from the **Generated Reports** page.

Both of these pages can be found in the 📄 **Reports** tab on the sidebar.



![image](images/Working_with_Generated_Reports_2.png)
To access the **Report Templates** page, open 📄**Reports \> Report Templates** from the sidebar. From that table, you can open the report builder by clicking the **** menu next to the report you wish to use as a template.


To access the **Report Templates** page, open 📄**Reports \> Report Templates** from the sidebar. From that table, you can open the report builder by clicking the **** menu next to the report you wish to use as a template.

Every time you make changes to a template or previous report, the result will be saved as a **new** report under Generated Reports so that you don't lose the older version. If you like, the older version can be deleted.




# Re\-Running a Report

## Re\-Running a Report

DefectDojo Reports are ‘frozen in time’ \- to keep your records consistent, they do not update automatically when DefectDojo experiences data changes.



However, if you want to create an updated version of a previously created report, you can do so by selecting **Re\-run Report** from the **** menu next to the report you wish to generate.



Selecting this option will create a new report in the **Generated Reports** list, with a different **Created** timestamp to indicate that the report was run at a separate time.



![image](images/Working_with_Generated_Reports_3.png)

# Deleting a Report

## Deleting a Report

If you no longer need a report, you can delete it by selecting **Delete Report** from the **** menu next to the report you wish to delete. Note that this will only remove the report from the **Generated Reports** list \- a record of the report will still exist under **Report Templates** if you want to re\-run it.


0 comments on commit 781dc0c

Please sign in to comment.