Skip to content

Deployments

A deployment connects a report version with an environment. It says: “On the TEST environment, version v3 of this report is running.”

  1. Open the report in the designer
  2. Open the Deploy Drawer (right side)
  3. Select:
    • Version — Which version to deploy
    • Environment — Which environment to deploy to
    • Notes (optional) — Deployment note
  4. Click Deploy

Only one version of a report can be deployed per environment at a time. A new deploy replaces the previous one.

Version v3 ──deploy──▶ Environment TEST

A promotion copies a deployment from one environment to another. No need to manually select the same version again.

TEST (v3) ──promote──▶ QA (v3)

The same version (v3) then runs on both environments. The data set queries are identical (from the snapshot), but the data source configurations are environment-specific — on QA, the QA override of the data sources is used.

In the deploy drawer, you can expand each active deployment to view the included data sets and queries of the deployed version.

When an environment is selected in the switcher and a deployment exists for that environment, the PDF export uses:

  • The deployed version (layout, pages, parameters)
  • The snapshotted queries from the version
  • The environment-specific data source configurations

The PDF link includes the environment as a parameter:

/api/reports/{id}/pdf?environment={envId}&param1=value1
1. Design report in designer (working copy)
2. "Save Version" → create v1
3. Deploy v1 → TEST
4. Test and adjust if needed
5. "Save Version" → create v2
6. Deploy v2 → TEST
7. Promote TEST (v2) → QA
8. Promote QA (v2) → PROD

To deploy, users need:

  • Write access to the report (folder permission: editor or owner)
  • Environment permission for the target environment

Admins bypass all permission checks.