You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/integration/change-data-capture/published-cdc-services.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,23 +9,23 @@ description: "Describes how to configure a Published CDC Service document in Stu
9
9
10
10
{{% alert color="warning" %}} This feature is in beta. For more information, see [Release Status](/releasenotes/release-status/). {{% /alert %}}
11
11
12
-
A Published CDC Service document defines the entities whose object changes the Mendix Runtime tracks and publishes as Kafka events. Each tracked entity produces a stream of create, update, and delete events on its own Kafka topic.
12
+
A Published CDC Service document defines which entities the Mendix Runtime tracks for object changes and publishes as Kafka events. Each tracked entity produces a stream of create, update, and delete events on its own Kafka topic.
13
13
14
14
## Creating a Published CDC Service {#create}
15
15
16
-
To create a published CDC service, right-click a module in the App Explorer and choose **Add other** > **Change data capture service**. Studio Pro adds the document to that module for logical grouping, but the service operates at app level.
16
+
To create a published CDC service, right-click a module in the **App Explorer** and choose **Add other** > **Change data capture service**. Studio Pro adds the document to that module for logical grouping, but the service operates at app level.
17
17
18
-
You can have multiple CDC service documents in an app — for example, to group entities by domain area or team ownership.
18
+
You can have multiple CDC service documents in an app, for example, to group entities by domain area or team ownership.
19
19
20
20
## General {#general}
21
21
22
22
### Service Name {#service-name}
23
23
24
-
The service name uniquely identifies the CDC service within the app. The app name is used as part of the topic to ensure uniqueness.
24
+
The service name identifies the CDC service within the app. The app name is included in the topic name to ensure uniqueness across apps.
25
25
26
26
### Description {#description}
27
27
28
-
An optional description for the CDC service.
28
+
This is an optional description for the CDC service.
29
29
30
30
## Entities to Track {#entities}
31
31
@@ -35,36 +35,34 @@ The **Entities to track** table lists the entities whose object changes are publ
35
35
36
36
Use the toolbar to manage tracked entities:
37
37
38
-
* {{% icon name="add-filled" %}} **Add** — add an entity from the domain model
* {{% icon name="refresh" %}} **Accept changes** – lock in the current [Revision](#revisions) numbers after reviewing modifications
43
41
44
42
### Entities
45
43
46
-
The domain model entity being tracked. Expand the row to view and select individual attributes and associations
44
+
The **Entities** column refers to the domain model entity being tracked. Expand the row to view and select individual attributes and associations.
47
45
48
46
### Exposed Name
49
47
50
-
The nameused for this entity in the Kafka topic and event payload. Defaults to the entity name.
48
+
The **Exposed name** column is the name used for this entity in the Kafka topic and event payload. It defaults to the entity name.
51
49
52
50
### Modification
53
51
54
-
The pending change state: **Added**, **Changed**, or **Removed**. Blank if the entity is unchanged since the last accepted revision.
52
+
The **Modification** column refers to the pending change state: **Added**, **Changed**, or **Removed**. This will remain blank if the entity is unchanged since the last accepted revision.
55
53
56
54
### Revision
57
55
58
-
The schema revision of the entity's event payload. See [Revisions](#revisions).
56
+
The **Revision** column is the schema revision of the entity's event payload. See the [Revisions](#revisions) section below for more information.
59
57
60
58
### Topic
61
59
62
-
The Kafka topic name for this entity, in the format `cdc.<app-name>.<ExposedName>.<revision>.{space}`, where `{space}` is replaced at runtime by the Event Broker space name. See [Bring Your Own Kafka (BYOK)](/refguide/change-data-capture/#byok-configuration).
60
+
The **Topic** column is the Kafka topic name for this entity, in the format `cdc.<app-name>.<ExposedName>.<revision>.{space}`, where `{space}` is replaced at runtime by the Event Broker space name. See the [Bring Your Own Kafka (BYOK)](/refguide/change-data-capture/#byok-configuration) section of *Change Data Capture* for more information.
63
61
64
62
65
63
## Attribute and Association Selection {#attributes}
66
64
67
-
Expand an entity row to see each attribute and association with a checkbox. Uncheck an item to exclude it from the event payload. The **Exposed name** column lets you rename individual attributes in the payload independently of their domain model names.
65
+
Expand an entity row to see each attribute and association with a checkbox. Uncheck an item to exclude it from the event payload. The **Exposed name** column allows you to rename individual attributes in the payload independently of their domain model names.
68
66
69
67
Associations appear as a list of identifiers within the parent entity's event payload. Attributes and associations do not produce separate Kafka topics and show no **Revision** or **Topic** values of their own.
70
68
@@ -74,8 +72,8 @@ Each tracked entity has a **Revision** number that identifies the schema of its
74
72
75
73
Studio Pro manages revisions automatically. When you modify the tracked configuration of an entity, Studio Pro marks it as **Changed** and calculates the new revision based on whether the change is breaking or non-breaking:
76
74
77
-
***Minor revision** (for example, `1.0` → `1.1`) — a non-breaking change such as adding a new attribute. Existing consumers can continue reading the topic without modification.
78
75
***Major revision** (for example, `1.0` → `2.0`) — a breaking change such as removing an attribute, renaming an entity's exposed name, or removing an entity from tracking. Consumers must be updated to use the new topic.
76
+
***Minor revision** (for example, `1.0` → `1.1`) — a non-breaking change such as adding a new attribute. Existing consumers can continue reading the topic without modification.
79
77
80
78
{{< figure src="/attachments/refguide/modeling/integration/change-data-capture/published-cdc-service-changes.png" alt="Published CDC Service document showing entities with Changed and Removed modification states and updated revision numbers" >}}
81
79
@@ -91,10 +89,12 @@ A major revision creates a new Kafka topic. Consumers subscribed to the previous
91
89
92
90
## Runtime Behavior {#runtime}
93
91
94
-
* The CDC service runs in the system context — no user security applies.
95
-
* Events are published for every committed object change: create, update, and delete.
96
-
* Kafka topics are created automatically on deployment for each tracked entity.
97
-
* Events use [CloudEvents](https://cloudevents.io/) payload format, consistent with other Mendix Event Broker services.
92
+
The following describe how the CDC service behaves at runtime:
93
+
94
+
* The CDC service runs in the system context, so no user security applies
95
+
* Events are published for every committed object change (create, update, and delete)
96
+
* Kafka topics are created automatically on deployment for each tracked entity
97
+
* Events use [CloudEvents](https://cloudevents.io/) payload format, consistent with other Mendix Event Broker services
0 commit comments