Skip to main content

Message-type catalog

This is the catalog of every message type currently defined in this registry, grouped by defining system. All types listed here are public (they cross system boundaries). For each type, services consume the generated artifact with group id ch.admin.bit.jeap.messagetype.<system-lowercase> and the artifact id shown below (the type name in kebab-case); see Getting started.

None of the current descriptors pin a topic in the registry — the topic is configured by the producing/consuming service. For the descriptor fields and version semantics see Registry structure.

System JEAP

Group id ch.admin.bit.jeap.messagetype.jeap.

Events

TypeArtifact idVersionsPurpose
B2BMessageReceivedEventb2b-message-received-event1.0.0, 1.1.0, 1.2.0, 1.3.0Signals that the Message Exchange Service received a new message.
B2BMessageSentEventb2b-message-sent-event1.0.0, 1.1.0Signals that an internal client of the Message Exchange Service posted a new message for a business partner.
ProcessContextOutdatedEventprocess-context-outdated-event1.0.0, 1.1.0, 1.2.0Notifies the Process Context Service internally that a new message arrived for a process instance (has a key schema).
ProcessSnapshotCreatedEventprocess-snapshot-created-event1.0.0, 1.1.0, 2.0.0, 2.0.1Signals that a new process snapshot has been created.
ReactionIdentifiedEventreaction-identified-event1.0.0, 2.0.0Announces a reaction identified for the first time since startup of a service using the jEAP Reaction Observer (has a key schema).
ReactionsObservedEventreactions-observed-event1.0.0Announces that reactions have been observed in a certain timeframe.

Commands

TypeArtifact idVersionsPurpose
CreateArtifactCommandcreate-artifact-command1.0.0, 1.0.1Triggers asynchronous process-archive artifact creation for a backfill task.
CreateAuditRecordCommandcreate-audit-record-command1.0.0, 1.0.1Creates an audit record.
NotifyClientCommandnotify-client-command1.0.0, 1.0.1Notifies clients about resource changes.

System _SHARED

Types publishable by several systems. Group id ch.admin.bit.jeap.messagetype._shared.

Events

TypeArtifact idVersionsPurpose
SharedArchivedArtifactVersionCreatedEventshared-archived-artifact-version-created-event2.0.0, 2.0.1, 2.0.2Published by a Process Archive Service instance of a system when a process artifact is created/updated (uses the shared ProcessIdMessageKey).

Shared records

descriptor/_shared/_common/ holds the shared ch.admin.bit.jeap.messagetype.shared.processid.ProcessIdMessageKey key record, reused as the key schema of SharedArchivedArtifactVersionCreatedEvent.