Suites

PruTAN Suites let you run scripts from one or more collections together as a single workflow and then review the consolidated results. A suite is ideal for end-to-end scenarios where related requests need to run in sequence and be analyzed as a group.

Suites are managed from their own Suites submenu, separate from individual collections.

Where Suites Live

  • Suites submenu — open Suites from the Studio sidebar to access the Suite Config, where you build, save, and run a suite.
  • Saved suites — suites you have saved previously appear in the suite list; reopen one to edit or run it again.
  • History — completed and in-progress suite executions. Clicking a suite run opens its analytics.

Creating and Saving a Suite

  1. Open the Suites submenu to launch the Suite Config.
  2. Select the scripts you want to include from one or more collections. The selected scripts become the contents of the suite.
  3. Enter a suite label (name). Labels must be unique within the team — if you enter a name that already exists, PruTAN flags it inline and keeps Save disabled until you change it. The same uniqueness check applies when you rename a saved suite.
  4. Adjust the Run Configuration as needed — an optional environment and release tag, plus the execution mode (Sequential by default) and the Shared Content toggle (see Run Configuration).
  5. Click Save.

Once saved, the suite appears in your saved suites. Saving again updates the existing suite, and running it later reuses the same saved definition.

Finding scripts quickly: Use the search in the Suite Config to filter the available scripts by name while you build the selection, so you don't have to scroll through every collection to find the requests you want to include.
Environment scope: A suite runs against the environment selected in its Suite Config, not the environment chosen in the global header dropdown. Set the environment here so that every script in the run resolves its variables from the same, intended source.

Editing the script selection

Inside the Suite Config, hover any collection, folder, or script row to reveal a remove (trash) icon — use it to drop that item from the suite. Removing the last script under a collection prunes the empty folder automatically. Editing the selection only changes this suite's definition; it never deletes anything from the underlying collections.

Run Configuration

The Run Configuration panel (on the right of the Suite Config) controls how the suite runs:

  • Suite Label (required) — the suite's name; must be unique within the team.
  • Release Tag (optional) — a free-text tag stored with the run, handy for tying an execution to a build or release.
  • Select Environment — the environment the suite resolves variables from (see the note above).
  • Execution — run scripts Sequentially (one after another) or in Parallel.
  • Shared Content — reuse dynamic values from one script in the scripts that run after it.

Running a Suite

  1. With scripts selected, click Run.
  2. PruTAN executes the selected scripts using the environment, execution mode (sequential / parallel), release tag, and Shared Content setting defined in the Run Configuration.
  3. When the run starts successfully, PruTAN automatically opens the Suite Analytics view for that execution.

You can run a saved suite directly, or build an ad-hoc selection and run it without saving first.

Running a Suite from CI/CD

A saved suite can be triggered from your CI/CD pipeline with a PruTAN API key, so a suite run becomes part of your build or release process. In the Run Configuration panel, select Copy configuration for: CI/CD to open the Run from CI/CD dialog, which provides ready-to-use, pre-filled snippets for Jenkins, GitHub Actions, AWS CodeBuild, and cURL.

For step-by-step setup on each platform — storing the API key as a secret or credential, adding the pipeline file, and running it — see Running Suites from CI/CD.

Suite Analytics

The analytics view shows consolidated results for the run.

  • Nested tree — folders and their leaf scripts are shown as an expandable / collapsible tree, with expand-all and collapse-all controls. Your collapse state and the currently selected request are preserved as results update.
  • Live polling — while a suite is running, results refresh automatically with a countdown timer and a Running badge, so you can watch passes and failures accumulate. The run is treated as complete once every script has returned a result.
  • Summary metrics — environment, total duration, average response time, region, and the pass / fail counts for the run.

Request Details

Select any script in the results tree to open its detail panel on the right. The panel shows the script's status, response time, and size, and provides tabs to inspect the run in depth:

  • Validation — assertion and test results for the script.
  • Response — the response body returned by the script.
  • Raw — the unformatted response payload.
  • Headers — the response headers.
  • Request — the request that was sent (URL, headers, and body).
  • Overview — a summary of the request and its result.

Run Again

Use Run Again to re-execute the same suite. It rebuilds the run from the saved suite (or from the current analytics tree) and dispatches a fresh execution. Run Again stays disabled until the responses for all scripts in the current run have been fetched.

Generating Reports

Suite Analytics can generate two downloadable reports: a PDF Report and an Excel Report.

  • PDF Report — a printable, formatted summary of the suite run, including the pass/fail summary and key metrics.
  • Excel Report — an .xlsx workbook covering the run summary, a per-request breakdown, and pass/fail totals.

Steps to generate a report:

  1. Open Suite Analytics for the completed suite run.
  2. Click the Export button.
  3. Choose PDF Report or Excel Report.
  4. The file is prepared and downloaded automatically.
Reports include metadata about the suite run (start/end times, environment, and execution summary).

Organizing requests

Learn more about organizing the requests and collections that make up a suite.

Table of Contents