Skip to content

Managing Versions

This page covers all version-level operations you can perform on a Business Event — publishing, retiring, reinstating, and deleting versions.

📋 Accessing Version Actions

From the Business Events tab, each event row can be expanded to show its version list. Action buttons appear on each version row depending on its current state.

Screenshot pending

Capture required: Business Events tab with an event expanded showing its version list and action buttons on each row.

✅ Publishing a DRAFT

Publishing a DRAFT version activates it for telemetry capture — agents will begin intercepting the configured API operations and populating the target Frame Type.

How to publish:

  1. Find the DRAFT version in the event's version list.
  2. Click the "Publish" button on the version row.
  3. A confirmation dialog appears summarizing what will be published.
  4. Click "Confirm".

Screenshot pending

Capture required: Publish confirmation dialog for a DRAFT version showing event name, version number, and a summary of selected operations and frame target.

After publishing: - The version transitions to PUBLISHED. - Connected agents receive the updated event configuration on their next sync. - The PUBLISHED version begins intercepting calls immediately.

One DRAFT at a time

Publishing the DRAFT clears the DRAFT slot. You can create a new version (fork) at any time after publishing.

🗄️ Retiring a Version

Retiring permanently decommissions a version — telemetry capture for that version stops immediately.

How to retire:

  1. Find the PUBLISHED or DEPRECATED version you want to retire.
  2. Click the "Retire" button on the version row.
  3. A warning dialog appears indicating the environments that will lose telemetry capture.
  4. Click "Confirm" to proceed.

Screenshot pending

Capture required: Retire confirmation dialog showing a warning listing the environments that will stop capturing, e.g. "⚠ This version is currently live in: Development, QA. Retiring will stop telemetry capture in these environments."

Irreversible

Retiring a version is permanent. There is no undo. If you need to restore capture, you must publish a new version.

Retire guard

BizMetry blocks retiring a PUBLISHED version if it is the only active version for its environment scope and no other PUBLISHED version covers those environments. This prevents accidentally creating an observability gap.

🔄 Reinstating a DEPRECATED Version

A DEPRECATED version can be reinstated to PUBLISHED if you need to roll back a template migration or if the deprecation was triggered prematurely.

How to reinstate:

  1. Find the DEPRECATED version in the event's version list.
  2. Click the "Reinstate" button.
  3. A confirmation dialog appears.
  4. Click "Confirm".

Screenshot pending

Capture required: Reinstate confirmation dialog for a DEPRECATED version.

After reinstating: - The version returns to PUBLISHED. - Agents resume telemetry capture for this version's environment scope.

Reinstate does not remove the DRAFT fork

Reinstating a DEPRECATED version does not delete the DRAFT fork that was created when it was deprecated. Both exist simultaneously — the reinstated PUBLISHED version captures telemetry, while the DRAFT fork can still be edited and eventually published to supersede it.

🗑️ Deleting a DRAFT Version

Only DRAFT versions can be deleted. Published, Deprecated, and Retired versions cannot be removed.

How to delete:

  1. Find the DRAFT version.
  2. Click the "Delete" icon (🗑️) on the version row.
  3. Confirm the deletion.

Screenshot pending

Capture required: Delete icon on a DRAFT version row and the confirmation prompt.

Deleting a DRAFT: - Permanently removes the draft configuration. - Frees the DRAFT slot so a new fork can be created. - Does not affect any PUBLISHED or DEPRECATED versions of the same event.

📊 Version Actions by State

State Publish Retire Reinstate Delete
DRAFT ✅ ❌ ❌ ✅
PUBLISHED ❌ ✅ ❌ ❌
DEPRECATED ❌ ✅ ✅ ❌
RETIRED ❌ ❌ ❌ ❌