business-events

Business Events

When to Use This Skill

Use this skill when the user wants to:

• Define event-driven APIs using Kafka/message brokers
• Create business event services that publish events
• View or describe existing business event services
• Set up publish/subscribe message channels

Commands

View Business Events

-- List all business event service documents
show business event services;

-- Filter by module
show business event services in MyModule;

-- List all business event client documents (future)
show business event clients;

-- List individual messages across all services
show business events;

-- Filter messages by module
show business events in MyModule;

-- Full MDL description (round-trippable)
describe business event service Module.ServiceName;

Create a Business Event Service

create business event service Module.CustomerEventsApi
(
  ServiceName: 'CustomerEventsApi',
  EventNamePrefix: 'com.example'
)
{
  message CustomerChangedEvent (CustomerId: long) publish
    entity Module.PBE_CustomerChangedEvent;
  message AddressChangedEvent (AddressId: long) publish
    entity Module.PBE_AddressChangedEvent;
};

Create or Modify (Idempotent Update — Preferred)

Preserves the existing UUID so other documents that reference this service remain valid. OR REPLACE is accepted as a synonym.

create or modify business event service Module.CustomerEventsApi
(
  ServiceName: 'CustomerEventsApi',
  EventNamePrefix: ''
)
{
  message CustomerChangedEvent (CustomerId: long) publish
    entity Module.PBE_CustomerChangedEvent;
};

Drop a Business Event Service

drop business event service Module.CustomerEventsApi;

Message Definition Syntax

message <MessageName> (<AttrName>: <type>, ...) publish|subscribe
  [entity <Module.EntityName>]
  [microflow <Module.MicroflowName>];

Supported Attribute Types

• string - Text
• integer - 32-bit integer
• long - 64-bit integer
• decimal - Precise decimal number
• boolean - True/false
• datetime - Date and time