Data & Event Platform — events
Generated from the architecture model
This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.
Topics follow context.area.vN.event-name (ADR-0012 port, ADR-0014 envelope). The context segment is the producing bounded context's slug.
| Event |
Producer |
Topic |
Scope |
Consumers |
| TopicRegistered |
EnvelopeRegistryService |
data-foundations.topics.v1.topic-registered |
integration |
2 |
| SchemaVersionPublished |
EnvelopeRegistryService |
data-foundations.topics.v1.schema-version-published |
integration |
2 |
| TopicDeprecated |
EnvelopeRegistryService |
data-foundations.topics.v1.topic-deprecated |
integration |
2 |
| EnvelopeProfileActivated |
EnvelopeRegistryService |
data-foundations.envelopes.v1.envelope-profile-activated |
integration |
2 |
| StoreProfileActivated |
StoreProfileService |
data-foundations.stores.v1.store-profile-activated |
integration |
2 |
| StoreBindingChanged |
StoreProfileService |
data-foundations.stores.v1.store-binding-changed |
integration |
3 |
| RetentionRuleChanged |
RetentionResidencyService |
data-foundations.retention.v1.retention-rule-changed |
integration |
5 |
| ResidencyRuleChanged |
RetentionResidencyService |
data-foundations.residency.v1.residency-rule-changed |
integration |
4 |
| DeletionOrderIssued |
RetentionResidencyService |
data-foundations.orders.v1.deletion-order-issued |
integration |
9 |
| DeletionOrderCompleted |
RetentionResidencyService |
data-foundations.orders.v1.deletion-order-completed |
integration |
4 |
| ExportCompleted |
RetentionResidencyService |
data-foundations.orders.v1.export-completed |
integration |
4 |
| LegalHoldChanged |
RetentionResidencyService |
data-foundations.orders.v1.legal-hold-changed |
integration |
5 |
TopicRegistered
A topic was registered or its producer or consumers changed.
|
|
| Producer |
EnvelopeRegistryService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.topics.v1.topic-registered |
| Aggregate |
TopicDefinition |
| Consumers |
StudioBff, AuditService |
| Field |
Type |
Required |
Description |
topic |
string |
yes |
|
producer |
string |
yes |
|
currentSchemaVersion |
string |
yes |
|
state |
enum:TopicState |
yes |
|
SchemaVersionPublished
A payload schema version is active.
|
|
| Producer |
EnvelopeRegistryService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.topics.v1.schema-version-published |
| Aggregate |
TopicDefinition |
| Consumers |
StudioBff, AuditService |
| Field |
Type |
Required |
Description |
topic |
string |
yes |
|
version |
string |
yes |
|
compatibility |
enum:Compatibility |
yes |
|
TopicDeprecated
A topic entered its deprecation window.
|
|
| Producer |
EnvelopeRegistryService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.topics.v1.topic-deprecated |
| Aggregate |
TopicDefinition |
| Consumers |
StudioBff, AuditService |
| Field |
Type |
Required |
Description |
topic |
string |
yes |
|
retiresAt |
datetime |
yes |
|
EnvelopeProfileActivated
The installation's envelope profile (or its contracts) changed.
|
|
| Producer |
EnvelopeRegistryService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.envelopes.v1.envelope-profile-activated |
| Aggregate |
EnvelopeProfile |
| Consumers |
StudioBff, AuditService |
| Field |
Type |
Required |
Description |
profile |
enum:MessagingProfile |
yes |
|
envelopeSchemaVersion |
string |
yes |
|
StoreProfileActivated
An engine profile is active for a class and topology.
|
|
| Producer |
StoreProfileService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.stores.v1.store-profile-activated |
| Aggregate |
StoreProfile |
| Consumers |
StudioBff, AuditService |
| Field |
Type |
Required |
Description |
profileId |
string |
yes |
|
storeClass |
enum:StoreClass |
yes |
|
topology |
string |
yes |
|
StoreBindingChanged
A logical store's binding or state changed.
|
|
| Producer |
StoreProfileService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.stores.v1.store-binding-changed |
| Aggregate |
StoreBinding |
| Consumers |
StudioBff, AuditService, RetentionResidencyService |
| Field |
Type |
Required |
Description |
storeId |
string |
yes |
|
tenantId |
string |
yes |
|
ownerService |
string |
yes |
|
region |
string |
yes |
|
state |
enum:BindingState |
yes |
|
RetentionRuleChanged
An effective retention rule changed.
|
|
| Producer |
RetentionResidencyService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.retention.v1.retention-rule-changed |
| Aggregate |
RetentionRule |
| Consumers |
StudioBff, AuditService, KnowledgeHost, ControlPlaneApi, ObservabilityHost |
| Field |
Type |
Required |
Description |
ruleId |
guid |
yes |
|
tenantId |
string |
yes |
|
storeClass |
string |
yes |
|
classification |
string |
yes |
|
retentionDays |
int |
yes |
|
ResidencyRuleChanged
A tenant's region or allowed engines changed.
|
|
| Producer |
RetentionResidencyService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.residency.v1.residency-rule-changed |
| Aggregate |
ResidencyRule |
| Consumers |
StudioBff, AuditService, ModelRouterService, StoreProfileService |
| Field |
Type |
Required |
Description |
tenantId |
string |
yes |
|
region |
string |
yes |
|
modelDataResidency |
string |
yes |
|
DeletionOrderIssued
Every owning service must delete the scope and acknowledge.
|
|
| Producer |
RetentionResidencyService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.orders.v1.deletion-order-issued |
| Aggregate |
GovernanceOrder |
| Consumers |
ControlPlaneApi, AgentRuntimeWorker, ModelGatewayHost, KnowledgeHost, ToolExecutorHost, IntegrationHost, GovernanceHost, ObservabilityHost, StudioBff |
| Field |
Type |
Required |
Description |
orderId |
guid |
yes |
|
tenantId |
string |
yes |
|
kind |
enum:OrderKind |
yes |
|
scope |
json |
yes |
|
dueAt |
datetime |
yes |
|
DeletionOrderCompleted
Every owner acknowledged; the scope is gone.
|
|
| Producer |
RetentionResidencyService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.orders.v1.deletion-order-completed |
| Aggregate |
GovernanceOrder |
| Consumers |
FleetIncidentService, AuditService, StudioBff, FactoryCommercialService |
| Field |
Type |
Required |
Description |
orderId |
guid |
yes |
|
tenantId |
string |
yes |
|
completedAt |
datetime |
yes |
|
ExportCompleted
An export bundle is available.
|
|
| Producer |
RetentionResidencyService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.orders.v1.export-completed |
| Aggregate |
GovernanceOrder |
| Consumers |
FleetIncidentService, AuditService, StudioBff, StudioNotificationService |
| Field |
Type |
Required |
Description |
orderId |
guid |
yes |
|
tenantId |
string |
yes |
|
exportRef |
string |
yes |
|
format |
enum:ExportFormat |
yes |
|
LegalHoldChanged
A legal hold was placed or lifted on a scope.
|
|
| Producer |
RetentionResidencyService (BC-42 Data & Event Foundations) |
| Scope / version |
integration / v1 |
| Topic |
data-foundations.orders.v1.legal-hold-changed |
| Aggregate |
GovernanceOrder |
| Consumers |
AuditService, KnowledgeHost, ControlPlaneApi, ObservabilityHost, StudioBff |
| Field |
Type |
Required |
Description |
orderId |
guid |
yes |
|
tenantId |
string |
yes |
|
scope |
json |
yes |
|
active |
bool |
yes |
|
Commands
| Command |
Service |
Handled by |
Result events |
Summary |
RegisterTopic |
EnvelopeRegistryService |
TopicDefinition |
TopicRegistered |
|
PublishSchemaVersion |
EnvelopeRegistryService |
TopicDefinition |
SchemaVersionPublished |
|
SetStoreBinding |
StoreProfileService |
StoreBinding |
StoreBindingChanged |
|
SetRetentionRule |
RetentionResidencyService |
RetentionRule |
RetentionRuleChanged |
|
SetResidency |
RetentionResidencyService |
ResidencyRule |
ResidencyRuleChanged |
|
IssueGovernanceOrder |
RetentionResidencyService |
GovernanceOrder |
DeletionOrderIssued, LegalHoldChanged |
|
AcknowledgeOrderTask |
RetentionResidencyService |
GovernanceOrder |
DeletionOrderCompleted |
|
Consumed from other services
| Consumer |
Event |
Producer |
Handler |
Purpose |
| RetentionResidencyService |
StoreBindingChanged |
StoreProfileService |
CheckResidency |
Verify every binding against the tenant's residency rule. |