Adding a Connection to Microsoft Dataverse

To add a connection to Microsoft Dataverse:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. 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 schema values of 'System' and 'Entities' and can be set using the Schema property.

Using 'System' for Schema property uses the Web API to query entities/tables.

Using 'Entities' for Schema property uses the EntityDefinitions entity set path and retrieves information about EntityMetadata EntityType entities/tables. This will often result in more user friendly names, though requires extra metadata requests.

Connecting to Microsoft Dataverse

To authenticate to the Microsoft Dataverse source, you should first set the OrganizationUrl to the URL of the organization you are connecting to, such as https://[organization].crm.dynamics.com.

Azure AD

Azure AD is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Microsoft Dataverse using an internet browser. The Sync App facilitates this in several ways as described below. Set your AuthScheme to AzureAD. The rest of the AzureAD flows assume that you have done so.

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

1. Client Secret
   • 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.
   • OAuthGrantType: Set this to CLIENT.
   • OAuthClientId: Set this to the Client Id in your app settings.
   • OAuthClientSecret: Set this to the Client Secret in your app settings.
2. Certificate
   • 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.
   • OAuthGrantType: Set this to CLIENT.
   • 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

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 an Azure AD App with Service Principal.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
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 that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthGrantType	Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

JWT OAuth

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	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
ContinueOnError	Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
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 rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseDisplayNames	If set to true, the provider will use display names for some operations.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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.

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

Remarks

• AzureAD: 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 Azure AD Application.

For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating an Azure AD App with Service Principal.

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}/.

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.

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, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Identifies the Microsoft Dataverse tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).

Remarks

A tenant is a digital representation of your organization, primarily associated with a domain (for example, microsoft.com). The tenant is managed through a Tenant ID (also known as the directory ID), which is specified whenever you assign users permissions to access or manage Azure resources.

To locate the directory ID in the Azure Portal, navigate to Azure Active Directory > Properties.

Specifying AzureTenant is required when AuthScheme = either AzureServicePrincipal or AzureServicePrincipalCert, or if AuthScheme = AzureAD and the user belongs to more than one tenant.

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.

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 that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthGrantType	Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

Remarks

In most cases, the default grant type should not be modified. For information about the most common OAuth grant types and the trade-offs between them, see https://oauth.net/2/grant-types/.

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

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	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.

The JWT Certificate store.

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

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

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:

USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

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

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.

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

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

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.

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.

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.

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.

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.

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.

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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

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. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

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

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, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is 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.

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

Remarks

The authentication type can be one of the following:

• 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: Set this when 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.

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 user name of a user registered with the proxy server.
DIGEST	The user name 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.

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

The password associated with 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.

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

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.

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

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.

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

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

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.

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

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.

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.

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.

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.

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

---

Property	Description
ContinueOnError	Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
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 rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseDisplayNames	If set to true, the provider will use display names for some operations.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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

Remarks

If ContinueOnError is set to true, batch operations that encounter an error complete, creating a results table that includes the error response. If ContinueOnError is set to false, batch operations that encounter an error abort and display an error message.

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.

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.

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.

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')

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in 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.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

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: "*=*"

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

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.

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

Remarks

This property 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 define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.