Skip to content

Commit 58fe7ee

Browse files
committed
Review
1 parent 673844b commit 58fe7ee

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

content/en/docs/refguide/modeling/integration/change-data-capture/published-cdc-services.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ description: "Describes how to configure a Published CDC Service document in Stu
99

1010
{{% alert color="warning" %}} This feature is in beta. For more information, see [Release Status](/releasenotes/release-status/). {{% /alert %}}
1111

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.
1313

1414
## Creating a Published CDC Service {#create}
1515

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.
1717

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.
1919

2020
## General {#general}
2121

2222
### Service Name {#service-name}
2323

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.
2525

2626
### Description {#description}
2727

28-
An optional description for the CDC service.
28+
This is an optional description for the CDC service.
2929

3030
## Entities to Track {#entities}
3131

@@ -35,36 +35,34 @@ The **Entities to track** table lists the entities whose object changes are publ
3535

3636
Use the toolbar to manage tracked entities:
3737

38-
* {{% icon name="add-filled" %}} **Add** — add an entity from the domain model
39-
* {{% icon name="subtract-circle" %}} **Remove** — stop tracking a selected entity
40-
* {{% icon name="refresh" %}} **Accept changes** — lock in the current revision numbers after reviewing modifications (see [Revisions](#revisions))
41-
42-
Each row in the table has the following columns:
38+
* {{% icon name="add-filled" %}} **Add** – add an entity from the domain model
39+
* {{% icon name="subtract-circle" %}} **Remove** – stop tracking a selected entity
40+
* {{% icon name="refresh" %}} **Accept changes** – lock in the current [Revision](#revisions) numbers after reviewing modifications
4341

4442
### Entities
4543

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.
4745

4846
### Exposed Name
4947

50-
The name used 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.
5149

5250
### Modification
5351

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.
5553

5654
### Revision
5755

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.
5957

6058
### Topic
6159

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.
6361

6462

6563
## Attribute and Association Selection {#attributes}
6664

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.
6866

6967
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.
7068

@@ -74,8 +72,8 @@ Each tracked entity has a **Revision** number that identifies the schema of its
7472

7573
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:
7674

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.
7875
* **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.
7977

8078
{{< 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" >}}
8179

@@ -91,10 +89,12 @@ A major revision creates a new Kafka topic. Consumers subscribed to the previous
9189

9290
## Runtime Behavior {#runtime}
9391

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
9898

9999
## Read More
100100

0 commit comments

Comments
 (0)