Lifecycle & States¶

Every Business Event Version in BizMetry goes through a defined lifecycle. Understanding these states — and the versioning/reinstatement/deletion rules around them — is essential for managing which events are actively capturing telemetry, which are pending review, and which have been superseded or retired.

State Diagram¶

States Reference¶

DRAFT¶

A version is in DRAFT when it has been created, forked, or reopened, but not yet published.

A DRAFT version is where you define or refine the event configuration — selecting operations, adjusting field mappings, editing BMEL expressions. Traffic it captures goes to the staging area, so you can test the configuration against real traffic before publishing it.

PENDING_REVIEW¶

A version enters PENDING_REVIEW when a DRAFT is submitted for approval (Submit).

From here a reviewer either Approves it (→ APPROVED) or Rejects it (→ REJECTED).

APPROVED¶

A version is APPROVED once a reviewer has signed off on a PENDING_REVIEW version.

An APPROVED version can then be Published, as long as its target template version is Published. Until it is, the Publish action stays disabled and its tooltip names the template version that's blocking it. See Biz Event Lifecycle Management.

REJECTED¶

A version is REJECTED when a reviewer declines a PENDING_REVIEW version.

A REJECTED version can be sent back to DRAFT (Reopen as Draft) for another round of edits and re-submission.

PUBLISHED¶

A version is PUBLISHED when it has been explicitly activated and is ready for telemetry capture by agents. Only a version whose target template version is Published can reach this state.

A PUBLISHED version can coexist with a DRAFT (its child). This allows you to refine the next version without interrupting ongoing telemetry capture from the current one.

DEPRECATED¶

A version is automatically DEPRECATED in either of two situations:

1. Its target Frame Type + Version is superseded by a Template bump, and at least one environment has migrated to the new Template version.
2. Another version of the same Business Event is published targeting the same Frame Type + Version (see Auto-deprecation on publish).

Deprecation is always automatic — there's no manual "deprecate" action. When a PUBLISHED version is deprecated due to a Template bump, BizMetry simultaneously forks a new DRAFT version pointing to the new template instance, so you can update mappings to match the new template structure.

A DEPRECATED version can be reinstated to PUBLISHED — see Reinstating a version below.

RETIRED¶

A version is RETIRED when it has been manually decommissioned and should no longer capture telemetry under any circumstance.

Retirement is irreversible. Once RETIRED, a version cannot be re-activated — its only remaining action is Delete.

Versioning¶

Every Business Event's first version is always 1.0, created in DRAFT status.

From then on, versions are never edited in place once PUBLISHED — editing a PUBLISHED version instead forks a new version (in DRAFT), leaving the original PUBLISHED version untouched and still capturing telemetry. BizMetry calculates the new version number automatically, based on the scope of the change:

Major bump (+1.0)¶

Triggered only when the edit re-points the version at a different Template Version (i.e. the Version half of the target Frame Type + Version pair changes — see Step 2), regardless of whether the Frame Type also changes. This is treated as a breaking change.

Minor bump¶

Any other edit produces a minor (decimal) bump instead. The size of the bump depends on what changed — steps are not additive: if a single save touches more than one of these dimensions, only the largest step applies once.

Auto-deprecation on publish¶

When you transition a version to PUBLISHED, BizMetry checks for any other version of the same Business Event that is currently PUBLISHED and targets the same Frame Type + Version. If one is found, it is automatically transitioned to DEPRECATED — guaranteeing at most one PUBLISHED version per target Frame Type + Version.

Reinstating a DEPRECATED version¶

A DEPRECATED version's summary view shows a Reinstate button only when this state applies. Clicking it transitions the version directly back to PUBLISHED — but only if all these conditions hold:

1. The version's current status is DEPRECATED.
2. No other version of the same Business Event is currently PUBLISHED against the same Frame Type + Version this version targets.
3. Its target template version is still Published (not retired).

If another version is already PUBLISHED for that same Frame Type + Version, reinstating is blocked until that conflicting version is deprecated or retired.

Deletion rules¶

Whether a version can be deleted depends on its current state:

So the only path to delete a live version is: PUBLISHED → Retire → RETIRED → Delete (or, if it was already superseded, PUBLISHED → (auto) DEPRECATED → Retire → RETIRED → Delete).

Version Actions by State¶

Transition Reference¶

Related Sections¶

• Business Events — Overview
• Biz Event Lifecycle Management
• Versioning & Fork-on-Bump
• Managing Versions
• Creating a Business Event
• Editing a Business Event