Analyse: Reports
Overview
Use this page to generate a report from test run results. A report is a customer-ready PDF or XLSX file built from the data of one or more test runs, rendered using a report template that defines its sections, charts and layout; it turns raw test data into a document you can hand to someone outside the platform.
Reports depend on data that already exists elsewhere: the test runs a report summarizes come from Testing: Test Runs, and the datasource that supplies their metrics is set up on Configuration: Datasources. The template a report uses is either a LoadGen-maintained starting point or one you create or clone on this page's Templates tab. Once generated, a report's output file is what you share outside the platform, separate from the live dashboards elsewhere in Analyse.
On this page you pick a template, datasource, test run(s) and optional baseline or format settings on the Generate tab to produce a report, manage report templates on the Templates tab, and track, download or remove past report jobs on the History tab.
Key concepts
- Template - A reusable report design that defines the sections, charts and layout a generated report will contain. (related: the Templates tab on this page)
- Datasource - The analytics data source that supplies the metrics behind a report; it also determines which test runs are available to pick. (related: Configuration: Datasources)
- Test runs - The completed load tests whose results the report is generated from; hold Ctrl or Cmd while clicking to include more than one run in a single report. (related: Testing: Test Runs)
- Baseline run - A prior test run selected for comparison, so the generated report highlights differences against it instead of showing the selected run(s) alone. (related: Testing: Test Runs)
- Report job - An asynchronous task that renders a report after you select Generate; its progress and resulting file are tracked on the History tab.
When to use it
- You need a customer-ready PDF or XLSX summary of one or more completed test runs.
- You want to compare a test run's results against an earlier Baseline run in a single report.
- You need to re-download a report you generated previously instead of rebuilding it.
- You're setting up or customizing the report layout your team uses by managing templates.
- A LoadGen-maintained template is close to what you need and you want an editable copy of it.
Before you begin
- At least one completed test run exists for the datasource you plan to report on, created on the Testing: Test Runs page.
- The datasource you want to report on is configured, see Configuration: Datasources.
- A report template exists for your category (LoadAndPerformance by default), or you plan to use the Templates tab to create or clone one.
- If you intend to compare results, a second test run exists to select as the Baseline run.
Common workflows
Generate a report from a test run
Persona: Load-test operator
- Select a value from the Datasource dropdown.
- Expect: The Test runs list populates with the runs available for that datasource; it was empty until a datasource was chosen.
- Select a Template from the Template dropdown.
- Expect: The Template field shows your chosen template; Category pre-filters which templates are offered.
- Select one or more runs in the Test runs list, holding Ctrl or Cmd to add more.
- Expect: The chosen runs are highlighted; these are the runs the report will be built from.
- Optionally choose a Baseline run and a Format override, then select Generate.
- Expect: A message shows the report is still generating and to check History shortly; the job is queued.
Verify: The History tab lists the new job; once its Status shows it has finished, selecting Download on that row retrieves the PDF or XLSX file.
Create a reusable report template
Persona: Admin
- Select the Templates tab.
- Expect: The page switches to the templates list (or an empty-state message if none exist yet), with a New template control.
- Select New template.
- Expect: A template editor opens for configuring the new report's layout and sections.
- Configure the template and save it.
- Expect: The template appears in the Templates list.
Verify: Switching to the Generate tab and opening Template shows the new template available for selection.
Customize a LoadGen-maintained template
Persona: Admin
- Select the Templates tab and locate a LoadGen-maintained template.
- Expect: Its row shows only a Clone to customize control, since LoadGen-maintained templates cannot be edited or deleted directly.
- Select Clone to customize.
- Expect: An editable copy of the template is added to your templates list.
- Select Edit on the new copy, adjust its layout, and save.
- Expect: Your changes are saved to the copy; the original LoadGen-maintained template is unchanged.
Verify: The cloned template appears as a separate, editable entry distinct from the original LoadGen-maintained template.
Steps
Step 1
Open Reports from the Analyse section.
Expected result: The Generate tab opens by default, showing the report-building panel on the left, Template, Category, Datasource, Test runs, Baseline run (optional) and Format override, and an empty Preview panel on the right prompting you to pick a template, datasource and test keys, then Generate.
This is the starting point for building a new report.
- Template, Category, Datasource and Test runs controls sit in the Generate panel on the left.
- The Preview panel on the right stays in its empty state until you generate a report.
Tabs on this page
-
Generate - Pick a template, datasource and test run(s), then produce a new report; the generated or in-progress report shows in the Preview panel.
- Template, Category, Datasource, Test runs, Include failed / cancelled runs, Baseline run (optional), Format override, and the Preview panel with Download.
-
Templates - Create, edit, clone, publish or delete the report templates offered on the Generate tab; LoadGen-maintained templates only offer Clone to customize.
- New template, and per-template Edit, Clone, Clone to customize, Publish… and Delete controls, plus Retry if the list fails to load.
-
History - Track previously queued or completed report jobs, download their files, or remove jobs you no longer need.
- Created, Status, Progress, Template, Size, File and Failure reason columns, with Download and Delete / Cancel per row.
Field reference
| Field | Purpose | Format / Validation | Required | Default |
|---|---|---|---|---|
| Template | Selects the report template that defines which sections, charts and layout the generated report contains; different templates produce different report structures from the same test data. | dropdown | No | - |
| Category | Groups templates and datasources by test type; change it if the template or datasource you expect is not showing in the other fields. | dropdown | No | LoadAndPerformance |
| Datasource | Selects the analytics data source that supplies the metrics behind the report; switching it clears any selected Test runs because the previous selection belonged to the prior datasource. | dropdown | No | - |
| Test runs | Chooses the completed test run(s) the report is built from; picking multiple runs produces a report covering all of them. The list is empty until you choose a Datasource. | multi-select list | No | - |
| Include failed / cancelled runs | When enabled, the Test runs and Baseline run lists also offer runs that failed or were cancelled, not only runs that completed successfully; leave it off to build reports from successful runs only. | checkbox | No | Unselected |
| Baseline run (optional) | Selects a prior test run to compare against; choosing a baseline makes the report highlight deltas relative to that run instead of showing the selected run(s) in isolation. Leave it at (none) for a standalone report. | dropdown | No | (none) |
| Format override | Overrides the output file format the selected template would otherwise produce (this page generates reports as PDF or XLSX). Leave it at Template default to use the format the template author configured, or pick an explicit format when you need a specific file type for this run. | dropdown | No | Template default |
Column reference
| Column | What it shows | How to read it |
|---|---|---|
| Created | - | Shows when the report job was queued; the most recent jobs are the ones you just generated. |
| Status | - | Shows the job's current state. While a job is still generating, Download is not yet available; once it finishes, Download becomes available; if it fails, check the Failure reason column. |
| Progress | - | Reflects how far an in-progress job has advanced; it stops updating once the job finishes or fails. |
| Template | - | Shows the template's name as it was when the job was queued, so renaming or deleting that template afterward does not change this column. Jobs created before this column existed may show it blank. |
| Size | - | Shows the generated file's size once the job finishes; blank while it is still generating. |
| File | - | Identifies the generated report file once the job completes; select Download on that row to retrieve it. If the file was removed from the appliance, downloading shows a message telling you to generate it again. |
| Failure reason | - | Explains why a job failed; blank for jobs that completed successfully or are still generating. |
Controls reference
Generate
Submits the selected Template, Datasource, Test runs and optional Baseline run / Format override to start building the report.
When to use: Once you've chosen a Template, Datasource and at least one test run.
Side effects: Mutating: queues a report job. The page shows a message that the report is still generating and to check History shortly; the job appears on the History tab until it finishes.
Download
Retrieves the generated report file, either from the Preview panel after a report finishes on the Generate tab, or from a completed row on the History tab.
When to use: After a report job has finished and you want the actual PDF or XLSX file.
Side effects: Read-only with respect to platform data: it starts a file download and does not change the job or template. If the underlying file was cleaned up from the appliance, it shows a message to generate the report again instead of downloading.
Expand preview
Expands the Preview panel to fill the viewport (the side navigation stays visible), or collapses it back to the split layout.
When to use: When you want a larger view of a rendered report before downloading it.
Side effects: Read-only, view-only toggle; no data changes.
New template
Opens the template editor to create a new report template from scratch.
When to use: When none of the existing templates produce the report layout you need.
Side effects: Mutating once saved: adds a new template to the list and makes it selectable from the Template dropdown on the Generate tab.
Retry
Reloads the templates list after it failed to load.
When to use: When the Templates tab shows a load error instead of your templates.
Side effects: Read-only: re-fetches the list; does not change any template.
Clone to customize
Creates an editable copy of a LoadGen-maintained template.
When to use: When a LoadGen-maintained template is close to what you need but you want to change it, since LoadGen-maintained templates cannot be edited or deleted directly.
Side effects: Mutating: adds a new, editable template to your list; the original LoadGen-maintained template is unchanged.
Clone
Creates a copy of an existing template you can edit independently.
When to use: When you want to reuse most of a template's layout but change some sections without affecting the original.
Side effects: Mutating: adds a new template to the list.
Edit
Opens the template editor for a template you own, to change its layout or sections.
When to use: When an existing template needs adjustment.
Side effects: Mutating once saved: changes apply to that template and affect reports generated from it afterward.
Publish…
Opens a dialog to publish a template so other users or teams can use it.
When to use: When a template you built is ready to share beyond your own templates list.
Side effects: Mutating: makes the template available to others once published.
Delete (template)
Removes a template you own. Selecting it opens a Delete template? confirmation; confirming with Delete removes it, Cancel leaves it in place.
When to use: When a template is no longer needed and nothing should keep generating reports from it.
Side effects: Mutating: permanently removes the template once confirmed; it no longer appears in the Template dropdown on the Generate tab.
Delete / Cancel (report job)
Removes a job from the History list, or cancels it if it is still generating. Selecting it opens a confirmation where Delete confirms and Keep backs out.
When to use: When you want to cancel a report that is taking too long, or clean up an old or failed job.
Side effects: Mutating: cancels an in-progress job or removes a finished/failed job from History once confirmed.
Dismiss (history error banner)
When to use: After reading the error, to clear the banner.
Side effects: Read-only: hides the message only, does not reload History.
Verify the result
When generation succeeds, the job you queued appears at the top of the History tab with a Status showing it has finished, a Size, and a File you can retrieve with Download. On the Generate tab, the Preview panel replaces its empty-state message with the rendered report, or a Download control becomes available. If Status still shows the report is generating, switch to History and check back once it updates. If no job appears in History at all, confirm you had selected a Template, a Datasource and at least one run in Test runs before selecting Generate.
Troubleshooting
- Symptom: Test runs stays empty after choosing a Datasource. Fix: Confirm that datasource has recorded runs, or enable Include failed / cancelled runs if the runs you expect did not complete successfully.
- Symptom: A previously selected run disappears from Test runs. Fix: Changing Datasource clears the Test runs selection because the prior runs belonged to the previous datasource; reselect your runs after choosing Datasource.
- Symptom: Download or Preview shows a message that the report's file is no longer available on the appliance. Fix: The file was cleaned up; regenerate the report from the Generate tab using the same Template, Datasource and Test runs.
- Symptom: Preview shows a message that PDF preview needs the updated API. Fix: Use Download to get the file directly instead of the inline preview, and ask an administrator to update the API.
- Symptom: A template's row shows only Clone to customize, with no Edit or Delete. Fix: That template is LoadGen-maintained and can't be edited or removed directly; select Clone to customize to get an editable copy.
- Symptom: The Templates tab shows a load error instead of your templates. Fix: Select Retry to reload the list; if it keeps failing, this is an outage rather than an empty templates list.
Related articles
- Prerequisite: Testing: Test Runs - Reports are built from completed test runs recorded there.
- Prerequisite: Configuration: Datasources - The Datasource dropdown on this page lists datasources configured there.
- See also: Analyse: Overview - Introduces the Analyse section that Reports belongs to.
- See also: Analyse: Dashboards - An alternative way to review test run metrics without generating a file.