Finding structure
This is the screen you’ll find in the sidebar under Finding Structure
(/field-visibility/, needs the field_visibility.manage permission). It
controls which rich text content sections exist on both
Findings and catalogue
templates, without deleting any data already saved in them when you hide
one.
What a content section is
Section titled “What a content section is”Each content section (ContentSectionDefinition in the code) is one
narrative field, things like “Vulnerability description” or “Business
impact,” with the following properties.
| Property | Meaning |
|---|---|
| Label | Display name |
| Slug | Stable identifier used by report tags ({{p finding['<slug>'] }}). It’s generated from the label when the section is created and never changes afterward |
| Order | Position among the other sections, lower first |
| Active | Whether it currently appears on the finding or catalogue form and in exports at all |
| Supports image upload | Whether this section’s rich text editor allows embedding images |
| Portal visible | Whether this section is shown to client portal users on a QA approved finding |
| Include in remediation report only | Restricts this section to remediation report exports, hidden on the initial report |
| Import target | Whether scanner imported findings (Scanner import) get their parsed description dropped into this specific section |
Default sections
Section titled “Default sections”A typical deployment ships with these seven, in this order.
| Order | Slug | Label | Supports images | Portal visible |
|---|---|---|---|---|
| 10 | vulnerability-description |
Vulnerability description | No | Yes |
| 20 | business-impact |
Business impact | No | Yes |
| 30 | testing-summary |
Testing summary | No | Yes |
| 40 | technical-details |
Technical details | Yes | Yes |
| 50 | remediation-testing |
Remediation testing | Yes | No |
| 60 | recommendations |
Recommendations | No | Yes |
| 70 | references |
References | No | Yes |
These are managed here and not in the finding or catalogue editor itself.
Adding, reordering, or deactivating a section changes what appears on every
finding and catalogue template, and what {{ finding_details }} includes in
the Document report template,
immediately and instance wide.
Managing sections
Section titled “Managing sections”- Add a section. Give it a label and set the flags above. Its slug and order are assigned automatically, and a new section always goes to the end.
- Reorder by moving a section up or down relative to its neighbors.
This just swaps two
ordervalues rather than renumbering everything. - Turn Active off to hide a section instance wide without losing any content already saved in it on existing findings. It simply stops appearing on forms and in exports.
- Delete a section to remove it entirely.
Hidden fields are hidden everywhere
Section titled “Hidden fields are hidden everywhere”A section with Active off is omitted from every exported format, Markdown, PDF, HTML, and Word alike, not just the app’s own UI. There’s no separate case where it quietly still shows up in a PDF. See Reports and exports.