Analyse: Reports
Overview
Use this page to generate a PDF or XLSX report from test run data and manage the templates those reports are built from. A report template defines what a generated file contains and how it is laid out; running a template against one or more test runs produces a static, shareable file for stakeholders who do not work directly in the platform.
Reports draw on completed test runs created in Testing: Test Runs (started from Testing: Run Test), so at least one run must exist before you can report on it. Unlike Analyse: Dashboards or Analyse: Analysis, which stay interactive inside the platform, a report is a fixed export you can send outside it, and the finished file is the deliverable other tools and people consume.
This page lets you pick a template, a category and datasource, the test runs to include (plus an optional baseline run for comparison), then generate the file; track and re-download past report jobs on the History tab; and create, clone, edit, publish, or delete templates on the Templates tab.
Key concepts
- report template - A saved definition of a report's layout and content, with a default output format (PDF or XLSX). Built-in templates are LoadGen-maintained and cannot be edited directly; your own templates can be edited, cloned, published, or deleted.
- datasource - The underlying source of test-run data a report is generated from, scoped by Category. Changing it reloads which test runs are available to select. (related: Testing: Test Runs)
- test run - A single completed execution of a load test whose results can be compiled into a report. You can select one or more runs to include. (related: Testing: Test Runs)
- baseline run - A prior test run selected for comparison, so the generated report shows change relative to that run instead of only absolute figures. (related: Testing: Test Runs)
- report job - The background task created each time you generate a report. It is tracked on the History tab until the output file is ready to download.
When to use it
- After a load test completes and you need a shareable PDF or XLSX summary for a stakeholder who doesn't use the platform.
- When you want a report that compares a new test run against a previous baseline run.
- When you need to re-download or re-render a report you generated earlier without rebuilding the selections from scratch.
- When the built-in templates don't match how your organization presents results, and you need a customized template.
- When you want to check whether a previously requested report finished generating or failed.
Before you begin
- At least one completed test run exists for the Category and Datasource you want to report on, created from Testing: Test Runs (and run from Testing: Run Test).
- You know which Category and Datasource the report should draw from.
- If you want a before/after comparison, a second qualifying test run exists to use as the Baseline run.
- If no built-in template fits your reporting needs, you have cloned and customized one on the Templates tab first.
Common workflows
Generate a report from a completed test run
Persona: Load-test operator
- Select a Category, then a Datasource matching the module you tested.
- Expect: The Test runs list and Baseline run dropdown reload to show only runs belonging to that Datasource.
- Select a Template from the Template dropdown.
- Expect: The dropdown shows your chosen template; the Preview panel keeps its placeholder until you generate.
- Select one or more completed runs in Test runs, using Ctrl/Cmd-click for more than one.
- Expect: The selected runs highlight in the list.
- Optionally set a Baseline run, then select Generate.
- Expect: The status message changes to indicate the report is generating, and a new row appears on the History tab.
- Switch to the History tab and select Download once the job's Status shows it has finished.
- Expect: The report file downloads to your device.
Verify: The History tab shows the job as finished, and the downloaded PDF or XLSX opens with the selected test run data and any baseline comparison you configured.
Customize a built-in report template
Persona: Admin
- Switch to the Templates tab.
- Expect: The template list loads, showing built-in and your own templates.
- Select Clone to customize on a built-in template.
- Expect: An editable copy of the template is created and owned by you.
- Select Edit on the cloned template, make your changes, and save.
- Expect: The changes persist to your copy only; the original built-in template is unchanged.
Verify: Your cloned template appears as a separate entry in the Templates list and is selectable from the Template dropdown on the Generate tab.
Steps
Step 1
Open the Reports page.
Expected result: The page loads on the Generate tab with Category defaulted to LoadAndPerformance, no Template, Datasource, or Test runs selected, and the Preview panel showing a placeholder prompting you to pick a template, datasource, and test keys before generating.
This is the starting point for building and running a new report.
- The Generate tab is active by default; Templates and History are available alongside it.
- Category defaults to LoadAndPerformance; Datasource and Template start unselected.
-
Baseline run (optional) defaults to (none) and Format override defaults to Template default.
Tabs on this page
-
Generate - Build and run a report: choose a template, scope the data, select test runs, and generate the output file.
- Template, Category, Datasource, Test runs, Include failed / cancelled runs, Baseline run (optional), Format override, and the Preview panel.
-
Templates - View built-in and your own report templates, and create, clone, edit, publish, or delete your own.
- Template list with New template, Clone to customize, Clone, Edit, Publish…, and Delete controls.
-
History - Track report jobs you've generated: see status and progress, download finished files, re-render, or remove entries.
- Per-job rows: Template, Created, Status, Progress, File, Failure reason, with Download, Render again, and Delete / cancel controls.
Field reference
| Field | Purpose | Format / Validation | Required | Default |
|---|---|---|---|---|
| Template | Selects the report template that determines the generated file's layout, content, and default output format. Built-in templates give a ready-made layout; a cloned, customized template lets you control what sections and metrics appear. | dropdown | No | - |
| Category | Narrows which templates and test runs are offered to those belonging to a testing module. Changing it reloads the Template and Test runs choices to match. | dropdown | No | LoadAndPerformance |
| Datasource | Chooses the specific data source within the selected Category that test runs are pulled from. Switching Datasource clears any already-selected Test runs, since a selected run only belongs to one datasource at a time. | dropdown | No | - |
| Test runs | Selects the one or more completed runs whose results the report compiles. Selecting several runs lets a template that supports it produce a multi-run comparison instead of a single-run snapshot; use Ctrl/Cmd-click to extend the selection. | multi-select list | No | - |
| Include failed / cancelled runs | Controls whether the Test runs list and the Baseline run dropdown also show runs that failed or were cancelled. Leave it off to keep both pickers limited to clean, completed runs; turn it on when you specifically need to report on or compare against a run that did not finish successfully. | checkbox | No | Off |
| Baseline run (optional) | Picks a prior run to compare the selected Test runs against. Setting it changes the report from absolute figures to a before/after comparison; leaving it at (none) produces a standalone report with no comparison. | dropdown | No | (none) |
| Format override | Forces the generated file to PDF or XLSX regardless of the selected template's own default. Leave at Template default to use whichever format the template was built for; override it when you need the other format for a specific recipient or tool. | dropdown | No | Template default |
Column reference
| Column | What it shows | How to read it |
|---|---|---|
| Template | The name of the template used for this report job. | Shows the template name captured at the moment you generated the report, so it still reads correctly even if that template was later renamed or deleted. If the job was built from a built-in template, hovering the value shows a tooltip naming it. |
| Created | When the report job was queued. | Use it to find the report you just generated among older history rows; most recent jobs sort to the top. |
| Status | The current state of the render job. | While the job is still generating, Download is unavailable; once the job finishes, the row's Download control becomes usable. |
| Progress | How far a still-generating job has advanced. | A still-advancing value means the job is actively rendering; it stops changing once the job finishes or fails. |
| File | The output file produced by a finished job. | Blank until the job finishes; once populated, use the row's Download control to retrieve the file. |
| Failure reason | Why a job did not produce a file. | Populated only when the job failed, telling you whether to Render again as-is or go back to the Generate tab and adjust your selections. |
Controls reference
Generate
Runs the selected Template against the chosen Category, Datasource, Test runs, Baseline run, and Format override, and starts a background render job.
When to use: Once you've picked a template, datasource, and at least one test run.
Side effects: Mutating: creates a new report job and a new row on the History tab; the job may still be generating when you switch away, so the report is not immediately available.
LoadGen Exchange
Opens the LoadGen Exchange filtered to report templates.
When to use: When you want to browse or install templates shared outside your own organization.
Side effects: Read-only on this page: navigates away without changing your current Generate selections.
Download (Preview panel)
Downloads the bytes of the most recently generated report.
When to use: After Generate has produced a file and you want a local copy.
Side effects: Read-only: does not change any server-side state.
Preview fullscreen toggle
Expands the Preview panel to fill the browser viewport, or collapses it back.
When to use: When reading a multi-page rendered report and the panel is too small.
Side effects: Read-only: a display toggle only, left navigation stays visible.
New template
Opens a blank, editable template for you to build.
When to use: When no existing built-in or cloned template matches what you need to produce.
Side effects: Mutating once saved: adds a new template you own to the Templates list.
Scope filter (Templates tab)
Switches which group of templates the list displays.
When to use: When you need to find a template that isn't in the currently displayed group.
Side effects: Read-only: only changes what is listed.
Retry
Reloads templates or report history after a failed fetch.
Side effects: Read-only: re-requests data, no changes to templates or jobs.
Clone to customize
Creates an editable copy of a built-in template, owned by you.
When to use: When a built-in template is close to what you need but you can't edit it directly.
Side effects: Mutating: adds a new template to the Templates list; the original built-in template is unchanged.
Clone
Creates a duplicate of one of your own templates.
When to use: When you want to branch a variant of a template without altering the original.
Side effects: Mutating: adds a new template to the Templates list.
Edit
Opens one of your own templates for editing.
When to use: When you need to change the layout or content of a template you own. Not available on built-in templates.
Side effects: Opens an edit view; no change takes effect until you save.
Publish…
Opens a dialog to publish a template so others can use it.
When to use: When a template you built should be available beyond your own use.
Side effects: Mutating once confirmed in the dialog: changes the template's availability to others.
Delete (Templates tab)
Removes one of your templates after you confirm in the Delete template? dialog.
When to use: When a template you own is no longer needed.
Side effects: Mutating and destructive: the template is permanently removed after you confirm Delete (Cancel exits without changes).
Download (History row)
Downloads the finished report file for that job.
When to use: Once a job's Status shows it has finished.
Side effects: Read-only, unless the file was cleaned up on the appliance, in which case it shows an error instead of a download.
Render again
Re-queues the same job's template and selections as a new render.
When to use: When a job failed, or its file is no longer available, and you want the same report without re-entering the selections on Generate.
Side effects: Mutating: creates a new report job and a new row on the History tab.
Delete / cancel (History row)
Opens a Keep/Delete confirmation to cancel a running job or remove a finished one from history.
When to use: When you want to stop a job that's still generating, or clear out an old entry.
Side effects: Mutating and destructive once confirmed with Delete; Keep exits without changes.
Dismiss banner
Closes an inline error or notice message.
Side effects: Read-only: hides the message only, does not retry or change any job.
Verify the result
After Generate completes, the History tab shows the job's Status as finished and its Download control becomes usable. For PDF output, the Preview panel on the Generate tab also renders the finished report inline; XLSX output has no inline preview, so confirm success from the History tab instead. If Status still shows the job generating, or a Failure reason is present, the report has not completed, check that step before expecting a download. The first thing to check on failure is whether a Template, Datasource, and at least one Test run were actually selected before Generate was used.
Troubleshooting
- Symptom: The Preview panel still shows "Pick a template, datasource and test keys, then Generate." Fix: Confirm a Template, Datasource, and at least one Test run are selected, then use Generate again; the preview only renders after a job completes.
- Symptom: Download on the History tab fails with a message that the file is no longer available on the appliance. Fix: Rendered files are not kept indefinitely; use Render again, or return to the Generate tab and generate the report again.
- Symptom: A built-in template has no Edit control, only Clone to customize. Fix: Built-in templates are LoadGen-maintained and cannot be edited directly; select Clone to customize to get an editable copy.
- Symptom: The Test runs list doesn't contain the run you expect. Fix: Recheck the Datasource, changing Datasource clears previously selected runs and reloads the list scoped to the new datasource, and enable Include failed / cancelled runs if the run you need did not finish successfully.
- Symptom: Templates or report history fail to load, or an action reports Download failed / Render again failed / Clone failed. Fix: Select Retry, or repeat the action; this indicates a communication problem with the appliance rather than an empty list.
Related articles
- Prerequisite: Testing: Test Runs - Completed test runs are the data reports are generated from
- Prerequisite: Testing: Run Test - Launch a new test run when no suitable run exists to report on
- See also: Analyse: Dashboards - View live, interactive metrics instead of a static exported report
- See also: Analyse: Analysis - Drill into test-run metrics interactively before deciding what to put in a report
- See also: LoadGen Cloud: LoadGen Exchange - Browse and install shared report templates via the LoadGen Exchange button