> For the complete documentation index, see [llms.txt](https://docs.alpha-security.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.alpha-security.app/user-guide/sysreptor.md).

# SysReptor Integration

Alpha can push reports directly into SysReptor for professional PDF rendering. Alpha owns the findings and evidence; SysReptor owns the formatting, executive summary, and final PDF output.

## Setup

1. In SysReptor, create a design (or duplicate the **Demo Design**). Make sure its finding fields include the IDs listed in the field mapping below. The standard predefined fields already cover all of them.
2. Copy the **design ID** (visible in the design's URL).
3. In Alpha, open an engagement and go to **Reports > SysReptor settings**:
   * **Global default** (admin): set the SysReptor base URL, design ID, and an API token (create one in SysReptor under your user's API tokens). The token is write-only and never returned by the API.
   * **Per-engagement override** (optional): use a different SysReptor server, design, or token for a specific client.
4. Create a report, select and order your findings, then click **Push to SysReptor**.

## Field mapping

When Alpha pushes findings to SysReptor, it maps them like this:

| SysReptor field       | Type     | Source in Alpha                                                             | Authored in |
| --------------------- | -------- | --------------------------------------------------------------------------- | ----------- |
| `title`               | string   | Finding title                                                               | Alpha       |
| `severity`            | enum     | Finding severity (info/low/medium/high/critical)                            | Alpha       |
| `cvss`                | cvss     | Optional CVSS vector (v3.1 or v4.0)                                         | Alpha       |
| `description`         | markdown | Finding description, with inline evidence when "include secrets" is enabled | Alpha       |
| `impact`              | markdown | Finding impact                                                              | Alpha       |
| `references`          | list     | Finding references (CWE IDs, URLs)                                          | Alpha       |
| `affected_components` | list     | Targets from the finding's "affects" relationships                          | Alpha       |
| `recommendation`      | markdown | Left empty for you to fill in SysReptor                                     | SysReptor   |
| `summary`             | markdown | Left empty for you to fill in SysReptor                                     | SysReptor   |

If your design derives severity from CVSS instead of a standalone field, that works fine. SysReptor ignores fields that aren't in the design schema.

## How re-pushing works

Alpha creates one SysReptor project per report and tracks the mapping between Alpha findings and SysReptor finding IDs. Re-pushing updates existing findings instead of creating duplicates.

Updates merge only Alpha-owned fields, so anything you wrote in SysReptor (recommendations, executive summary, branding) survives a re-push.

## Secrets and evidence

Finding descriptions are redacted by default. Inline evidence excerpts (raw tool output pasted into the description) are only included when the report's "include secrets" toggle is turned on. That toggle is audited.

## PDF download

Once your findings are in SysReptor, use Alpha's **Download PDF** button to render the report through SysReptor's PDF engine. Executive summary, remediation details, and branding are all handled on the SysReptor side.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.alpha-security.app/user-guide/sysreptor.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.