Start review

Author: quinntracy

content/en/docs/refguide/modeling/integration/change-data-capture/_index.md

@@ -1,23 +1,25 @@
 ---
 title: "Change Data Capture"
 url: /refguide/change-data-capture/
-weight: 45
+weight: 85
 description: "Describes Change Data Capture (CDC) services in Studio Pro, which publish domain model entity changes as Kafka streams for data warehouse and analytics pipelines."
 ---
 
 ## Introduction
 
-Change Data Capture (CDC) lets you stream domain model data out of a Mendix app in near real time. When objects in a tracked entity are created, updated, or deleted, the Mendix runtime captures those changes and publishes them as events to a Kafka topic. Downstream systems — such as data warehouses or analytics pipelines — can then consume the stream without polling the Mendix database.
+{{% alert color="warning" %}} This feature is in beta. For more information, see [Release Status](/releasenotes/release-status/). {{% /alert %}}
+
+Change Data Capture (CDC) lets you stream domain model data out of a Mendix app in near real time. When objects in a tracked entity are created, updated, or deleted, the Mendix Runtime captures those changes and publishes them as events to a Kafka topic. Downstream systems, such as data warehouses or analytics pipelines, can then consume the stream without polling the Mendix database.
 
 CDC is intended for developers who need to move Mendix domain model data to external data stores, such as a data warehouse, data lake, or blob storage.
 
 ## How It Works
 
-A CDC service document in Studio Pro defines which entities the runtime should track. On deployment, each tracked entity gets its own Kafka topic. Every time a committed object change occurs — create, update, or delete — the runtime publishes an event to the corresponding topic.
+A CDC service document in Studio Pro defines which entities the Mendix Runtime should track. On deployment, each tracked entity gets its own Kafka topic. Every time a committed object change occurs (create, update, or delete) the Mendix Runtime publishes an event to the corresponding topic.
 
-Read events are triggered as snapshots during startup or when a stream changes in a way that constitutes a breaking change.  Snapshots populate the new topic with the current data of the tracked entity. See [Revisions](/refguide/published-cdc-services/#revisions).
+Read events are triggered as snapshots during startup or when a stream changes in a way that constitutes a breaking change. Snapshots populate the new topic with the current data of the tracked entity. For more information, see the [Revisions](/refguide/published-cdc-services/#revisions) section below.
 
-The Kafka broker is either the [Mendix Event Broker](/appstore/services/event-broker/) or a Bring Your Own Kafka (BYOK) cluster. For details on configuring BYOK, see the [Mendix Event Broker](/appstore/services/event-broker/) page.
+The broker that receives these events is either the [Mendix Event Broker](/appstore/services/event-broker/) or a Bring Your Own Kafka (BYOK) cluster. For BYOK configuration details, see [Mendix Event Broker](/appstore/services/event-broker/).
 
 To move the streamed data to a destination such as Azure Blob Storage or AWS S3, you configure an [Event Broker Bridge](/appstore/services/event-broker/#manage-mx-broker-bridge) separately in the Event Broker Manager after deployment.
 
@@ -27,41 +29,48 @@ To move the streamed data to a destination such as Azure Blob Storage or AWS S3,
 Change Data Capture is not available for Free Apps. A licensed Mendix Cloud environment is required.
 {{% /alert %}}
 
-* A licensed Mendix Cloud environment.
-* A [Mendix Event Broker](/appstore/services/event-broker/) license, or a BYOK Kafka cluster configured as described in [Mendix Event Broker](/appstore/services/event-broker/).
-* An [Event Broker Bridge](/appstore/services/event-broker/#manage-mx-broker-bridge) configured in the Event Broker Manager if you want to route CDC events to external storage.
+* A licensed Mendix Cloud environment
+* A [Mendix Event Broker](/appstore/services/event-broker/) license, or a BYOK Kafka cluster configured as described in [Mendix Event Broker](/appstore/services/event-broker/)
+* An [Event Broker Bridge](/appstore/services/event-broker/#manage-mx-broker-bridge) configured in the Event Broker Manager if you want to route CDC events to external storage
 
 ## Setting Up Change Data Capture
 
+Set up a CDC service in Studio Pro by following the steps below:
+
 1. In Studio Pro, right-click a module in the App Explorer and choose **Add other** > **Change data capture service**.
-2. Configure the entities to track and their exposed names. See [Published CDC Services](/refguide/published-cdc-services/) for details.
-3. Deploy the app. The runtime creates Kafka topics for each tracked entity automatically.
+2. Select the entities to track and set an exposed name for each. For more information on configuring entities, see the [Entities to Track](/refguide/published-cdc-services/#entities) section of *Published CDC Services*.
+3. Deploy the app. The Runtime creates Kafka topics for each tracked entity automatically.
 4. In the [Event Broker Manager](https://broker.mendix.com/), configure an [Event Broker Bridge](/appstore/services/event-broker/#manage-mx-broker-bridge) to route CDC events to your destination.
 
 ## Runtime Configuration {#runtime-configuration}
 
-CDC requires runtime settings to connect to a Kafka broker. In Studio Pro, open **App** > **Settings**, go to the **Configurations** tab, select or create a configuration, and open the **Custom** tab to add the settings below. For deployed environments, set these via your environment's custom runtime settings.
+CDC requires runtime settings to connect to a Kafka broker. Follow the steps below:
+
+1. In Studio Pro, open **App** > **Settings**.
+2. Open the **Configurations** tab.
+3. Select an existing configuration or click **New** to make a new one.
+4. In the configuration, open the **Custom** tab to add the settings documented in the section below. For deployed environments, set these via your environment's custom runtime settings.
 
 {{< figure src="/attachments/refguide/modeling/integration/change-data-capture/cdc-custom-configuration.png" alt="Edit Configuration dialog in Studio Pro showing the Custom tab with Kafka.BootstrapServers set to an IP address and port" >}}
 
 ### Running Locally {#local-configuration}
 
-When running the app locally, only the bootstrap server address is required:
+When running the app locally, only the bootstrap server address is required.
 
 | Name | Description | Default Value |
 | --- | --- | --- |
 | `Kafka.BootstrapServers` | The address of the Kafka broker, in the format `host:port`. | |
 
 ### Bring Your Own Kafka (BYOK) {#byok-configuration}
 
-When connecting to a BYOK Kafka cluster, provide the bootstrap server address and credentials for authentication. The supported authentication method is SASL/SCRAM-SHA-512.
+When connecting to a BYOK Kafka cluster, provide the bootstrap server address and credentials for authentication. The supported authentication method is `SASL/SCRAM-SHA-512`.
 
 | Name | Description | Default Value |
-| --- | --- | --- | --- |
+| --- | --- | --- |
 | `Kafka.BootstrapServers` | The address of the Kafka broker, in the format `host:port`. | |
-| `Kafka.Username` | The username for SASL/SCRAM-SHA-512 authentication with the Kafka cluster. | |
-| `Kafka.Password` | The password for SASL/SCRAM-SHA-512 authentication with the Kafka cluster. | |
-| `EventBroker.Space` | The Event Broker space in which the app is placed. Defines which other applications can exchange events with this app. | `local` |
+| `Kafka.Username` | The username for `SASL/SCRAM-SHA-512` authentication with the Kafka cluster. | |
+| `Kafka.Password` | The password for `SASL/SCRAM-SHA-512` authentication with the Kafka cluster. | |
+| `EventBroker.Space` | The Event Broker space in which the app is placed. This defines which other applications can exchange events with this app. | `local` |
 
 ### Active-Producer Election {#active-producer-election}
 
@@ -73,7 +82,7 @@ If the active instance stops sending heartbeats (for example, because it crashed
 
 The `EventBroker.CdcProducerTransactionId` setting enables Kafka transactions on the active producer, which provides exactly-once delivery guarantees during normal operation and clean handover during failover.
 
-If any of the three settings is missing, the runtime logs a warning and falls back to single-instance mode, where all instances publish independently.
+If any of the three settings is missing, the Mendix Runtime logs a warning and falls back to single-instance mode, where all instances publish independently.
 
 ### Message Format {#message-format}
 

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

@@ -7,11 +7,9 @@ description: "Describes how to configure a Published CDC Service document in Stu
 
 ## Introduction
 
-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.
+{{% alert color="warning" %}} This feature is in beta. For more information, see [Release Status](/releasenotes/release-status/). {{% /alert %}}
 
-{{% alert color="warning" %}}
-Change Data Capture is a beta feature in Mendix 11.12. Its behavior and configuration options may change in future releases.
-{{% /alert %}}
+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.
 
 ## Creating a Published CDC Service {#create}
 
@@ -23,7 +21,7 @@ You can have multiple CDC service documents in an app — for example, to group
 
 ### Service Name {#service-name}
 
-The service name uniquely identifies the CDC service within the app.  The App Name is used as part of the topic to ensure uniqueness.
+The service name uniquely identifies the CDC service within the app. The app name is used as part of the topic to ensure uniqueness.
 
 ### Description {#description}
 
@@ -37,28 +35,34 @@ The **Entities to track** table lists the entities whose object changes are publ
 
 Use the toolbar to manage tracked entities:
 
-* **+ Add** — add an entity from the domain model
-* **Remove** — stop tracking a selected entity
-* **Accept changes** — lock in the current revision numbers after reviewing modifications (see [Revisions](#revisions))
+* {{% icon name="add-filled" %}} **Add** — add an entity from the domain model
+* {{% icon name="subtract-circle" %}} **Remove** — stop tracking a selected entity
+* {{% icon name="refresh" %}} **Accept changes** — lock in the current revision numbers after reviewing modifications (see [Revisions](#revisions))
 
 Each row in the table has the following columns:
 
-| Column | Description |
-| --- | --- |
-| **Entities** | The domain model entity being tracked. Expand the row to view and select individual attributes and associations. |
-| **Exposed name** | The name used for this entity in the Kafka topic and event payload. Defaults to the entity name. |
-| **Modification** | The pending change state: **Added**, **Changed**, or **Removed**. Blank if the entity is unchanged since the last accepted revision. |
-| **Revision** | The schema revision of the entity's event payload. See [Revisions](#revisions). |
-| **Topic** | 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) |
+### Entities
+
+The domain model entity being tracked. Expand the row to view and select individual attributes and associations
+
+### Exposed Name
+
+The name used for this entity in the Kafka topic and event payload. Defaults to the entity name.
+
+### Modification
+
+The pending change state: **Added**, **Changed**, or **Removed**. Blank if the entity is unchanged since the last accepted revision.
+
+### Revision
+
+The schema revision of the entity's event payload. See [Revisions](#revisions).
+
+### Topic
 
-### Adding an Entity {#add-entity}
+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).
 
-1. Click **+ Add** in the toolbar.
-2. Select a persistable entity from the domain model.
-3. Optionally edit the **Exposed name**.
-4. Expand the row to deselect any attributes or associations you do not want included in the event payload.
 
-### Attribute and Association Selection {#attributes}
+## Attribute and Association Selection {#attributes}
 
 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.
 
@@ -82,7 +86,7 @@ Pending modifications are not finalized until you click **Accept changes** in th
 Accepting changes confirms the new revision numbers and clears the modification states, leaving the document in a clean state ready for deployment.
 
 {{% alert color="warning" %}}
-A major revision creates a new Kafka topic. Consumers subscribed to the previous topic will no longer receive events after deployment. Ensure downstream systems are updated in coordination of deploying a major revision change.
+A major revision creates a new Kafka topic. Consumers subscribed to the previous topic will no longer receive events after deployment. Ensure downstream systems are updated before or alongside deploying a major revision change.
 {{% /alert %}}
 
 ## Runtime Behavior {#runtime}