Skip to content

Commit e84e15d

Browse files
committed
add jira content
1 parent 0eafd38 commit e84e15d

2 files changed

Lines changed: 58 additions & 12 deletions

File tree

docs/content/asset_modelling/engagements_tests/OS__engagements.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,8 @@ Once closed, the Engagement’s status will be changed to “Completed.” Never
120120

121121
Closing an Engagement does not change the status of the Findings within any of the Engagement’s Tests. Findings remain open, mitigated, or risk accepted according to their own lifecycle, and remain accessible for viewing and reporting.
122122

123+
If the Engagement is linked to a Jira Epic (see **[Jira Integration: Enable Engagement Epic Mapping](issue_tracking/jira/jira_guide#enable-engagement-epic-mapping-for-products)**), closing the Engagement will trigger an asynchronous task that closes the associated Jira Epic in your connected Jira Space.
124+
123125
### Reopen Engagements
124126

125127
If an Engagement is closed, it can be reopened by clicking **Reopen** from within its ⋮ kebab menu in the Closed Engagements table. This will make the Engagement active again and return its status to “In Progress.”
@@ -145,7 +147,7 @@ Deleting an Engagement can be performed by selecting **Delete** from the Engagem
145147
Deleting an Engagement will also delete the following:
146148
- Any Tests associated with the Engagement
147149
- All Findings within those Tests
148-
- Any linked Jira Epics
150+
- Any linked Jira Epic mappings (the Epic itself will remain in Jira, but the link between DefectDojo and Jira will be removed)
149151
- All notes and file uploads associated with the Engagement
150152

151153
For auditing purposes, it is recommended to close any completed Engagements, rather than deleting them.
@@ -154,4 +156,26 @@ For auditing purposes, it is recommended to close any completed Engagements, rat
154156
|----------|---------|------------|
155157
| **Close** | Marks as inactive; data remains; can be reopened | Yes (reopen) |
156158
| **Expire** | Visual warning only; optional auto-close; notifications | N/A |
157-
| **Delete** | Permanently removes Engagement, Tests, Findings, notes, files, and any linked Epics in Jira | No |
159+
| **Delete** | Permanently removes Engagement, Tests, Findings, notes, files, and any Jira Epic mappings (Epics remain in Jira) | No |
160+
161+
## Jira Integration
162+
163+
Engagements can be linked to a connected Jira Space, allowing Findings within the Engagement to be pushed to Jira as Issues. For a complete guide to setting up Jira, see **[Connecting DefectDojo to Jira](issue_tracking/jira/jira_guide)**.
164+
165+
### Engagement Epic Mapping
166+
167+
When **Enable Engagement Epic Mapping** is checked in a Product's Jira settings, Engagements will be pushed to Jira as Epics. Findings within the Engagement are pushed as child Issues underneath the Epic, mirroring DefectDojo's Engagement → Findings hierarchy in Jira's Epic → Issue structure.
168+
169+
For more information on this setting, see **[Enable Engagement Epic Mapping](issue_tracking/jira/jira_guide#enable-engagement-epic-mapping-for-products)**.
170+
171+
### Engagement-Level Jira Settings
172+
173+
By default, Engagements inherit their Jira settings from their parent Product. However, individual Engagements can override these settings to use different Jira configurations. The following settings can be customized per-Engagement:
174+
175+
- **Project Key** — route Findings to a different Jira Space
176+
- **Issue Template** — use a different template for Issues created from this Engagement
177+
- **Custom Fields** — apply different custom field mappings
178+
- **Jira Labels** — tag Issues with Engagement-specific labels
179+
- **Default Assignee** — assign Issues to a different team member
180+
181+
These settings are accessible from the **Edit Engagement** page. For more details, see **[Engagement-Level Jira Settings](issue_tracking/jira/jira_guide#engagement-level-jira-settings)**.

docs/content/asset_modelling/engagements_tests/PRO__engagements.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Engagements are closed by selecting **Close Engagement** within the Engagement
129129

130130
Closing an Engagement does not change the status of the Findings within any of the Engagement’s Tests. Findings remain open, mitigated, or risk accepted according to their own lifecycle, and remain accessible for viewing and reporting.
131131

132-
@paulOsinski Add additional details about Jira here — If the Engagement is linked to a Jira Epic, closing the Engagement will trigger an asynchronous task that closes the associated Jira Epic.
132+
If the Engagement is linked to a Jira Epic (see **[Jira Integration: Enable Engagement Epic Mapping](issue_tracking/jira/jira_guide#enable-engagement-epic-mapping-for-products)**), closing the Engagement will trigger an asynchronous task that closes the associated Jira Epic in your connected Jira Space.
133133

134134
### Reopen Engagements
135135

@@ -147,20 +147,42 @@ While it is not enabled by default, there is an option within the system setting
147147

148148
![image](images/engagement_ss15.png)
149149

150-
### Delete Engagements
150+
### Delete Engagements
151151

152-
Deleting an Engagement can be performed by selecting **Delete Engagement** from the Engagement’s settings. This action can’t be undone.
152+
Deleting an Engagement can be performed by selecting **Delete Engagement** from the Engagement’s settings. This action can’t be undone.
153153

154-
Deleting an Engagement will also delete the following:
155-
Any Tests associated with the Engagement
156-
All Findings within those Tests
157-
Any linked Jira Epics
158-
All notes and file uploads associated with the Engagement
154+
Deleting an Engagement will also delete the following:
155+
Any Tests associated with the Engagement
156+
All Findings within those Tests
157+
Any linked Jira Epic mappings (the Epic itself will remain in Jira, but the link between DefectDojo and Jira will be removed)
158+
All notes and file uploads associated with the Engagement
159159

160-
For auditing purposes, it is recommended to close any completed Engagements, rather than deleting them.
160+
For auditing purposes, it is recommended to close any completed Engagements, rather than deleting them.
161161

162162
| **Operation** | **Results** | **Reversible** |
163163
|----------|---------|------------|
164164
| **Close** | Marks as inactive; data remains; can be reopened | Yes (reopen) |
165165
| **Expire** | Visual warning only; optional auto-close; notifications | N/A |
166-
| **Delete** | Permanently removes Engagement, Tests, Findings, notes, files, and any linked Epics in Jira | No |
166+
| **Delete** | Permanently removes Engagement, Tests, Findings, notes, files, and any Jira Epic mappings (Epics remain in Jira) | No |
167+
168+
## Jira Integration
169+
170+
Engagements can be linked to a connected Jira Space, allowing Findings within the Engagement to be pushed to Jira as Issues. For a complete guide to setting up Jira, see **[Connecting DefectDojo to Jira](issue_tracking/jira/jira_guide)**.
171+
172+
### Engagement Epic Mapping
173+
174+
When **Enable Engagement Epic Mapping** is checked in a Product’s Jira settings, Engagements will be pushed to Jira as Epics. Findings within the Engagement are pushed as child Issues underneath the Epic, mirroring DefectDojo’s Engagement → Findings hierarchy in Jira’s Epic → Issue structure.
175+
176+
For more information on this setting, see **[Enable Engagement Epic Mapping](issue_tracking/jira/jira_guide#enable-engagement-epic-mapping-for-products)**.
177+
178+
### Engagement-Level Jira Settings
179+
180+
By default, Engagements inherit their Jira settings from their parent Asset (Product). However, individual Engagements can override these settings to use different Jira configurations. The following settings can be customized per-Engagement:
181+
182+
- **Project Key** — route Findings to a different Jira Space
183+
- **Issue Template** — use a different template for Issues created from this Engagement
184+
- **Custom Fields** — apply different custom field mappings
185+
- **Jira Labels** — tag Issues with Engagement-specific labels
186+
- **Default Assignee** — assign Issues to a different team member
187+
188+
These settings are accessible from the **Edit Engagement** page. For more details, see **[Engagement-Level Jira Settings](issue_tracking/jira/jira_guide#engagement-level-jira-settings)**.

0 commit comments

Comments
 (0)