Microsoft Dynamics 365 CRM Source Connector for Confluent Cloud

The fully managed Microsoft Dynamics 365 CRM Source connector for Confluent Cloud captures accounts, contacts, and other Dataverse records, and then streams them to Apache Kafka® topics.

Microsoft Dynamics 365 CRM is a cloud-based customer relationship management (CRM) platform built on Dataverse. The connector reads Dataverse entities through the Dataverse Web API. For entities with change tracking enabled, the connector incrementally captures inserts, updates, and deletes using change-tracking delta tokens. For entities without change tracking, the connector captures inserts and updates only, using the versionnumber column as a watermark. Deletes are not captured for those entities.

If you require private networking for fully managed connectors, make sure to set up the proper networking beforehand. For more information, see Manage Networking for Confluent Cloud Connectors.

PrivateLink to Dataverse is not supported, because Microsoft does not publish a PrivateLink endpoint for the Dataverse Web API.

Features

The Microsoft Dynamics 365 CRM Source connector provides the following features:

Configurable entity selection: Choose up to five standard or custom Dataverse entities per connector, for example accounts, contacts, or opportunities. The connector streams each entity to its own Kafka topic.
Change tracking: For entities with Dataverse change tracking enabled, the connector captures inserts, updates, and deletes using delta tokens and transitions automatically from an initial backfill to incremental ingestion. For entities without change tracking, the connector falls back to polling based on each record’s version number and does not capture deletes.
OAuth 2.0 authentication: The connector authenticates to Dataverse using the OAuth 2.0 client credentials grant with Microsoft Entra ID.
At least once delivery: The connector guarantees that records are delivered at least once to the Kafka topic.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect Usage Examples section.

Limitations

Be sure to review the following information.

For connector limitations, see Microsoft Dynamics 365 CRM Source Connector limitations.
If you plan to use one or more Single Message Transformations (SMTs), see SMT Limitations.

Supported entities

When you configure the connector, the Entity dropdown lists the following standard Dataverse entity-set names as convenience options. For any other entity, select CUSTOM and enter its entity-set name directly. These are the actual entity-set names, and they are what appear in topic names.

Quick Start

Use this quick start to get up and running with the Confluent Cloud Microsoft Dynamics 365 CRM Source connector. The quick start provides the basics of selecting the connector and configuring it to stream records from Dynamics 365 entities.

Prerequisites

Authorized access to a Confluent Cloud cluster on Amazon Web Services (AWS), Microsoft Azure (Azure), or Google Cloud.
The Confluent CLI installed and configured for the cluster. See Install the Confluent CLI.
A Dynamics 365 (Dataverse) environment URL, for example, https://myorg.crm.dynamics.com.
A Microsoft Entra ID app registration configured for the OAuth 2.0 client credentials grant. An app registration alone does not grant access to Dynamics 365 data, so also create an application user linked to that client ID, with a security role that grants organization-level read access to the entities you plan to ingest. For details, see Microsoft’s guides on server-to-server authentication, managing application users, and security roles and privileges.
For networking considerations, see Networking and DNS. To use a set of public egress IP addresses, see Public Egress IP Addresses for Confluent Cloud Connectors.

Kafka cluster credentials. The following lists the different ways you can provide credentials.
- Enter an existing service account resource ID.
- Create a Confluent Cloud service account for the connector. Make sure to review the ACL entries required in the service account documentation. Some connectors have specific ACL requirements.
- Create a Confluent Cloud API key and secret. To create a key and secret, you can use confluent api-key create or you can autogenerate the API key and secret directly in the Cloud Console when setting up the connector.

Using the Confluent Cloud Console

Step 1: Launch your Confluent Cloud cluster

To create and launch a Kafka cluster in Confluent Cloud, see Create a kafka cluster in Confluent Cloud.

Step 2: Add a connector

In the left navigation menu, click Connectors. If you already have connectors in your cluster, click + Add connector.

Step 3: Select your connector

Click the Microsoft Dynamics 365 CRM Source connector card.

Step 4: Enter the connector details

Configure the connector using the Confluent Cloud Console.

Note

Ensure you have all your prerequisites completed.
An asterisk ( * ) designates a required entry.

At the Add Microsoft Dynamics 365 CRM Source Connector screen, complete the following:

Kafka credentials

Select the way you want to provide Kafka Cluster credentials. You can choose one of the following options:
- My account: This setting allows your connector to globally access everything that you have access to. With a user account, the connector uses an API key and secret to access the Kafka cluster. This option is not recommended for production.
- Service account: This setting limits the access for your connector by using a service account. This option is recommended for production.
- Use an existing API key: This setting allows you to specify an API key and a secret pair. You can use an existing pair or create a new one. This method is not recommended for production environments.
Note

Freight clusters support only service accounts for Kafka authentication.
Click Continue.

Authentication

Configure the authentication properties:

Authentication
- Dataverse Environment URL: The URL of the Dynamics 365 (Dataverse) environment to read data from. For example, https://myorg.crm.dynamics.com. Find it in the Power Platform admin center under Environments.
- OAuth2 Token URL: The Microsoft Entra ID endpoint for fetching the OAuth2 token. For example, https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/token. To register the app and find its token endpoint, see Microsoft’s app registration quickstart. The supported grant type is client_credentials.
- OAuth2 Client ID: The application (client) ID of the Microsoft Entra app registration used by the connector, displayed on the Overview page as a GUID. Link the app registration to a Dynamics 365 Application User with read access to the selected entities. For details, see Microsoft’s guide on server-to-server authentication.
- OAuth2 Client Secret: The client secret of the Microsoft Entra app registration. Use the secret Value from Certificates & secrets, not the Secret ID, and copy it when created because it is shown only once. Client secrets expire, so the connector fails to authenticate after the secret lapses.
Click Continue.

Configuration

Configure the entities to ingest and the output record format.

Note

Only the JSON output record value format is currently supported. Schema Registry is not required.

Output messages

Select output record value format: The output Kafka record value format. Only JSON is supported. If Dynamics 365 adds a column after the connector starts, the connector picks it up automatically.

Entities

Number of entities: The number of Dynamics 365 entities to fetch data from.
Topic prefix: Prefix added to the start of every topic name. The topic name is {prefix}{entity} with nothing in between, so prefix crm and entity accounts give the topic crmaccounts.

Entity - 1 configurations

Entity: The Dataverse entity-set name to read, for example, accounts or contacts. Select CUSTOM to enter the entity-set name of a custom entity.
Custom Entity: The entity-set name of a custom Dataverse entity, for example cr2bf_mytables. Only used when the Entity field is set to CUSTOM.
Change Tracking Enabled: Enable this only if change tracking is already turned on for this table in Dynamics 365. When enabled, the connector captures deletes. When disabled, the connector does not capture deletes.

Show advanced configurations

Reporter Error Topic Name: The name of the topic to produce errant records after each unsuccessful API operation. Defaults to error-${connector} if not set. You can provide ${connector} in the value to use it as a placeholder for the logical cluster ID.
Schema context: Select a schema context to use for this connector, if using a schema-based data format. This property defaults to the Default context, which configures the connector to use the default schema set up for Schema Registry in your Confluent Cloud environment. A schema context allows you to use separate schemas (like schema sub-registries) tied to topics in different Kafka clusters that share the same Schema Registry environment. For example, if you select a non-default context, a Source connector uses only that schema context to register a schema and a Sink connector uses only that schema context to read from. For more information about setting up a schema context, see What are schema contexts and when should you use them?.

Polling configurations

Poll Interval (ms): How often, in milliseconds, the connector polls Dynamics 365 for new or changed records. Applies to every entity. Lower values mean fresher data but more requests against Dynamics 365 service protection limits.
Page Size: The number of records the connector requests per API call, applied to every entity. Valid range is 1 to 5000. Dynamics 365 silently caps anything higher at 5000.

Retry configurations

Maximum Retries: The maximum number of times a failed API request is retried before the task fails. Higher values help the connector ride out longer periods of Dynamics 365 rate limiting.

Additional Configs

Value Converter Replace Null With Default: Specifies whether to replace fields that have a default value and that are null to the default value. When set to true, the connector uses the default value; otherwise, it uses null. Applies to the JSON converter.
Value Converter Reference Subject Name Strategy: Sets the subject reference name strategy for values. Valid entries are DefaultReferenceSubjectNameStrategy or QualifiedReferenceSubjectNameStrategy. You can use this strategy only with PROTOBUF format; the default strategy is DefaultReferenceSubjectNameStrategy.
Value Converter Schemas Enable: Includes schema within each of the serialized values. Input messages must contain schema and payload fields and must not contain additional fields. For plain JSON data, set this to false. Applies to the JSON converter.
Errors Tolerance: Use this property to configure the connector’s error handling behavior.

Warning

Use this property with caution for sink connectors, as it can lead to data loss. If you set this property to all, the connector does not fail on errant records, but logs them (and sends to DLQ for sink connectors) and continues processing. If you set this property to none, the connector task fails on errant records.
Value Converter Ignore Default For Nullables: When set to true, this property ensures that the corresponding record in Kafka is null, instead of showing the default column value. Applies to the AVRO, PROTOBUF, and JSON_SR converters.
Value Converter Decimal Format: Specifies the JSON or JSON_SR serialization format for Connect DECIMAL logical type values with two allowed literals: BASE64 to serialize DECIMAL logical types as base64 encoded binary data, and NUMERIC to serialize DECIMAL logical type values in JSON or JSON_SR as a number representing the decimal value.
Key Converter Schema ID Serializer: The class name of the schema ID serializer for keys. This is used to serialize schema IDs in the message headers.
Value Converter Connect Meta Data: Enables the Connect converter to add its metadata to the output schema. Applies to Avro converters.
Value Converter Value Subject Name Strategy: Determines how to construct the subject name under which the value schema is registered with Schema Registry.
Key Converter Key Subject Name Strategy: Determines how to construct the subject name for key schema registration.
Value Converter Schema ID Serializer: The class name of the schema ID serializer for values. This is used to serialize schema IDs in the message headers.

Auto-restart policy

Enable Connector Auto-restart: Enables the auto-restart behavior of the connector and its task in the event of user-actionable errors. Defaults to true, enabling the connector to automatically restart in case of user-actionable errors. Set this property to false to disable auto-restart for failed connectors. If disabled, you must manually restart the connector.

Transforms

Single Message Transformations: To add a new SMT, see Add transforms. For more information about unsupported SMTs, see Unsupported transformations.

Processing position

Set offsets: Click Set offsets to define a specific offset for this connector to begin procession data from. For more information on managing offsets, see Manage offsets.

For all property values and definitions, see Configuration Properties.

Click Continue.

Sizing

Based on the number of entities you configured, you will be provided with a recommended number of tasks.

To change the number of recommended tasks, enter the number of tasks for the connector to use in the Tasks field.
Click Continue.

Review and Launch

Verify the connection details.
Click Launch.

The status for the connector should go from Provisioning to Running.

Step 5: Check the Kafka topic

Verify that the connector is producing Dynamics 365 records to the topics named {prefix}{entity}, for example crmaccounts.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect Usage Examples section.

Using the Confluent CLI

Complete the following steps to set up and run the connector using the Confluent CLI.

Note

Make sure you have all your prerequisites completed.

Step 1: List the available connectors

Enter the following command to list available connectors:

confluent connect plugin list

Step 2: List the connector configuration properties

Enter the following command to show the connector configuration properties:

confluent connect plugin describe <connector-plugin-name>

The command output shows the required and optional configuration properties.

Step 3: Create the connector configuration file

Create a JSON file that contains the connector configuration properties. The following example shows required and optional connector properties.

{
  "name": "MicrosoftDynamics365CRMSource_0",
  "config": {
    "connector.class": "MicrosoftDynamics365CRMSource",
    "name": "MicrosoftDynamics365CRMSource_0",
    "kafka.auth.mode": "KAFKA_API_KEY",
    "kafka.api.key": "<my-kafka-api-key>",
    "kafka.api.secret": "<my-kafka-api-secret>",
    "dynamics365.url": "https://myorg.crm.dynamics.com",
    "oauth2.token.url": "https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token",
    "oauth2.client.id": "<my-oauth2-client-id>",
    "oauth2.client.secret": "<my-oauth2-client-secret>",
    "output.data.format": "JSON",
    "dynamics365.topic.prefix": "crm",
    "entities.num": "2",
    "entity1.name": "accounts",
    "entity1.change.tracking.enabled": "true",
    "entity2.name": "CUSTOM",
    "entity2.custom.name": "cr2bf_mytables",
    "entity2.change.tracking.enabled": "false",
    "poll.interval.ms": "1000",
    "page.size": "2500",
    "max.retries": "5",
    "tasks.max": "2"
  }
}

Note the following property definitions:

"name": Sets a name for your new connector.
"connector.class": Identifies the connector plugin name.
"dynamics365.url": The URL of the Dynamics 365 (Dataverse) environment to read data from.
"oauth2.token.url", "oauth2.client.id", and "oauth2.client.secret": The Microsoft Entra ID OAuth 2.0 client credentials used to authenticate to Dataverse.

"kafka.auth.mode": Identifies the connector authentication mode you want to use. There are two options: SERVICE_ACCOUNT or KAFKA_API_KEY (the default). To use an API key and secret, specify the configuration properties kafka.api.key and kafka.api.secret, as shown in the example configuration (above). To use a service account, specify the Resource ID in the property kafka.service.account.id=<service-account-resource-ID>. To list the available service account resource IDs, use the following command:
```
confluent iam service-account list
```
For example:
```
confluent iam service-account list

   Id     | Resource ID |       Name        |    Description
+---------+-------------+-------------------+-------------------
   123456 | sa-l1r23m   | sa-1              | Service account 1
   789101 | sa-l4d56p   | sa-2              | Service account 2
```

"output.data.format": Sets the output Kafka record value format. Only JSON is currently supported.
"entities.num": The number of Dynamics 365 entities to fetch data from, up to five.
"entity<N>.name": The entity-set name to read for each entity, for example entity1.name and entity2.name. To read a custom table, set this to CUSTOM and set entity<N>.custom.name to the custom table’s entity-set name.
"entity<N>.change.tracking.enabled": Whether to read the entity using Dynamics 365 change tracking. Defaults to true. Change tracking must already be enabled for that table in Dynamics 365, or the connector fails validation. When set to false, the connector reads the entity using the versionnumber column and does not capture deletes.
"dynamics365.topic.prefix": Prefix added to the start of every topic name.
poll.interval.ms: How often, in milliseconds, the connector polls Dynamics 365 for new or changed records. Applies to every entity.
page.size: The number of records the connector requests per API call, applied to every entity. Reduce this value for entities with large records.
max.retries: The maximum number of times a failed API request is retried before the task fails.
"tasks.max": Maximum tasks for the connector to use. The connector distributes the configured entities across its tasks, so the number of entities caps parallelism. Setting more tasks than entities has no effect, because the extra tasks get no entity to read.

See Configuration Properties for all property values and descriptions.

Step 4: Load the configuration file and create the connector

Enter the following command to load the configuration and start the connector:

confluent connect cluster create --config-file <file-name>.json

For example:

confluent connect cluster create --config-file dynamics-365-crm-source-config.json

Example output:

Created connector MicrosoftDynamics365CRMSource_0 lcc-ix4dl

Step 5: Check the connector status

Enter the following command to check the connector status:

confluent connect cluster list

Example output:

ID          |               Name                     | Status  | Type
+-----------+----------------------------------------+---------+--------+
lcc-ix4dl   | MicrosoftDynamics365CRMSource_0        | RUNNING | source

Step 6: Check the Kafka topic

Verify that the connector is producing Dynamics 365 records to the topics named {prefix}{entity}, for example crmaccounts.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect Usage Examples section.

Configuration Properties

Use the following configuration properties with the fully managed connector. For self-managed connector property definitions and other details, see the connector docs in Self-managed connectors for Confluent Platform.

How should we connect to your data?

name

Sets a name for your connector.

Type: string
Valid Values: A string at most 64 characters long
Importance: high

Kafka Cluster credentials

kafka.auth.mode

Kafka Authentication mode. It can be one of KAFKA_API_KEY or SERVICE_ACCOUNT. It defaults to KAFKA_API_KEY mode, whenever possible.

Type: string
Valid Values: SERVICE_ACCOUNT, KAFKA_API_KEY
Importance: high

kafka.api.key

Kafka API Key. Required when kafka.auth.mode==KAFKA_API_KEY.

Type: password
Importance: high

kafka.service.account.id

The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.

Type: string
Importance: high

kafka.api.secret

Secret associated with Kafka API key. Required when kafka.auth.mode==KAFKA_API_KEY.

Type: password
Importance: high

Schema Config

schema.context.name

Add a schema context name. A schema context represents an independent scope in Schema Registry. It is a separate sub-schema tied to topics in different Kafka clusters that share the same Schema Registry instance. If not used, the connector uses the default schema configured for Schema Registry in your Confluent Cloud environment.

Type: string
Default: default
Importance: medium

Output messages

output.data.format

Output Kafka record value format. Only JSON is supported. If Dynamics 365 adds a column after the connector starts, the connector picks it up automatically.

Type: string
Default: JSON
Importance: high

Number of tasks for this connector

tasks.max

Maximum number of tasks for the connector.

Type: int
Valid Values: [1,…]
Importance: high

Authentication

dynamics365.url

The URL of the Dynamics 365 (Dataverse) environment to read data from. For example: https://myorg.crm.dynamics.com. Find it in the [Power Platform admin center](https://admin.powerplatform.microsoft.com/environments) under Environments.

Type: string
Valid Values: Must match the regex https://[^/\s]+\.dynamics\.com
Importance: high

oauth2.token.url

The Microsoft Entra ID endpoint for fetching the OAuth2 token. For example: https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/token. To register the app and find its token endpoint, see Microsoft’s [app registration quickstart](https://learn.microsoft.com/entra/identity-platform/quickstart-register-app). Supported grant type is client_credentials.

Type: string
Valid Values: Must match the regex https://login\.microsoftonline\.com/[^/\s]+/oauth2/v2\.0/token
Importance: high

oauth2.client.id

The application (client) ID of the Microsoft Entra app registration used by the connector, displayed on the Overview page as a GUID. Link the app registration to a Dynamics 365 Application User with read access to the selected entities. For details, see Microsoft’s guide on [server-to-server authentication](https://learn.microsoft.com/power-apps/developer/data-platform/use-single-tenant-server-server-authentication).

Type: string
Importance: high

oauth2.client.secret

The client secret of the Microsoft Entra app registration. Use the secret Value from Certificates & secrets, not the Secret ID, and copy it when created because it is shown only once. Client secrets expire, so the connector fails to authenticate after the secret lapses.

Type: password
Importance: high

Entities

entities.num

The number of Dynamics 365 entities to fetch data from.

Type: int
Default: 1
Valid Values: [1,…,5]
Importance: high

dynamics365.topic.prefix

Prefix added to the start of every topic name. The topic name is {prefix}{entity} with nothing in between, so prefix crm and entity accounts give the topic crmaccounts.

Type: string
Valid Values: Must match the regex ^[a-zA-Z0-9._-]+$ and A string at most 200 characters long
Importance: high

Polling configurations

poll.interval.ms

How often, in milliseconds, the connector polls Dynamics 365 for new or changed records. Applies to every entity. Lower values mean fresher data but more requests against Dynamics 365 service protection limits.

Type: int
Default: 10000 (10 seconds)
Valid Values: [100,…]
Importance: medium

page.size

The number of records the connector requests per API call, applied to every entity. Valid range is 1 to 5000 — Dynamics 365 silently caps anything higher at 5000.

Type: int
Default: 5000
Valid Values: [1,…,5000]
Importance: medium

Retry configurations

max.retries

The maximum number of times a failed API request is retried before the task fails. Higher values help the connector ride out longer periods of Dynamics 365 rate limiting.

Type: int
Default: 5
Valid Values: [1,…,5]
Importance: medium

Reporter

reporter.error.topic.name

The name of the topic to produce errant records after each unsuccessful API operation. Defaults to ‘error-${connector}’ if not set. You can provide ${connector} in the value to use it as a placeholder for the logical cluster ID.

Type: string
Default: error-${connector}
Importance: low

Additional Configs

header.converter

The converter class for the headers. This is used to serialize and deserialize the headers of the messages.

Type: string
Importance: low

producer.override.compression.type

The compression type for all data generated by the producer. Valid values are none, gzip, snappy, lz4, and zstd.

Type: string
Importance: low

producer.override.linger.ms

The producer groups together any records that arrive in between request transmissions into a single batched request. More details can be found in the documentation: https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html#linger-ms.

Type: long
Valid Values: [100,…,1000]
Importance: low

value.converter.allow.optional.map.keys

Allow optional string map key when converting from Connect Schema to Avro Schema. Applicable for Avro Converters.

Type: boolean
Importance: low

value.converter.auto.register.schemas

Specify if the Serializer should attempt to register the Schema.

Type: boolean
Importance: low

value.converter.connect.meta.data

Allow the Connect converter to add its metadata to the output schema. Applicable for Avro Converters.

Type: boolean
Importance: low

value.converter.enhanced.avro.schema.support

Enable enhanced schema support to preserve package information and Enums. Applicable for Avro Converters.

Type: boolean
Importance: low

value.converter.enhanced.protobuf.schema.support

Enable enhanced schema support to preserve package information. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.flatten.unions

Whether to flatten unions (oneofs). Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.generate.index.for.unions

Whether to generate an index suffix for unions. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.generate.struct.for.nulls

Whether to generate a struct variable for null values. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.int.for.enums

Whether to represent enums as integers. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.latest.compatibility.strict

Verify latest subject version is backward compatible when use.latest.version is true.

Type: boolean
Importance: low

value.converter.object.additional.properties

Whether to allow additional properties for object schemas. Applicable for JSON_SR Converters.

Type: boolean
Importance: low

value.converter.optional.for.nullables

Whether nullable fields should be specified with an optional label. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.optional.for.proto2

Whether proto2 optionals are supported. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.scrub.invalid.names

Whether to scrub invalid names by replacing invalid characters with valid characters. Applicable for Avro and Protobuf Converters.

Type: boolean
Importance: low

value.converter.use.latest.version

Use latest version of schema in subject for serialization when auto.register.schemas is false.

Type: boolean
Importance: low

value.converter.use.optional.for.nonrequired

Whether to set non-required properties to be optional. Applicable for JSON_SR Converters.

Type: boolean
Importance: low

value.converter.wrapper.for.nullables

Whether nullable fields should use primitive wrapper messages. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.wrapper.for.raw.primitives

Whether a wrapper message should be interpreted as a raw primitive at root level. Applicable for Protobuf Converters.

Type: boolean
Importance: low

errors.tolerance

Use this property if you would like to configure the connector’s error handling behavior. WARNING: This property should be used with CAUTION for SOURCE CONNECTORS as it may lead to dataloss. If you set this property to ‘all’, the connector will not fail on errant records, but will instead log them (and send to DLQ for Sink Connectors) and continue processing. If you set this property to ‘none’, the connector task will fail on errant records.

Type: string
Default: none
Importance: low

key.converter.key.schema.id.serializer

The class name of the schema ID serializer for keys. This is used to serialize schema IDs in the message headers.

Type: string
Default: io.confluent.kafka.serializers.schema.id.PrefixSchemaIdSerializer
Importance: low

key.converter.key.subject.name.strategy

How to construct the subject name for key schema registration.

Type: string
Default: TopicNameStrategy
Importance: low

value.converter.decimal.format

Specify the JSON/JSON_SR serialization format for Connect DECIMAL logical type values with two allowed literals:

BASE64 to serialize DECIMAL logical types as base64 encoded binary data and

NUMERIC to serialize Connect DECIMAL logical type values in JSON/JSON_SR as a number representing the decimal value.

Type: string
Default: BASE64
Importance: low

value.converter.flatten.singleton.unions

Whether to flatten singleton unions. Applicable for Avro and JSON_SR Converters.

Type: boolean
Default: false
Importance: low

value.converter.ignore.default.for.nullables

When set to true, this property ensures that the corresponding record in Kafka is NULL, instead of showing the default column value. Applicable for AVRO,PROTOBUF and JSON_SR Converters.

Type: boolean
Default: false
Importance: low

value.converter.reference.subject.name.strategy

Set the subject reference name strategy for value. Valid entries are DefaultReferenceSubjectNameStrategy or QualifiedReferenceSubjectNameStrategy. Note that the subject reference name strategy can be selected only for PROTOBUF format with the default strategy being DefaultReferenceSubjectNameStrategy.

Type: string
Default: DefaultReferenceSubjectNameStrategy
Importance: low

value.converter.replace.null.with.default

Whether to replace fields that have a default value and that are null to the default value. When set to true, the default value is used, otherwise null is used. Applicable for JSON Converter.

Type: boolean
Default: true
Importance: low

value.converter.schemas.enable

Include schemas within each of the serialized values. Input messages must contain schema and payload fields and may not contain additional fields. For plain JSON data, set this to false. Applicable for JSON Converter.

Type: boolean
Default: false
Importance: low

value.converter.value.schema.id.serializer

The class name of the schema ID serializer for values. This is used to serialize schema IDs in the message headers.

Type: string
Default: io.confluent.kafka.serializers.schema.id.PrefixSchemaIdSerializer
Importance: low

value.converter.value.subject.name.strategy

Determines how to construct the subject name under which the value schema is registered with Schema Registry.

Type: string
Default: TopicNameStrategy
Importance: low

Entity - 1 configurations

entity1.name

The Dataverse entity-set name to read, for example accounts or contacts. Select CUSTOM to enter the entity-set name of a custom entity.

Type: string
Default: “”
Importance: high

entity1.custom.name

The entity-set name of a custom Dataverse entity, for example cr2bf_mytables. Only used when the Entity field is set to CUSTOM.

Type: string
Default: “”
Valid Values: Must match the regex ^[a-z0-9_]*$
Importance: medium

entity1.change.tracking.enabled

Enable this only if change tracking is already turned on for this table in Dynamics 365. When off, deletes are not captured.

Type: boolean
Default: true
Importance: medium

Auto-restart policy

auto.restart.on.user.error

Enable connector to automatically restart on user-actionable errors.

Type: boolean
Default: true
Importance: medium

Next Steps

For an example that shows fully managed Confluent Cloud connectors in action with Confluent Cloud for Apache Flink, see the Cloud ETL Demo. This example also shows how to use Confluent CLI to manage your resources in Confluent Cloud.