Skip to main content

Report Token: {Link_Finding}

This guide explains how to use the Link_Finding token in reports to create internal hyperlinks to findings.


Basic Structure

The token uses URL-style parameters separated by & characters. For example:

{Link_Finding?code=VULN-001&text=See SQL Injection details}

Configuration Sections

1. Required Parameters

code=[finding_code]

  • The code of the finding to link to
  • Case-insensitive matching
  • Must match a finding code in the current project
  • Example: code=VULN-001

2. Optional Parameters

text=[custom_text]

  • Custom text to display for the link
  • If not specified, defaults to "Code - Finding Name" (e.g., "VULN-001 - SQL Injection")
  • Example: text=Click here to view the vulnerability

display=[inline|block]

  • Controls how the link is rendered
  • Available values: inline (default), block
  • inline: Renders as a span element, suitable for use within paragraphs
  • block: Renders as a div element, suitable for standalone links
  • Example: display=block

How It Works

The Link_Finding token creates clickable hyperlinks that navigate to the corresponding finding's detail section within the same PDF document.

  • When the report is generated, the token looks up the finding by its code
  • It generates an anchor link pointing to the finding's detail section (created by Finding_Details or similar tokens)

For this to work properly:

  • The finding must exist in the project
  • The finding must be included in the report (via Finding_Details token or similar)

Error Handling

The token displays error messages in the following cases:

Missing code parameter:

[Invalid Link: No finding code specified]

Finding not found:

[Finding 'VULN-XXX' not found]

HTML Structure and CSS Classes

The Link_Finding token generates hyperlinks that navigate to finding detail sections within the document.

<span class="internal-link-text">Link Text</span>

CSS Classes:

  • internal-link-text: Base styling for the link text in preview
<div class="internal-link-text">Link Text</div>

CSS Classes:

  • internal-link-text: Base styling for the link text in preview
<a href="#finding-vuln-001" class="internal-link internal-link-finding">Link Text</a>

CSS Classes:

  • internal-link: Base class for all internal links
  • internal-link-finding: Specific class for finding links

Block Display Wrapper (in PDF)

<div class="internal-link-block">
    <a href="#finding-vuln-001" class="internal-link internal-link-finding">Link Text</a>
</div>

CSS Classes:

  • internal-link-block: Wrapper for block-level links

Error Display

<span class="link-error">[Error message]</span>

CSS Classes:

  • link-error: Styling for error messages

Examples

Basic link with default text

{Link_Finding?code=VULN-001}

Creates a link displaying "VULN-001 - SQL Injection" (assuming that's the finding's name) that navigates to the finding's detail section.

Link with custom text

{Link_Finding?code=VULN-001&text=See the SQL Injection finding for more details}

Creates a link with custom display text while still navigating to the VULN-001 finding.

{Link_Finding?code=VULN-001&text=View Finding Details&display=block}

Creates a standalone block-level link, useful for prominent navigation elements.

Inline link within text

For more information about this vulnerability, refer to {Link_Finding?code=VULN-001&text=the detailed analysis} in the Findings section.

Creates an inline link that flows naturally within a paragraph.

Multiple finding references

The following vulnerabilities are related:
- {Link_Finding?code=VULN-001&text=SQL Injection}
- {Link_Finding?code=VULN-002&text=XSS Vulnerability}
- {Link_Finding?code=VULN-003&text=CSRF Attack}

Creates a list of links to different findings in the report.

Was this article helpful?