Lifecycle & States¶
Every Business Event Version in BizMetry goes through a defined lifecycle. Understanding these states is essential for managing which events are actively capturing telemetry, which are pending review, and which have been superseded or retired.
🔄 State Diagram¶
stateDiagram-v2
direction LR
[*] --> DRAFT : Created / Forked
DRAFT --> PUBLISHED : Publish
DRAFT --> [*] : Delete
PUBLISHED --> DEPRECATED : Template bumped\n(automatic — new DRAFT forked)
PUBLISHED --> RETIRED : Manual retire
DEPRECATED --> PUBLISHED : Reinstate
DEPRECATED --> RETIRED : Manual retire
RETIRED --> [*]
📋 States Reference¶
DRAFT¶
A version is in DRAFT when it has been created or forked but not yet activated for telemetry capture.
| Property | Value |
|---|---|
| Captures telemetry | ❌ No |
| Editable | ✅ Yes — all fields including mappings |
| Deletable | ✅ Yes |
| Agent receives it | ❌ No |
A DRAFT version is where you define or refine the event configuration — selecting operations, adjusting field mappings, editing BMEL expressions. Agents ignore DRAFT versions entirely.
One DRAFT at a time
Each Business Event can only have one DRAFT version at a time. Publishing the DRAFT or deleting it frees the slot.
PUBLISHED¶
A version is PUBLISHED when it has been explicitly activated and is ready for telemetry capture by agents.
| Property | Value |
|---|---|
| Captures telemetry | ✅ Yes |
| Editable | ❌ No — must bump to a new version to change |
| Deletable | ❌ No |
| Agent receives it | ✅ Yes |
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.
Multiple PUBLISHED versions
A Business Event can have multiple PUBLISHED versions simultaneously — one per templateInstanceId. This occurs when different environments reference different template versions. Each PUBLISHED version captures telemetry for its own environment scope.
DEPRECATED¶
A version is automatically DEPRECATED when its parent Template Instance is superseded by a bump, and at least one environment has migrated to the new template version.
| Property | Value |
|---|---|
| Captures telemetry | ✅ Yes — for environments still on the old template version |
| Editable | ❌ No |
| Deletable | ❌ No |
| Agent receives it | ✅ Yes — for its environment scope |
Deprecation is automatic — it is triggered by the Template version bump process, not manually. When a PUBLISHED version is deprecated, BizMetry simultaneously forks a new DRAFT version pointing to the new template instance, so you can update mappings to match the new template structure.
Deprecation guard
A PUBLISHED version is not deprecated if all environments still reference its template instance. Deprecation only fires when the environment scope of the old version is fully superseded.
A DEPRECATED version can be reinstated to PUBLISHED if the migration was rolled back or if conditions change.
RETIRED¶
A version is RETIRED when it has been manually decommissioned and should no longer capture telemetry under any circumstance.
| Property | Value |
|---|---|
| Captures telemetry | ❌ No |
| Editable | ❌ No |
| Deletable | ❌ No |
| Agent receives it | ❌ No |
Retirement is irreversible. Once RETIRED, a version cannot be re-activated.
Retiring a live version
Retiring a PUBLISHED or DEPRECATED version immediately stops telemetry capture for all environments in that version's scope. Agents will stop collecting and forwarding frames for this event until a new version is published.
⚡ Transition Reference¶
| From | To | Trigger | Who |
|---|---|---|---|
| (new) | DRAFT | Create wizard or fork | User |
| DRAFT | PUBLISHED | Publish action | User |
| DRAFT | (deleted) | Delete action | User |
| PUBLISHED | DEPRECATED | Template bump (automatic) | System |
| PUBLISHED | RETIRED | Retire action | User |
| DEPRECATED | PUBLISHED | Reinstate action | User |
| DEPRECATED | RETIRED | Retire action | User |