Establishing a Connection

Adding a Connection to Microsoft Dataverse

To add a connection to Microsoft Dataverse:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the Microsoft Dataverse icon is not available, click the Add More icon to download and install the Microsoft Dataverse connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Schema

Microsoft Dataverse supports two values for the Schema property, System and Entities.

System: uses the Web API to query entities and tables directly.
Entities: uses the EntityDefinitions entity set path to retrieve metadata about EntityMetadata entities and tables. This typically provides more user-friendly names, but requires additional metadata requests.

Connecting to Microsoft Dataverse

To authenticate to the Microsoft Dataverse source, begin by setting the OrganizationURL property to the URL of the organization you are connecting to.

For example: https://[organization].crm.dynamics.com.

Entra ID (Azure AD)

Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".

The Sync App supports authentication to Microsoft Dataverse through OAuth 2.0, using Entra ID. The specific OAuth behavior depends on the value of the AuthScheme connection property, which determines the authentication flow used.

The following table outlines the relationship between AuthScheme, OAuth grant types, and typical use cases:


AuthScheme	OAuth Grant Type	Use Case
`AzureAD`	Authorization Code	User login with browser interaction (desktop/web), or on a separate device in headless environments
`AzureServicePrincipal`	Client Credentials	Application-only access using client secret
`AzureServicePrincipalCert`	Client Credentials	Application-only access using certificate-based authentication
`AzureMSI`	Managed Identity	Azure-hosted apps/services using Azure's Managed Identity

Client Credentials

Client credentials refers to a flow in OAuth where there is no direct user authentication taking place. Instead, credentials are created for just the app itself. All tasks taken by the application are done without a default user context. This makes the authentication flow a bit different from standard.

Client OAuth Flow

All permissions related to the client oauth flow require admin consent. This means the app embedded with the CData Sync App cannot be used in the client oauth flow. You must create your own OAuth app in order to use client credentials. See Creating an Entra ID (Azure AD) Application for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions - Delegated and Application permissions. The permissions used during client credential authentication are under Application Permissions. Select the applicable permissions you require for your integration.

You are ready to connect after setting one of the below connection properties groups depending on the authentication type.

Client Secret
- AuthScheme Set this to AzureServicePrincipal.
- InitiateOAuth: Set this to GETANDREFRESH. You can cuse InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- AzureTenant: Set this to the tenant you wish to connet to.
- OAuthClientId: Set this to the Client Id in your app settings.
- OAuthClientSecret: Set this to the Client Secret in your app settings.
Certificate
- AuthScheme Set this to AzureServicePrincipalCert.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- AzureTenant: Set this to the tenant you wish to connect to.
- OAuthClientId: Set this to the Client Id in your app settings.
- OAuthJWTCert: Set this to the JWT Certificate store.
- OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.

Authentication with client credentials will take place automatically like any other connection, except there will be no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections will take place and be handled internally.

Azure Service Principal

Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For information about how to set up Azure Service Principal authentication, see Creating a Service Principal App in Entra ID (AzureAD).

Managed Service Identity (MSI)

If you are running Microsoft Dataverse on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials to connect, set AuthScheme to AzureMSI.

User-Managed Identities

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's client_id.

If your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.

Advanced Features

This section details a selection of advanced features of the Microsoft Dataverse Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Microsoft Dataverse and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Sync App models Microsoft Dataverse data as an easy-to-use SQL database with tables, views, and stored procedures. The definitions are dynamically obtained from the Microsoft Dataverse OData service you connect to. You can load changes to the metadata, such as new or removed columns, or changes in data type, by reconnecting to the service.

The Sync App exposes two data models:

The Entities Data Model describes the schemas available to connect to Microsoft Dataverse. You can use tables to work with live Microsoft Dataverse data.
The System Data Model defines the underlying framework that supports core platform functionality, including security, auditing, and system-level operations.

You can use the stored procedures provided by CData Sync App to automate working with Microsoft Dataverse data.

Entities Data Model

The Entities Data Model defines, stores, and manages structured data within business applications. It enables data relationships, security, automation, and integration with Microsoft Power Platform, Dynamics 365, and external systems.

Views

The Views section, which lists read-only SQL tables, contain samples of what you may have access to in your Microsoft Dataverse account.

The following views are shipped with the Sync App:


Table	Description
MultiSelectPickListAttributeMetaData	Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.
MultiSelectPickListOptions	Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.
PickListAttributeMetaData	Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.
PickListOptions	Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.
StateAttributeMetadata	Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.
StateAttributeOptions	Lists the selectable states available for State attributes, representing various predefined states.
StatusAttributeMetadata	Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.
StatusAttributeOptions	Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including retrieving and refreshing the OAuth Access Token.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Microsoft Dataverse Connector for CData Sync Views


Name	Description
MultiSelectPickListAttributeMetaData	Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.
MultiSelectPickListOptions	Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.
PickListAttributeMetaData	Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.
PickListOptions	Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.
StateAttributeMetadata	Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.
StateAttributeOptions	Lists the selectable states available for State attributes, representing various predefined states.
StatusAttributeMetadata	Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.
StatusAttributeOptions	Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

MultiSelectPickListAttributeMetaData

Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.

View-Specific Information

Select

The Sync App will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

TableName supports '=','IN' operators.

Note that without filtering on TableName, the Sync App returns the results for the first table found.

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')

Columns


Name	Type	References	Description
ColumnName [KEY]	String		The name of the column in the table where the multi-select picklist is defined.
MetadataId	String		The unique identifier for the metadata associated with this attribute.
OptionSet_Description_LocalizedLabels	String		Localized descriptions of the options in the picklist for different languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String		Indicates whether the user-localized description label has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-localized description label is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label	String		The localized label text for the option set description.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the localized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the localized description label.
OptionSet_DisplayName_LocalizedLabels	String		Localized display names of the picklist options for different languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String		Indicates whether the user-localized display name label has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-localized display name label is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label	String		The localized label text for the option set display name.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the localized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the localized display name label.
OptionSet_ExternalTypeName	String		The external type name associated with the option set, if applicable.
OptionSet_HasChanged	String		Indicates if the option set has been modified.
OptionSet_IntroducedVersion	String		The version of the system in which the option set was introduced.
OptionSet_IsCustomizable_CanBeChanged	Boolean		Indicates whether the option set can be customized.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String		The logical name of the managed property that controls the customizability of the option set.
OptionSet_IsCustomizable_Value	Boolean		Specifies if the option set is customizable.
OptionSet_IsCustomOptionSet	Boolean		Indicates whether the option set is custom or part of a managed solution.
OptionSet_IsGlobal	Boolean		Specifies if the option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged	Boolean		Indicates if the option set is managed (part of a managed solution).
OptionSet_MetadataId	String		The unique identifier for the metadata associated with the option set.
OptionSet_Name	String		The name of the option set.
OptionSet_OptionSetType	String		The type of the option set (e.g., picklist, multi-select).
OptionSet_ParentOptionSetName	String		The name of the parent option set, if this option set is part of a hierarchy.
TableName	String		The name of the table where this multi-select picklist attribute is defined.

MultiSelectPickListOptions

Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.

View-Specific Information

Select

The Sync App will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

TableName supports '=','IN' operators.

Note that without filtering on TableName, the Sync App returns the results for the first table found.

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'

SELECT * FROM MultiSelectPickListOptions WHERE TableName IN ('accounts', 'teams')

Columns


Name	Type	References	Description
ColumnName	String	MultiSelectPickListAttributeMetaData.ColumnName	The name of the column in the table where the multi-select picklist option is defined.
Color	String		The color code associated with the picklist option, often used for UI display purposes.
ExternalValue	String		An external system value mapped to this picklist option, if applicable.
HasChanged	String		Indicates whether the option has been modified since its creation or last update.
IsManaged	Boolean		Specifies if the picklist option is managed (part of a managed solution).
Label_LocalizedLabels	String		Localized labels for the picklist option in different languages.
Label_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized label for the picklist option has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized label for the picklist option is managed.
Label_UserLocalizedLabel_Label	String		The user-customized label text for the picklist option.
Label_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized label.
Description_LocalizedLabels	String		Localized descriptions for the picklist option in different languages.
Description_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized description for the picklist option has been modified.
Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized description for the picklist option is managed.
Description_UserLocalizedLabel_Label	String		The user-customized description text for the picklist option.
Description_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized description.
Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized description.
MetadataId	String		The unique identifier for the metadata associated with the picklist option.
ParentValues	String		Specifies the parent values for hierarchical picklist options, if applicable.
Value	Integer		The integer value associated with this picklist option, used for storage and retrieval.
TableName	String		The name of the table where this picklist option is defined.

PickListAttributeMetaData

Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.

View-Specific Information

Select

The Sync App will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

TableName supports '=','IN' operators.

Note that without filtering on TableName, the Sync App returns the results for the first table found.

For example, the following queries are processed server side:

SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'

SELECT * FROM PickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')

Columns


Name	Type	References	Description
ColumnName [KEY]	String		The name of the column in the table where the picklist attribute is defined.
MetadataId	String		The unique identifier for the metadata associated with this attribute.
OptionSet_Description_LocalizedLabels	String		Localized descriptions of the options in the picklist for various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized description label has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized description label is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label	String		The localized label text for the description of the picklist.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-localized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-localized description label.
OptionSet_DisplayName_LocalizedLabels	String		Localized display names for the picklist options in various languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized display name label has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized display name label is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label	String		The localized label text for the display name of the picklist.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-localized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-localized display name label.
OptionSet_ExternalTypeName	String		The external type name associated with the option set, if applicable.
OptionSet_HasChanged	String		Indicates if the option set has been modified since its creation or last update.
OptionSet_IntroducedVersion	String		The version of the system in which the option set was introduced.
OptionSet_IsCustomizable_CanBeChanged	Boolean		Indicates whether the option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String		The logical name of the managed property controlling customizability of the option set.
OptionSet_IsCustomizable_Value	Boolean		Specifies if the option set is customizable.
OptionSet_IsCustomOptionSet	Boolean		Indicates whether the option set is custom or part of a default configuration.
OptionSet_IsGlobal	Boolean		Specifies if the option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged	Boolean		Indicates if the option set is managed (part of a managed solution).
OptionSet_MetadataId	String		The unique identifier for the metadata associated with the option set.
OptionSet_Name	String		The name of the option set.
OptionSet_OptionSetType	String		The type of the option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName	String		The name of the parent option set, if this option set is part of a hierarchy.
TableName	String		The name of the table where the picklist attribute is defined.

PickListOptions

Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.

View-Specific Information

Select

The Sync App will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

TableName supports '=','IN' operators.

Note that without filtering on TableName, the Sync App returns the results for the first table found.

For example, the following queries are processed server side:

SELECT * FROM PickListOptions WHERE TableName = 'teams'

SELECT * FROM PickListOptions WHERE TableName IN ('accounts', 'teams')

Columns


Name	Type	References	Description
ColumnName	String	PickListAttributeMetaData.ColumnName	The name of the column in the table where the picklist option is defined.
Color	String		The color code associated with the picklist option, often used for display purposes in user interfaces.
ExternalValue	String		An external value associated with this picklist option, used for integration with external systems.
HasChanged	String		Indicates whether the picklist option has been modified since its creation or last update.
IsManaged	Boolean		Specifies if the picklist option is managed (part of a managed solution).
Label_LocalizedLabels	String		Localized labels for the picklist option in multiple languages.
Label_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized label for the picklist option has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized label for the picklist option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label	String		The user-customized label text for the picklist option.
Label_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels	String		Localized descriptions for the picklist option in various supported languages.
Description_UserLocalizedLabel	String		The user-customized description for the picklist option, providing additional context or meaning.
MetadataId	String		The unique identifier for the metadata associated with this picklist option.
ParentValues	String		Specifies the parent values for hierarchical picklist options, if applicable.
Value	Integer		The integer value associated with this picklist option, used for storage and retrieval.
TableName	String		The name of the table where this picklist option is defined.

StateAttributeMetadata

Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.

View-Specific Information

Select

Note that without filtering on TableName, the Sync App returns the results for the first table found.

The following examples show how to query the view for a specific table or list of tables:

SELECT * FROM StateAttributeMetaData WHERE TableName='AccountLeads'

SELECT * FROM StateAttributeMetaData WHERE TableName IN ('Account','AccountLead');

Columns


Name	Type	References	Description
ColumnName [KEY]	String		The name of the column in the table where the state attribute is defined.
MetadataId	String		The unique identifier for the metadata associated with this state attribute.
OptionSet_Description_LocalizedLabels	String		Localized descriptions for the state options in various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized description label for the state options has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized description label for the state options is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label	String		The user-customized label text for the description of the state options.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-customized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized description label.
OptionSet_DisplayName_LocalizedLabels	String		Localized display names for the state options in various supported languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized display name label for the state options has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized display name label for the state options is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label	String		The user-customized label text for the display name of the state options.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-customized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized display name label.
OptionSet_ExternalTypeName	String		The external type name associated with the state options, if applicable.
OptionSet_HasChanged	String		Indicates whether the state option set has been modified since its creation or last update.
OptionSet_IntroducedVersion	String		The version of the system in which the state option set was introduced.
OptionSet_IsCustomizable_CanBeChanged	Boolean		Indicates whether the state option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String		The logical name of the managed property controlling the customizability of the state option set.
OptionSet_IsCustomizable_Value	Boolean		Specifies if the state option set is customizable.
OptionSet_IsCustomOptionSet	Boolean		Indicates whether the state option set is custom or part of a default configuration.
OptionSet_IsGlobal	Boolean		Specifies if the state option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged	Boolean		Indicates if the state option set is managed (part of a managed solution).
OptionSet_MetadataId	String		The unique identifier for the metadata associated with the state option set.
OptionSet_Name	String		The name of the state option set.
OptionSet_OptionSetType	String		The type of the state option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName	String		The name of the parent option set, if this state option set is part of a hierarchy.
TableName	String		The name of the table where this state attribute is defined.

StateAttributeOptions

Lists the selectable states available for State attributes, representing various predefined states.

View-Specific Information

Select

Note that without filtering on TableName, the Sync App returns the results for the first table found.

The following examples show how to query the view for a specific table or list of tables:

SELECT * FROM StateAttributeOptions WHERE TableName='AccountLeads'

SELECT * FROM StateAttributeOptions WHERE TableName IN ('Account','AccountLead');

Columns


Name	Type	References	Description
ColumnName	String	StateAttributeMetadata.ColumnName	The name of the column in the table where the state option is defined.
Color	String		The color code associated with the state option, often used for UI representation.
ExternalValue	String		An external system value mapped to this state option, if applicable.
HasChanged	String		Indicates whether the state option has been modified since its creation or last update.
IsManaged	Boolean		Specifies if the state option is managed (part of a managed solution).
Label_LocalizedLabels	String		Localized labels for the state option in various supported languages.
Label_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized label for the state option has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized label for the state option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label	String		The user-customized label text for the state option.
Label_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels	String		Localized descriptions for the state option in various supported languages.
Description_UserLocalizedLabel	String		The user-customized description for the state option, providing additional context or details.
MetadataId	String		The unique identifier for the metadata associated with the state option.
ParentValues	String		Specifies the parent values for hierarchical state options, if applicable.
Value	Integer		The integer value associated with this state option, used for storage and retrieval.
TableName	String		The name of the table where this state option is defined.

StatusAttributeMetadata

Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.

View-Specific Information

Select

Note that without filtering on TableName, the Sync App returns the results for the first table found.

The following examples show how to query the view for a specific table or list of tables:

SELECT * FROM StatusAttributeMetaData WHERE TableName='AccountLeads'

SELECT * FROM StatusAttributeMetaData WHERE TableName IN ('Account','AccountLead');

Columns


Name	Type	References	Description
ColumnName [KEY]	String		The name of the column in the table where the status attribute is defined.
MetadataId	String		The unique identifier for the metadata associated with this status attribute.
OptionSet_Description_LocalizedLabels	String		Localized descriptions for the status options in various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized description label for the status options has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized description label for the status options is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label	String		The user-customized label text for the description of the status options.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-customized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized description label.
OptionSet_DisplayName_LocalizedLabels	String		Localized display names for the status options in various supported languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized display name label for the status options has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized display name label for the status options is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label	String		The user-customized label text for the display name of the status options.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-customized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized display name label.
OptionSet_ExternalTypeName	String		The external type name associated with the status options, if applicable.
OptionSet_HasChanged	String		Indicates whether the status option set has been modified since its creation or last update.
OptionSet_IntroducedVersion	String		The version of the system in which the status option set was introduced.
OptionSet_IsCustomizable_CanBeChanged	Boolean		Indicates whether the status option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String		The logical name of the managed property controlling the customizability of the status option set.
OptionSet_IsCustomizable_Value	Boolean		Specifies if the status option set is customizable.
OptionSet_IsCustomOptionSet	Boolean		Indicates whether the status option set is custom or part of a default configuration.
OptionSet_IsGlobal	Boolean		Specifies if the status option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged	Boolean		Indicates if the status option set is managed (part of a managed solution).
OptionSet_MetadataId	String		The unique identifier for the metadata associated with the status option set.
OptionSet_Name	String		The name of the status option set.
OptionSet_OptionSetType	String		The type of the status option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName	String		The name of the parent option set, if this status option set is part of a hierarchy.
TableName	String		The name of the table where this status attribute is defined.

StatusAttributeOptions

Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

View-Specific Information

Select

Note that without filtering on TableName, the Sync App returns the results for the first table found.

The following examples show how to query the view for a specific table or list of tables:

SELECT * FROM StatusAttributesOptions WHERE TableName='AccountLeads'

SELECT * FROM StatusAttributesOptions WHERE TableName IN ('Account','AccountLead');

Columns


Name	Type	References	Description
ColumnName	String	StatusAttributeMetadata.ColumnName	The name of the column in the table where the status option is defined.
Color	String		The color code associated with the status option, typically used for visual representation in user interfaces.
ExternalValue	String		An external system value mapped to this status option, if applicable.
HasChanged	String		Indicates whether the status option has been modified since its creation or last update.
IsManaged	Boolean		Specifies if the status option is managed (part of a managed solution).
Label_LocalizedLabels	String		Localized labels for the status option in various supported languages.
Label_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized label for the status option has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized label for the status option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label	String		The user-customized label text for the status option.
Label_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels	String		Localized descriptions for the status option in various supported languages.
Description_UserLocalizedLabel	String		The user-customized description for the status option, providing additional context or details.
MetadataId	String		The unique identifier for the metadata associated with the status option.
ParentValues	String		Specifies the parent values for hierarchical status options, if applicable.
Value	Integer		The integer value associated with this status option, used for storage and retrieval.
TableName	String		The name of the table where this status option is defined.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Dataverse.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Dataverse, along with an indication of whether the procedure succeeded or failed.

Microsoft Dataverse Connector for CData Sync Stored Procedures


Name	Description

CreateSchema

Produces a schema file outlining the structure of the specified table or view, supporting data analysis and integration.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The Sync App checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the Sync App.

Input


Name	Type	Required	Description
TableName	String	True	The name of the table or view for which the schema will be generated. Provide the exact name as it appears in Common Data Service.
FileName	String	False	The file name for the generated schema. The file will be generated in 'Location property' + 'Entities' + 'FileName'. For example, if FileName is set to 'table.rsd', then the file will be generated in '%APPDATA%\\CData\\CDS Data Provider\\Schema\\Entities\\table.rsd'

Result Set Columns


Name	Type	Description
FileData	String	The file data that will be outputted encoded in Base64, if the FileName and FileStream inputs are not set.
Result	String	Indicates whether the schema generation was successful or failed.

GetOAuthAccessToken

Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Microsoft Dataverse.

Input


Name	Type	Required	Description
AuthMode	String	False	Specifies the authentication method to use. Set to 'App' for a desktop or server-side application, or 'Web' for client-side or browser-based applications. The default value is APP.
Verifier	String	False	The unique code returned by the service after user authentication. Required only for 'Web' authentication mode to retrieve the access token. Obtained from the URL provided by GetOAuthAuthorizationUrl.
CallbackUrl	String	False	The endpoint URL to which the user will be redirected after completing the authorization process. Ensure this matches the URL registered with the service.
State	String	False	An optional value your application sends to maintain state between the request and callback. Useful for ensuring the response is tied to a specific request, mitigating CSRF attacks, or handling user navigation on your site.
Prompt	String	False	Determines the behavior of the authentication prompt. Options include 'select_account' (prompt the user to select an account), 'None' (no prompt), 'login' (force credential entry), or 'consent' (display permission grant dialog).

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The OAuth Access Token required for making authorized API requests on behalf of the user or application.
OAuthRefreshToken	String	A token used to obtain a new access token without requiring user re-authentication.
ExpiresIn	Long	The duration in seconds until the access token expires, after which a new token must be requested.

GetOAuthAuthorizationUrl

Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.

Input


Name	Type	Required	Description
CallbackURL	String	False	The endpoint URL to which the user will be redirected after completing the authorization process. Ensure this matches the URL registered with the service to avoid errors.
State	String	False	An optional value your application sends to maintain state between the request and callback. Useful for ensuring the response is tied to a specific request, mitigating CSRF attacks, or handling user-specific workflows after redirection.
Prompt	String	False	Specifies the authentication prompt behavior. Options include 'select_account' (prompt user to choose an account), 'None' (no prompt), 'login' (force user to re-enter credentials), or 'consent' (display permissions grant dialog).

Result Set Columns


Name	Type	Description
Url	String	The URL generated by the OAuth provider that users must visit to grant authorization to your application. Typically includes query parameters for callback, state, and scope.

RefreshOAuthAccessToken

Refreshes an expired OAuth Access Token to maintain continuous authenticated access to Microsoft Dataverse resources without requiring reauthorization from the user.

Input


Name	Type	Required	Description
OAuthRefreshToken	String	True	The refresh token obtained during the initial authorization process. Used to request a new access token without requiring user reauthentication.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The newly generated OAuth Access Token to be used for making authenticated API requests.
OAuthRefreshToken	String	A refreshed token that can be used for future access token requests. This token may replace the previous refresh token.
ExpiresIn	String	The remaining time in seconds until the new access token expires and must be refreshed again.

System Data Model

The System Data Model defines the underlying framework that supports core platform functionality, including security, auditing, and system-level operations. It manages metadata, user roles, workflows, and background processes to ensure seamless data governance and integration across business applications.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including retrieving and refreshing the OAuth Access Token.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Dataverse.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Dataverse, along with an indication of whether the procedure succeeded or failed.

Microsoft Dataverse Connector for CData Sync Stored Procedures


Name	Description
CreateAssociation	Establishes a link between two entities using their navigation properties. Requires navigation properties to be enabled in the connection configuration.
ListAssociations	Displays all associations for a specified table and its navigation properties, detailing entity relationships.
ListNavigationProperties	Lists navigation properties for a specified table and its associated tables, aiding in relationship discovery.
RemoveAssociation	Deletes a previously established link between two entities, managed via their navigation properties.

CreateAssociation

Establishes a link between two entities using their navigation properties. Requires navigation properties to be enabled in the connection configuration.

Stored Procedure-Specific Information

To execute this procedure, enter:

    EXEC CreateAssociation FromId='your-account-id', FromTable='accounts', ToNavigationProperty='primarycontactid', ToId='your-contact-id'

Input


Name	Type	Required	Description
FromId	String	True	The unique identifier (Id) of the source entity for which you are establishing an association.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId belongs to a record in the Customers table, set this parameter to 'Customers'.
ToNavigationProperty	String	True	The name of the navigation property used to define the relationship. This property can be retrieved using the ListNavigationProperties procedure.
ToId	String	True	The unique identifier (Id) of the target entity in the associated table defined by the navigation property.

Result Set Columns


Name	Type	Description
Success	Boolean	A boolean value indicating whether the association creation operation was successful (true) or failed (false).

CreateSchema

Produces a schema file outlining the structure of the specified table or view, supporting data analysis and integration.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The Sync App checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the Sync App.

Input


Name	Type	Required	Description
TableName	String	True	The name of the table or view for which the schema will be generated. Provide the exact name as it appears in Common Data Service.
FileName	String	False	The file name for the generated schema. The file will be generated in 'Location property' + 'System' + 'FileName'. For example, if FileName is set to 'table.rsd', then the file will be generated in '%APPDATA%\\CData\\CDS Data Provider\\Schema\\System\\table.rsd'

Result Set Columns


Name	Type	Description
FileData	String	The file data that will be outputted encoded in Base64, if the FileName and FileStream inputs are not set.
Result	String	Indicates whether the schema generation was successful or failed.

GetOAuthAccessToken

Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Microsoft Dataverse.

Input


Name	Type	Required	Description
AuthMode	String	False	Specifies the authentication method to use. Set to 'App' for a desktop or server-side application, or 'Web' for client-side or browser-based applications. The default value is APP.
Verifier	String	False	The unique verifier code provided by the service after user authorization. This code is required to exchange for an access token when using 'Web' authentication mode. Obtain it by navigating to the URL returned by GetOAuthAuthorizationUrl.
CallbackUrl	String	False	The endpoint URL to which the user will be redirected after authorizing the application. Ensure this matches the URL registered with the OAuth provider.
State	String	False	An optional parameter used to maintain application state between the request and callback. It is sent to the OAuth server and returned in the response. Useful for CSRF mitigation, user-specific routing, or managing session state.
Prompt	String	False	Defines the behavior of the user authentication prompt. Options include 'select_account' (prompt to choose an account), 'None' (no prompt), 'login' (force credential entry), or 'consent' (request user consent for permissions).

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The OAuth Access Token returned by the OAuth service, used to make authorized API requests on behalf of the user or application.
ExpiresIn	Long	The remaining time in seconds until the access token expires. After expiration, a new token must be requested.
OAuthRefreshToken	String	A token used to refresh the access token without requiring user reauthentication.

GetOAuthAuthorizationUrl

Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.

Input


Name	Type	Required	Description
CallbackURL	String	False	The endpoint URL to which the user will be redirected after completing the authorization process. This must match the callback URL registered with the OAuth provider to ensure successful redirection.
State	String	False	An optional parameter used to maintain application state between the request and callback. It is sent to the OAuth server and returned in the response. Useful for session state management, CSRF protection, or redirecting users to specific application resources.
Prompt	String	False	Specifies the behavior of the authentication prompt. Options include 'select_account' (prompt user to choose an account), 'None' (no prompt), 'login' (force reauthentication), or 'consent' (request user consent for permissions). Defaults to 'select_account.'

Result Set Columns


Name	Type	Description
Url	String	The generated authorization URL where users will be directed to grant your application permissions. The URL includes necessary query parameters such as the callback URL, state, and scope.

ListAssociations

Displays all associations for a specified table and its navigation properties, detailing entity relationships.

Stored Procedure-Specific Information

To execute this procedure, enter:

    EXEC ListAssociations FromId='your-account-id', FromTable='accounts', NavigationProperty='primarycontactid'

Input


Name	Type	Required	Description
FromId	String	True	The unique identifier (Id) of the source entity for which you want to list associated entities.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId belongs to a record in the Customers table, set this parameter to 'Customers'.
NavigationProperty	String	True	The name of the navigation property representing the relationship you want to retrieve. This can be obtained using the ListNavigationProperties procedure.

Result Set Columns


Name	Type	Description
Uri	String	The URL linking to the associated entities, providing a way to access the related records through the specified navigation property.

ListNavigationProperties

Lists navigation properties for a specified table and its associated tables, aiding in relationship discovery.

Stored Procedure-Specific Information

To execute this procedure, enter:

    EXEC ListNavigationProperties TableName='accounts'

Input


Name	Type	Required	Description
TableName	String	True	The name of the table for which you want to list the available navigation properties. This table represents the source of the relationships.

Result Set Columns


Name	Type	Description
Name	String	The name of the navigation property that defines a relationship or association within the specified table.
AssociatedTable	String	The name of the table that the navigation property links to, representing the target entity in the relationship.

RefreshOAuthAccessToken

Refreshes an expired OAuth Access Token to maintain continuous authenticated access to Microsoft Dataverse resources without requiring reauthorization from the user.

Input


Name	Type	Required	Description
OAuthRefreshToken	String	True	The refresh token obtained during the initial authorization process. It is used to request a new access token without requiring user reauthentication.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The newly generated OAuth Access Token returned by the OAuth service, used for making authenticated API requests.
OAuthRefreshToken	String	A refreshed token that can be used for future access token requests, replacing the old refresh token if issued.
ExpiresIn	String	The time in seconds remaining until the newly generated access token expires and must be refreshed.

RemoveAssociation

Deletes a previously established link between two entities, managed via their navigation properties.

Stored Procedure-Specific Information

To execute this procedure, enter:

    EXEC RemoveAssociation FromId='your-account-id', FromTable='accounts', ToNavigationProperty='primarycontactid', ToId='your-contact-id'

Input


Name	Type	Required	Description
FromId	String	True	The unique identifier (Id) of the source entity for which you want to remove an association.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId belongs to a record in the Customers table, set this parameter to 'Customers'.
ToNavigationProperty	String	True	The name of the navigation property representing the relationship to be removed. This property can be retrieved using the ListNavigationProperties procedure.
ToId	String	True	The unique identifier (Id) of the target entity in the associated table defined by the navigation property.

Result Set Columns


Name	Type	Description
Success	Boolean	A boolean value indicating whether the removal operation was successful (true) or not (false).

Data Type Mapping

Data Type Mappings

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.


Microsoft Dataverse (OData V4)	CData Schema
Edm.Binary	binary
Edm.Boolean	bool
Edm.Date	datetime
Edm.DateTimeOffset	datetime
Edm.Decimal	decimal
Edm.Double	double
Edm.Guid	guid
Edm.Int32	int
Edm.String	string
Edm.TimeOfDay	time

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Microsoft Dataverse. If this property is left blank, the default authentication is used.
OrganizationURL	The URL to your Dynamics 365 organization, sometimes referred to as the resource. To find the correct URL for your Microsoft Dataverse instance, search the Web Services page.
ApiVersion	Identifies the API version being used. Keep this setting up to date to ensure that the full range of available API features are accessed during authentication.

Azure Authentication

Property	Description
AzureTenant	Identifies the Microsoft Dataverse tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

OAuth

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

JWT OAuth

Property	Description
OAuthJWTCert	Supplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertType	Identifies the type of key store containing the JWT Certificate.
OAuthJWTCertPassword	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Schema	Specifies the schema to use when listing metadata from Microsoft Dataverse.

Miscellaneous

Property	Description
AllowNavigationDisassociation	Specifies whether the provider binds navigation properties to null values.
ContinueOnError	Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
EntityTypes	When using entity definitions define what type of entities to include during metadata discovery.
IncludeFormattedValues	Specifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalName	Indicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeys	Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only).
IncludeNavigationProperties	Specifies whether the column listing should include navigation properties.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseDisplayNames	If set to true, the provider will use display names for some operations.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Microsoft Dataverse. If this property is left blank, the default authentication is used.
OrganizationURL	The URL to your Dynamics 365 organization, sometimes referred to as the resource. To find the correct URL for your Microsoft Dataverse instance, search the Web Services page.
ApiVersion	Identifies the API version being used. Keep this setting up to date to ensure that the full range of available API features are accessed during authentication.

AuthScheme

Specifies the type of authentication to use when connecting to Microsoft Dataverse. If this property is left blank, the default authentication is used.

Remarks

AuthScheme values include:

AzureAD (default): Perform Azure Active Directory (user-based) OAuth authentication.
AzureMSI: Automatically obtain Azure AD Managed Service Identity credentials when running on an Azure VM.
AzureServicePrincipal: Authenticate as an Azure Service Principal (role-based, application-based) using a Client Secret.
AzureServicePrincipalCert: Authenticate as an Azure Service Principal (role-based, application-based) using a Certificate.

For information about creating a custom application to authenticate with Azure AD, see Creating an Entra ID (Azure AD) Application.

For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating a Service Principal App in Entra ID (AzureAD).

OrganizationURL

The URL to your Dynamics 365 organization, sometimes referred to as the resource. To find the correct URL for your Microsoft Dataverse instance, search the Web Services page.

Remarks

Resource URL format is usually similar to https://abc123.cloudax.dynamics.com/, except when the Edition is HumanResources. HumanResources URLs typically look like: https://{cluster}.hr.talent.dynamics.com/namespaces/{namespace_guid}/.

ApiVersion

Identifies the API version being used. Keep this setting up to date to ensure that the full range of available API features are accessed during authentication.

Remarks

The service API provides a means to access new features in the data model. When you change the ApiVersion, it changes what service document is used to define the tables and columns exposed by the driver.

Azure Authentication

This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.

Property	Description
AzureTenant	Identifies the Microsoft Dataverse tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

AzureTenant

Identifies the Microsoft Dataverse tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.

Remarks

A tenant is a digital container for your organization's users and resources, managed through Microsoft Entra ID (formerly Azure AD). Each tenant is associated with a unique directory ID, and often with a custom domain (for example, microsoft.com or contoso.onmicrosoft.com).

To find the directory (tenant) ID in the Microsoft Entra Admin Center, navigate to Microsoft Entra ID > Properties and copy the value labeled "Directory (tenant) ID".

This property is required in the following cases:

When AuthScheme is set to AzureServicePrincipal or AzureServicePrincipalCert
When AuthScheme is AzureAD and the user account belongs to multiple tenants

You can provide the tenant value in one of two formats:

A domain name (for example, contoso.onmicrosoft.com)
A directory (tenant) ID in GUID format (for example, c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0)

Specifying the tenant explicitly ensures that the authentication request is routed to the correct directory, which is especially important when a user belongs to multiple tenants or when using service principal–based authentication.

If this value is omitted when required, authentication may fail or connect to the wrong tenant. This can result in errors such as unauthorized or resource not found.

AzureEnvironment

Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Remarks

Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

JWT OAuth

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthJWTCert	Supplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertType	Identifies the type of key store containing the JWT Certificate.
OAuthJWTCertPassword	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

OAuthJWTCert

Supplies the name of the client certificate's JWT Certificate store.

Remarks

The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Sync App initiates a search for a certificate. For further information, see OAuthJWTCertSubject.

Designations of certificate stores are platform-dependent.

Notes

The most common User and Machine certificate stores in Windows include:
- MY: A certificate store holding personal certificates with their associated private keys.
- CA: Certifying authority certificates.
- ROOT: Root certificates.
- SPC: Software publisher certificates.
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file.
When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

OAuthJWTCertType

Identifies the type of key store containing the JWT Certificate.

Remarks


Value	Description	Notes
USER	A certificate store owned by the current user.	Only available in Windows.
MACHINE	A machine store.	Not available in Java or other non-Windows environments.
PFXFILE	A PFX (PKCS12) file containing certificates.
PFXBLOB	A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	A Java key store (JKS) file containing certificates.	Only available in Java.
JKSBLOB	A string (base-64-encoded) representing a certificate store in Java key store (JKS) format.	Only available in Java.
PEMKEY_FILE	A PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	A string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	A file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	A file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	A string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	A PKCS7 file containing certificates.
PPKFILE	A file that contains a PPK (PuTTY Private Key).
XMLFILE	A file that contains a certificate in XML format.
XMLBLOB	Astring that contains a certificate in XML format.
BCFKSFILE	A file that contains an Bouncy Castle keystore.
BCFKSBLOB	A string (base-64-encoded) that contains a Bouncy Castle keystore.

OAuthJWTCertPassword

Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

OAuthJWTCertSubject

Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

If an exact match for the subject is found, the corresponding certificate is selected.
If no exact match is found, the store is searched for certificates whose subjects contain the property value.
If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected].

Common fields include:


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	`ecadbdda5a1529c58a1e9e09828d70e4`
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Microsoft Dataverse. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Microsoft Dataverse. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Microsoft Dataverse. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

Supported authentication types :

BASIC: The Sync App performs HTTP basic authentication.
DIGEST: The Sync App performs HTTP digest authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The username of a user registered with the proxy server.
DIGEST	The username of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:


Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Schema	Specifies the schema to use when listing metadata from Microsoft Dataverse.

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

Note: Since this Sync App supports multiple schemas, custom schema files for Microsoft Dataverse should be structured such that:

Each schema should have its own folder, named for that schema.
All schema folders should be contained in a parent folder.

Location should always be set to the parent folder, and not to an individual schema's folder.

If left unspecified, the default location is %APPDATA%\\CData\\CDS Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Schema

Specifies the schema to use when listing metadata from Microsoft Dataverse.

Remarks

You can set this connection property to the following values:

System: Exposes Microsoft Dataverse objects with less detailed metadata. Tables use system-level names. Due to the relative simplicity of the metadata returned, retrieving data from this schema is faster. This schema is selected by default.
Entities: Exposes Microsoft Dataverse objects with more detailed metadata (including details about annotations and data types), as well as more user-friendly table names. Due to the increased complexity of the metadata returned, retrieving data from this schema takes longer.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
AllowNavigationDisassociation	Specifies whether the provider binds navigation properties to null values.
ContinueOnError	Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
EntityTypes	When using entity definitions define what type of entities to include during metadata discovery.
IncludeFormattedValues	Specifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalName	Indicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeys	Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only).
IncludeNavigationProperties	Specifies whether the column listing should include navigation properties.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseDisplayNames	If set to true, the provider will use display names for some operations.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

AllowNavigationDisassociation

Specifies whether the provider binds navigation properties to null values.

Remarks

In Microsoft Dataverse, navigation properties represent relationships between entities. Disassociating a navigation property removes the relationship, and some services support doing this by binding the property to a null value.

When set to true, the Sync App binds navigation properties to null in INSERT or UPDATE requests when those properties are set to null and the Microsoft Dataverse supports null binding. This can be used to disassociate navigation properties.

When set to false, navigation properties set to null or an empty string are omitted from the request body.

This property is useful when you need to explicitly remove or disassociate related entities through null binding.

ContinueOnError

Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).

Remarks

When ContinueOnError is set to true and an error occurs in a batch, it will proceed to the next batch and provide status information for the failed one.

When ContinueOnError is false, the process will stop further batch processing if an error occurs. All changes made before the error will remain intact.

EntityTypes

When using entity definitions define what type of entities to include during metadata discovery.

Remarks

PUBLIC: Only public entities will be listed during metadata discovery.
PRIVATE: Only private entities will be listed during metadata discovery.
ALL: All entities will be listed during metadata discovery.

IncludeFormattedValues

Specifies whether columns that hold formatted values should be exposed.

Remarks

If set to true, an extra column named columnname_display is added beside each column. If the column contains a formatted value, the new column exposes that formatted values. If the field does not have a formatted value, columname_display is null.

IncludeLookUpLogicalName

Indicates if the referenced entity name for a LookUp field should be exposed.

Remarks

For each key column, an extra one is added to expose the LookUp logical name value. New columns will have "_lookuplogicalname" postfix.

IncludeNavigationKeys

Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only).

Remarks

This property is provided to make it simpler to retrieve JSON record references where possible. When true, the $prod; pushes a set of fields for each table relation.

These properties are not available for use in INSERT or UPDATE operations. (Use the Linked* navigation columns for that).

If your service supports both XML/ATOM and JSON and you want to use this property, be sure to set DataFormat to JSON.

IncludeNavigationProperties

Specifies whether the column listing should include navigation properties.

Remarks

Navigation properties provide a way to navigate an association between two entity types. Every object can have a navigation property for every relationship in which it participates.

Navigation properties enable you to navigate and manage relationships in two ways:

Two-directional navigation returns either a reference object (if the relationship is either 1 or 0-or-1) or a collection (if the relationship is 1-to-many).
One-directional navigation enables you to define the navigation property on just one of the types that participates in the relationship, but not both.

When retrieving data, the navigation properties in a cell do not populate with information. Rather, they act to bind the content to an existing resource during inserts or updates. For example:

INSERT INTO accounts (_primarycontactid_value) VALUES ('123456')

To specify multiple values, use a comma-separated list. For instance:

INSERT INTO accounts (lead_customer_accounts) VALUES ('123,456')

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Integration and Formatting


Property	Description
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UseDisplayNames

If set to true, the provider will use display names for some operations.

Remarks

If set to true, the Sync App will use display names for some operations. This property is used only for Entities schema.

UserDefinedViews

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Accounts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Microsoft Dataverse Connector for CData Sync

Microsoft Dataverse Connector for CData Sync

Overview

Microsoft Dataverse Version Support

Establishing a Connection

Adding a Connection to Microsoft Dataverse

Schema

Connecting to Microsoft Dataverse

Entra ID (Azure AD)

Client Credentials

Azure Service Principal

Managed Service Identity (MSI)

User-Managed Identities

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Entities Data Model

Views

Stored Procedures

Views

Microsoft Dataverse Connector for CData Sync Views

MultiSelectPickListAttributeMetaData

View-Specific Information

Select

Columns

MultiSelectPickListOptions

View-Specific Information

Select

Columns

PickListAttributeMetaData

View-Specific Information

Select

Columns

PickListOptions

View-Specific Information

Select

Columns

StateAttributeMetadata

View-Specific Information

Select

Columns

StateAttributeOptions

View-Specific Information

Select

Columns

StatusAttributeMetadata

View-Specific Information

Select

Columns

StatusAttributeOptions

View-Specific Information

Select

Columns

Stored Procedures

Microsoft Dataverse Connector for CData Sync Stored Procedures

CreateSchema

CreateSchema

Input

Result Set Columns

GetOAuthAccessToken

Input

Result Set Columns

GetOAuthAuthorizationUrl

Input

Result Set Columns

RefreshOAuthAccessToken

Input

Result Set Columns

System Data Model

Stored Procedures