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 a Custom OAuth 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 a Custom OAuth Application.

Managed Service Identity (MSI)

If you are running Microsoft Dataverse on an Azure VM and want to leverage MSI 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".

When 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 allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

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

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

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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.

Overview

This section shows the available API objects and provides more information on executing SQL to Microsoft Dataverse APIs.

The CData Sync App models Microsoft Dataverse entities in relational Tables, Views, and Stored Procedures. The table definitions are dynamically obtained from the OData service you connect to. Any changes in the metadata, such as added or removed columns or changes in data type, can be loaded by reconnecting.

Tables

The Sync App models the writable entities described in the service metadata document as bidirectional tables.

Stored Procedures

Are function-like interfaces to the data source. They can be used to perform additional operations that fall outside of the standard CRUD model such as retrieving an OAuth access token.

Microsoft Dataverse Entities Data Model

Entities Data Model describes the schemas available to connect to Microsoft Dataverse. You can use tables to work with live Microsoft Dataverse data. You can use stored procedures provided by CData Sync App to automate working with Microsoft Dataverse data.

Microsoft Dataverse System Data Model

System Data Model describes the schemas available to connect to Microsoft Dataverse. You can use tables to work with live Microsoft Dataverse data. You can use stored procedures provided by CData Sync App to automate working with Microsoft Dataverse data.

Views

Views describes the available views.

Stored Procedures

Stored Procedures are function-like interfaces to Microsoft Dataverse. Stored procedures allow you to execute operations to Microsoft Dataverse, such as retrieving 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	Contains the Picklist metadata for an attribute type MultiSelect OptionSet.
MultiSelectPickListOptions	Contains the Options Value of MultiSelect PicklistMetadata.
PickListAttributeMetaData	Contains the metadata for an attribute type Picklist.
PickListOptions	Contains the Options value of PickListMetaData
StateAttributeMetadata	Contains the metadata for an attribute type State.
StateAttributeOptions	Contains the Options value of the State Attribute.
StatusAttributeMetadata	Contains the metadata for an attribute type Status.
StatusAttributeOptions	Contains the Options value of the Status Attribute.

Contains the Picklist metadata for an attribute type MultiSelect OptionSet.

Columns

Name	Type	References	Description
ColumnName [KEY]	String
MetadataId	String
OptionSet_Description_LocalizedLabels	String
OptionSet_Description_UserLocalizedLabel_HasChanged	String
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean
OptionSet_Description_UserLocalizedLabel_Label	String
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer
OptionSet_Description_UserLocalizedLabel_MetadataId	String
OptionSet_DisplayName_LocalizedLabels	String
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean
OptionSet_DisplayName_UserLocalizedLabel_Label	String
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String
OptionSet_ExternalTypeName	String
OptionSet_HasChanged	String
OptionSet_IntroducedVersion	String
OptionSet_IsCustomizable_CanBeChanged	Boolean
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String
OptionSet_IsCustomizable_Value	Boolean
OptionSet_IsCustomOptionSet	Boolean
OptionSet_IsGlobal	Boolean
OptionSet_IsManaged	Boolean
OptionSet_MetadataId	String
OptionSet_Name	String
OptionSet_OptionSetType	String
OptionSet_ParentOptionSetName	String
TableName	String

Contains the Options Value of MultiSelect PicklistMetadata.

Columns

Name	Type	References	Description
ColumnName	String	MultiSelectPickListAttributeMetaData.ColumnName
Color	String
ExternalValue	String
HasChanged	String
IsManaged	Boolean
Label_LocalizedLabels	String
Label_UserLocalizedLabel_HasChanged	String
Label_UserLocalizedLabel_IsManaged	Boolean
Label_UserLocalizedLabel_Label	String
Label_UserLocalizedLabel_LanguageCode	Integer
Label_UserLocalizedLabel_MetadataId	String
Description_LocalizedLabels	String
Description_UserLocalizedLabel_HasChanged	String
Description_UserLocalizedLabel_IsManaged	Boolean
Description_UserLocalizedLabel_Label	String
Description_UserLocalizedLabel_LanguageCode	Integer
Description_UserLocalizedLabel_MetadataId	String
MetadataId	String
ParentValues	String
Value	Integer
TableName	String

Contains the metadata for an attribute type Picklist.

Columns

Name	Type	References	Description
ColumnName [KEY]	String
MetadataId	String
OptionSet_Description_LocalizedLabels	String
OptionSet_Description_UserLocalizedLabel_HasChanged	String
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean
OptionSet_Description_UserLocalizedLabel_Label	String
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer
OptionSet_Description_UserLocalizedLabel_MetadataId	String
OptionSet_DisplayName_LocalizedLabels	String
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean
OptionSet_DisplayName_UserLocalizedLabel_Label	String
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String
OptionSet_ExternalTypeName	String
OptionSet_HasChanged	String
OptionSet_IntroducedVersion	String
OptionSet_IsCustomizable_CanBeChanged	Boolean
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String
OptionSet_IsCustomizable_Value	Boolean
OptionSet_IsCustomOptionSet	Boolean
OptionSet_IsGlobal	Boolean
OptionSet_IsManaged	Boolean
OptionSet_MetadataId	String
OptionSet_Name	String
OptionSet_OptionSetType	String
OptionSet_ParentOptionSetName	String
TableName	String

Contains the Options value of PickListMetaData

Columns

Name	Type	References	Description
ColumnName	String	PickListAttributeMetaData.ColumnName
Color	String
ExternalValue	String
HasChanged	String
IsManaged	Boolean
Label_LocalizedLabels	String
Label_UserLocalizedLabel_HasChanged	String
Label_UserLocalizedLabel_IsManaged	Boolean
Label_UserLocalizedLabel_Label	String
Label_UserLocalizedLabel_LanguageCode	Integer
Label_UserLocalizedLabel_MetadataId	String
Description_LocalizedLabels	String
Description_UserLocalizedLabel	String
MetadataId	String
ParentValues	String
Value	Integer
TableName	String

Contains the metadata for an attribute type State.

Columns

Name	Type	References	Description
ColumnName [KEY]	String
MetadataId	String
OptionSet_Description_LocalizedLabels	String
OptionSet_Description_UserLocalizedLabel_HasChanged	String
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean
OptionSet_Description_UserLocalizedLabel_Label	String
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer
OptionSet_Description_UserLocalizedLabel_MetadataId	String
OptionSet_DisplayName_LocalizedLabels	String
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean
OptionSet_DisplayName_UserLocalizedLabel_Label	String
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String
OptionSet_ExternalTypeName	String
OptionSet_HasChanged	String
OptionSet_IntroducedVersion	String
OptionSet_IsCustomizable_CanBeChanged	Boolean
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String
OptionSet_IsCustomizable_Value	Boolean
OptionSet_IsCustomOptionSet	Boolean
OptionSet_IsGlobal	Boolean
OptionSet_IsManaged	Boolean
OptionSet_MetadataId	String
OptionSet_Name	String
OptionSet_OptionSetType	String
OptionSet_ParentOptionSetName	String
TableName	String

Contains the Options value of the State Attribute.

Columns

Name	Type	References	Description
ColumnName	String	StateAttributeMetadata.ColumnName
Color	String
ExternalValue	String
HasChanged	String
IsManaged	Boolean
Label_LocalizedLabels	String
Label_UserLocalizedLabel_HasChanged	String
Label_UserLocalizedLabel_IsManaged	Boolean
Label_UserLocalizedLabel_Label	String
Label_UserLocalizedLabel_LanguageCode	Integer
Label_UserLocalizedLabel_MetadataId	String
Description_LocalizedLabels	String
Description_UserLocalizedLabel	String
MetadataId	String
ParentValues	String
Value	Integer
TableName	String

Contains the metadata for an attribute type Status.

Columns

Name	Type	References	Description
ColumnName [KEY]	String
MetadataId	String
OptionSet_Description_LocalizedLabels	String
OptionSet_Description_UserLocalizedLabel_HasChanged	String
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean
OptionSet_Description_UserLocalizedLabel_Label	String
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer
OptionSet_Description_UserLocalizedLabel_MetadataId	String
OptionSet_DisplayName_LocalizedLabels	String
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean
OptionSet_DisplayName_UserLocalizedLabel_Label	String
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String
OptionSet_ExternalTypeName	String
OptionSet_HasChanged	String
OptionSet_IntroducedVersion	String
OptionSet_IsCustomizable_CanBeChanged	Boolean
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String
OptionSet_IsCustomizable_Value	Boolean
OptionSet_IsCustomOptionSet	Boolean
OptionSet_IsGlobal	Boolean
OptionSet_IsManaged	Boolean
OptionSet_MetadataId	String
OptionSet_Name	String
OptionSet_OptionSetType	String
OptionSet_ParentOptionSetName	String
TableName	String

Contains the Options value of the Status Attribute.

Columns

Name	Type	References	Description
ColumnName	String	StatusAttributeMetadata.ColumnName
Color	String
ExternalValue	String
HasChanged	String
IsManaged	Boolean
Label_LocalizedLabels	String
Label_UserLocalizedLabel_HasChanged	String
Label_UserLocalizedLabel_IsManaged	Boolean
Label_UserLocalizedLabel_Label	String
Label_UserLocalizedLabel_LanguageCode	Integer
Label_UserLocalizedLabel_MetadataId	String
Description_LocalizedLabels	String
Description_UserLocalizedLabel	String
MetadataId	String
ParentValues	String
Value	Integer
TableName	String

Views

Describes the available views.

Stored Procedures

Stored Procedures are function-like interfaces to Microsoft Dataverse. Stored procedures allow you to execute operations to Microsoft Dataverse, such as retrieving 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	The type of authentication to use when connecting to Microsoft Dataverse.
OrganizationURL	The URL to your Microsoft Dataverse data. For instance, https://abc123.crm.dynamics.com/.
Tenant	The Microsoft tenant being used to access data. If not specified, your default tenant is used.

Azure Authentication

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthGrantType	The grant type for the OAuth flow.

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.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

SSL

---

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

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Schema	Schema to use System, Entities.

Miscellaneous

---

Property	Description
ApiVersion	The API version being used. This can be specified to access a new version of the API once it is released.
IncludeFormattedValues	Indicates if columns that hold formatted values should be exposed.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseDisplayNames	If set to true, the provider will use display names for some operations.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Microsoft Dataverse.
OrganizationURL	The URL to your Microsoft Dataverse data. For instance, https://abc123.crm.dynamics.com/.
Tenant	The Microsoft tenant being used to access data. If not specified, your default tenant is used.

The type of authentication to use when connecting to Microsoft Dataverse.

Remarks

• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal using a Client Secret.
• AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a Certificate.

The URL to your Microsoft Dataverse data. For instance, https://abc123.crm.dynamics.com/.

Remarks

The URL you use to log into your Microsoft Dataverse data. For instance, https://abc123.crm.dynamics.com/. This may also be known as the resource.

The Microsoft tenant being used to access data. If not specified, your default tenant is used.

Remarks

The Microsoft tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.

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

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.

Remarks

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.

The Azure Environment to use when establishing a connection.

Remarks

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, USGOVTDOD.

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

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthGrantType	The grant type for the OAuth flow.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

The grant type for the OAuth flow.

Remarks

The following options are available: CODE,CLIENT,PASSWORD

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.
OAuthJWTCertSubject	The subject of the OAuth JWT 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.

The password for the OAuth JWT certificate.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

The subject of the OAuth JWT certificate.

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.

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 it must be quoted.

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

---

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

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	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that 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.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Microsoft Dataverse and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your 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.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

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

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

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

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

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

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

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

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is 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 ProxyServer .

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, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

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

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Schema	Schema to use System, Entities.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

Note: Given that this Sync App supports multiple schemas, the structure for Microsoft Dataverse custom schema files is as follows:

• Each schema is given a folder corresponding to that schema name.
• These schema folders are contained in a parent folder.
• The parent folder should be set as the Location, not an individual schema's folder.

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

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

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Schema to use System, Entities.

Remarks

Schema to use System, Entities

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

---

Property	Description
ApiVersion	The API version being used. This can be specified to access a new version of the API once it is released.
IncludeFormattedValues	Indicates if columns that hold formatted values should be exposed.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseDisplayNames	If set to true, the provider will use display names for some operations.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

The API version being used. This can be specified to access a new version of the API once it is released.

Remarks

The API version being used. This can be specified to access a new version of the API once it is released. Otherwise, you can use the default.

Indicates if columns that hold formatted values should be exposed.

Remarks

For each column, an extra one is added to expose the formatted value. New columns will have "_display" postfix.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

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.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

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.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom 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)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.