The CData Sync App provides a straightforward way to continuously pipeline your Microsoft Dynamics 365 data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Microsoft Dynamics 365 connector can be used from the CData Sync application to pull data from Microsoft Dynamics 365 and move it to any of the supported destinations.
The Sync App supports read/write access to Microsoft Dynamics 365 through OData Web services.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
Notes:
To connect, set these parameters:
To connect, set these properties:
If your organization requires admin consent for authorizing any new OAuth application for your Azure Tenant, it means that the first time someone in your organization installs and uses an OAuth application, an administrator for the organization must explicitly grant that application access.
(Your organization can choose to disable this requirement.)
Granting Admin Consent
When creating a new OAuth application in the Azure Portal (see Creating an Azure AD Application), you must specify which permissions the application requires. If you know that your organization requires admin consent for new custom applications, you can start by specifying permissions that are already labeled Admin Consent Required. (For example, all Groups permissions require admin consent.)
There are two ways to grant admin consent:
After an admin grants consent, authentication is performed as usual.
All permissions related to the client OAuth flow require admin consent. This means the application embedded with the CData Sync App cannot be used in the client OAuth flow. You must create your own OAuth application to use client credentials, as described in Creating an Azure AD Application.
To do this:
To connect, set these properties:
When you are ready to connect, set these properties:
If you are running Microsoft Dynamics 365 on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials to connect, set AuthScheme to AzureMSI.
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 Dynamics 365 Sync App.
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 .
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" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App models Microsoft Dynamics 365 data in relational tables, views, and stored procedures. The table definitions are dynamically obtained from the Microsoft Dynamics 365 OData service when you connect. Any changes to the metadata, such as new or removed columns, or changes in data type, are automatically loaded when you reconnect.
The Views section, which lists read-only SQL tables, contains samples of what you might have access to in your Microsoft Dynamics 365 account.
The following views are shipped with the Sync App:
| View | Description |
| MultiSelectPickListAttributeMetaData | Stores metadata for attributes with a MultiSelect OptionSet type. This metadata is only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales. |
| MultiSelectPickListOptions | Contains the values (options) for MultiSelect Picklist metadata attributes. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales. |
| PickListAttributeMetaData | Holds metadata for attributes of the Picklist type, detailing their options and configuration. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales. |
| PickListOptions | Stores option values for Picklist metadata attributes, providing details for enumerated selections. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales. |
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, such as managing associations and retrieving OAuth access tokens.
The Sync App uses the Microsoft Dynamics 365 OData services to dynamically retrieve all of your Microsoft Dynamics 365 tables when you connect.
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.
| Name | Description |
| MultiSelectPickListAttributeMetaData | Contains the Picklist metadata for an attribute type MultiSelect OptionSet. Note: This view is only available when Edition is set to either CustomerService, FieldService, Marketing, ProjectOperations or Sales. |
| MultiSelectPickListOptions | Contains the Options Value of MultiSelect PicklistMetadata. Note: This view is only available when Edition is set to either CustomerService, FieldService, Marketing, ProjectOperations or Sales. |
| PickListAttributeMetaData | Contains the metadata for an attribute type Picklist. Note: This view is only available when Edition is set to either CustomerService, FieldService, Marketing, ProjectOperations or Sales. |
| PickListOptions | Contains the Options value of PickListMetaData. Note: This view is only available when Edition is set to either CustomerService, FieldService, Marketing, ProjectOperations or Sales. |
Stores metadata for attributes with a MultiSelect OptionSet type. This metadata is only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
The Sync App will use the Microsoft Dynamics 365 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.
For example, the following queries are processed server side:
SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'
SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')
| Name | Type | Description |
| ColumnName [KEY] | String | The name of the column representing the attribute within the table. |
| MetadataId | String | The unique identifier for the metadata of the attribute. |
| OptionSet_Description_LocalizedLabels | String | Localized labels providing descriptions for the option set in various languages. |
| OptionSet_Description_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the description has been modified. |
| OptionSet_Description_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the description is managed. |
| OptionSet_Description_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the description. |
| OptionSet_Description_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the description. |
| OptionSet_Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the description. |
| OptionSet_DisplayName_LocalizedLabels | String | Localized labels providing display names for the option set in various languages. |
| OptionSet_DisplayName_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the display name has been modified. |
| OptionSet_DisplayName_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the display name is managed. |
| OptionSet_DisplayName_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the display name. |
| OptionSet_DisplayName_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the display name. |
| OptionSet_DisplayName_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the display name. |
| OptionSet_ExternalTypeName | String | The external type name associated with the option set, if applicable. |
| OptionSet_HasChanged | String | Indicates whether the option set has been modified since its creation. |
| 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. |
| OptionSet_IsCustomizable_ManagedPropertyLogicalName | String | The logical name of the managed property that defines whether the option set is customizable. |
| OptionSet_IsCustomizable_Value | Boolean | Specifies if the option set is marked as customizable. |
| OptionSet_IsCustomOptionSet | Boolean | Specifies if the option set is custom or predefined. |
| OptionSet_IsGlobal | Boolean | Indicates whether the option set is global (shared across entities) or local to a specific entity. |
| OptionSet_IsManaged | Boolean | Specifies if the option set is part of a managed solution. |
| OptionSet_MetadataId | String | The unique identifier for the metadata of the option set. |
| OptionSet_Name | String | The name of the option set. |
| OptionSet_OptionSetType | String | The type of the option set, defining its structure and usage. |
| OptionSet_ParentOptionSetName | String | The name of the parent option set if the current option set is part of a hierarchical structure. |
| TableName | String | The name of the table containing the attribute represented by the option set. |
Contains the values (options) for MultiSelect Picklist metadata attributes. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
The Sync App will use the Microsoft Dynamics 365 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.
For example, the following queries are processed server side:
SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'
SELECT * FROM MultiSelectPickListOptions WHERE TableName IN ('accounts', 'teams')
| Name | Type | Description |
| ColumnName | String | The name of the column representing the multi-select picklist attribute. |
| Color | String | The color associated with the picklist option, typically used for UI representation. |
| ExternalValue | String | The external value associated with the picklist option, used for integration or mapping purposes. |
| HasChanged | String | Indicates whether the picklist option has been modified since its creation. |
| IsManaged | Boolean | Specifies whether the picklist option is part of a managed solution. |
| Label_LocalizedLabels | String | Localized labels providing display names for the picklist option in various languages. |
| Label_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the picklist option's label has been modified. |
| Label_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the picklist option's label is managed. |
| Label_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the picklist option's label. |
| Label_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the picklist option's label. |
| Label_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the picklist option's label. |
| Description_LocalizedLabels | String | Localized labels providing descriptions for the picklist option in various languages. |
| Description_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the picklist option's description has been modified. |
| Description_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the picklist option's description is managed. |
| Description_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the picklist option's description. |
| Description_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the picklist option's description. |
| Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the picklist option's description. |
| MetadataId | String | The unique identifier for the metadata of the picklist option. |
| ParentValues | String | The parent values associated with the picklist option, used when the option is part of a hierarchical structure. |
| Value | Integer | The numeric value assigned to the picklist option. |
| TableName | String | The name of the table containing the multi-select picklist attribute. |
Holds metadata for attributes of the Picklist type, detailing their options and configuration. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
The Sync App will use the Microsoft Dynamics 365 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.
For example, the following queries are processed server side:
SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'
SELECT * FROM PickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')
| Name | Type | Description |
| ColumnName [KEY] | String | The name of the column representing the picklist attribute within the table. |
| MetadataId | String | The unique identifier for the metadata of the picklist attribute. |
| OptionSet_Description_LocalizedLabels | String | Localized labels providing descriptions for the option set in various languages. |
| OptionSet_Description_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the description has been modified. |
| OptionSet_Description_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the description is managed. |
| OptionSet_Description_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the description. |
| OptionSet_Description_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the description. |
| OptionSet_Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the description. |
| OptionSet_DisplayName_LocalizedLabels | String | Localized labels providing display names for the option set in various languages. |
| OptionSet_DisplayName_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the display name has been modified. |
| OptionSet_DisplayName_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the display name is managed. |
| OptionSet_DisplayName_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the display name. |
| OptionSet_DisplayName_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the display name. |
| OptionSet_DisplayName_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the display name. |
| OptionSet_ExternalTypeName | String | The external type name associated with the option set, if applicable. |
| OptionSet_HasChanged | String | Indicates whether the option set has been modified since its creation. |
| 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. |
| OptionSet_IsCustomizable_ManagedPropertyLogicalName | String | The logical name of the managed property that defines whether the option set is customizable. |
| OptionSet_IsCustomizable_Value | Boolean | Specifies if the option set is marked as customizable. |
| OptionSet_IsCustomOptionSet | Boolean | Specifies if the option set is custom or predefined. |
| OptionSet_IsGlobal | Boolean | Indicates whether the option set is global (shared across entities) or local to a specific entity. |
| OptionSet_IsManaged | Boolean | Specifies if the option set is part of a managed solution. |
| OptionSet_MetadataId | String | The unique identifier for the metadata of the option set. |
| OptionSet_Name | String | The name of the option set. |
| OptionSet_OptionSetType | String | The type of the option set, defining its structure and usage. |
| OptionSet_ParentOptionSetName | String | The name of the parent option set if the current option set is part of a hierarchical structure. |
| TableName | String | The name of the table containing the picklist attribute. |
Stores option values for Picklist metadata attributes, providing details for enumerated selections. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
The Sync App will use the Microsoft Dynamics 365 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.
For example, the following queries are processed server side:
SELECT * FROM PickListOptions WHERE TableName = 'teams'
SELECT * FROM PickListOptions WHERE TableName IN ('accounts', 'teams')
| Name | Type | Description |
| ColumnName | String | The name of the column representing the picklist attribute. |
| Color | String | The color associated with the picklist option, typically used for visual representation in the UI. |
| ExternalValue | String | An external value associated with the picklist option, useful for integration or mapping purposes. |
| HasChanged | String | Indicates whether the picklist option has been modified since its creation. |
| IsManaged | Boolean | Specifies whether the picklist option is part of a managed solution. |
| Label_LocalizedLabels | String | Localized labels providing display names for the picklist option in various languages. |
| Label_UserLocalizedLabel_HasChanged | String | Indicates whether the user-defined localized label for the picklist option has been modified. |
| Label_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the picklist option is managed. |
| Label_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the picklist option. |
| Label_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the picklist option. |
| Label_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the picklist option. |
| Description_LocalizedLabels | String | Localized labels providing descriptions for the picklist option in various languages. |
| Description_UserLocalizedLabel | String | The user-defined localized label for the description of the picklist option. |
| MetadataId | String | The unique identifier for the metadata of the picklist option. |
| ParentValues | String | The parent values associated with the picklist option, used when the option is part of a hierarchical structure. |
| Value | Integer | The numeric value assigned to the picklist option. |
| TableName | String | The name of the table containing the picklist attribute. |
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 Dynamics 365 (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.
| Property | Description |
| AuthScheme | Specifies the type of authentication to use when connecting to Microsoft Dynamics 365. 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 Dynamics 365 instance, search the Web Services page. |
| Edition | Specifies the Microsoft Dynamics 365 edition in use. If not specified, the default (FinOpsOnline) is assumed. |
| ADFSServer | Identifies the FinOpsOnPremise ADFS Server to be used for authentication. To find this server name, enter echo %logonserver% at the command prompt. |
| 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. |
| Property | Description |
| AzureTenant | Identifies the Microsoft Dynamics 365 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. |
| 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. |
| 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. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| 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. |
| 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. |
| 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. |
| 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 . |
| Property | Description |
| AllowDuplicateRecords | Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false. |
| ContinueOnError | Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.). |
| CrossCompany | Specifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.). |
| CustomUrlParams | A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3. |
| EnableAtomicBatchOperations | Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails). |
| 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. |
| MinimumColumnSize | Specifies the minimum size of an Edm.String column, expressed as a number of characters. If the column size reported by Microsoft Dynamics 365 has a value lower than this value, the CData ADO.NET Provider for Microsoft Dynamics 365 overrides the service value with the one defined in the connection string. |
| 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. |
| Pagesize | Specifies the maximum number of results to return from Microsoft Dynamics 365, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| 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. |
| UseClientSidePaging | Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. If set to false, Microsoft Dynamics 365 uses server-side paging. |
| UseDynamicStoredProcedures | Indicates whether or not stored procedures should be listed dynamically. |
| UseEntityDefinitions | Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint. |
| 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 Dynamics 365. 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 Dynamics 365 instance, search the Web Services page. |
| Edition | Specifies the Microsoft Dynamics 365 edition in use. If not specified, the default (FinOpsOnline) is assumed. |
| ADFSServer | Identifies the FinOpsOnPremise ADFS Server to be used for authentication. To find this server name, enter echo %logonserver% at the command prompt. |
| 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 Dynamics 365. If this property is left blank, the default authentication is used.
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 Dynamics 365 instance, search the Web Services page.
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}/.
Specifies the Microsoft Dynamics 365 edition in use. If not specified, the default (FinOpsOnline) is assumed.
If the edition is FinOpsOnPremise, you must also specify the ADFSServer.
Identifies the FinOpsOnPremise ADFS Server to be used for authentication. To find this server name, enter echo %logonserver% at the command prompt.
Use only when Edition is set to FinOpsOnPremise. If no ADFS server name is specified, the property is ignored.
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.
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 Dynamics 365 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 Dynamics 365 tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
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.
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.
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.
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.
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. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
The JWT Certificate store.
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.
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.
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.
The value of this property is used to locate a matching certificate in the store. The search process works as follows:
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.".
The issuer of the Java Web Token.
The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.
The user subject for which the application is requesting delegated access.
The user subject for which the application is requesting delegated access. Typically, the user account name or email address.
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.
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.
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 Dynamics 365. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Microsoft Dynamics 365. 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 Dynamics 365. 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.
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.
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.
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.
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.
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.
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.
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.
The authentication type can be one of the following:
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.
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.
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.
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.
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.
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 . |
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.
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.
If left unspecified, the default location is %APPDATA%\\CData\\Dynamics365 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 .
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 .
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 .
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.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| AllowDuplicateRecords | Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false. |
| ContinueOnError | Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.). |
| CrossCompany | Specifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.). |
| CustomUrlParams | A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3. |
| EnableAtomicBatchOperations | Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails). |
| 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. |
| MinimumColumnSize | Specifies the minimum size of an Edm.String column, expressed as a number of characters. If the column size reported by Microsoft Dynamics 365 has a value lower than this value, the CData ADO.NET Provider for Microsoft Dynamics 365 overrides the service value with the one defined in the connection string. |
| 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. |
| Pagesize | Specifies the maximum number of results to return from Microsoft Dynamics 365, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| 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. |
| UseClientSidePaging | Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. If set to false, Microsoft Dynamics 365 uses server-side paging. |
| UseDynamicStoredProcedures | Indicates whether or not stored procedures should be listed dynamically. |
| UseEntityDefinitions | Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false.
This property only applies when Edition is CustomerService, FieldService, Marketing, ProjectOperations or Sales.
For further information, see https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/manage-duplicate-detection-create-update.
Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
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 data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.).
This property only applies when Edition is set to FinOpsOnline, FinOpsOnPremise or HumanResources.
A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.
This property enables you to specify custom query string parameters that are included with the HTTP request. The parameters must be encoded as a query string in the form field1=value1&field2=value2&field3=value3, where each value is URL encoded. URL encoding converts the characters in the string that can be transmitted over the internet as follows:
Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails).
If set to false, batch CUD operations are processed non-atomically, allowing individual operations to succeed or fail independently within the batch.
EnableAtomicBatchOperations is tightly coupled with ContinueOnError.
If ContinueOnError and EnableAtomicBatchOperations are both true, all batch rows are treated as a single unit. If a failure occurs, the API stops processing the remaining rows. The driver reports the remaining rows as failed.
If ContinueOnError is false and EnableAtomicBatchOperations is true, all batch rows are processed as a single unit. If one of the rows fails, the driver breaks the flow and displays an error. No rows are reported in LastResultInfo.
If ContinueOnError is true/false (defaults to true for EnableAtomicBatchOperations = false) and EnableAtomicBatchOperations is false, each row in the batch is treated as a single unit. the API processes all the rows. The driver populates LastResultInfo with information about each row, including their success status.
Specifies whether columns that hold formatted values should be exposed.
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.
For each key column, an extra one is added to expose the LookUp logical name value. New columns will have "_lookuplogicalname" postfix.
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
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 the minimum size of an Edm.String column, expressed as a number of characters. If the column size reported by Microsoft Dynamics 365 has a value lower than this value, the CData ADO.NET Provider for Microsoft Dynamics 365 overrides the service value with the one defined in the connection string.
For more information about column limits at your site, examine the Manage Limits admin view.
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.
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.
| 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 maximum number of results to return from Microsoft Dynamics 365, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.
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.
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.
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.
Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. If set to false, Microsoft Dynamics 365 uses server-side paging.
Pagination is the process of batching data so that the data retrieved is displayed in batches of a particular size. (To keep paging through the data, ask for "more". The data continues to display until all the retrieved data has been shown.)
In client-side paging, the client specifies how many records to return in each request, and the order of the requests. If UseClientSidePaging is set to true, the limit/offset is calculated at the client and the requests are sent concurrently, as multiple threads.
In server-side paging, the server returns only a subset of the data requested by the client. It also provides statistics on how large the full set of requested data is, and how much of the requested data set was not displayed. Server-side pagination is best for large data sets.
Note: Server-side paging requires traversing the data set both backward and forward. Not all data sources support that natively. To explicitly enable server-side paging with a data source that does not support it natively, you must configure your server to return a limited number of records per request, along with metadata about the total number of records. For details, see your data source's API documentation.
Indicates whether or not stored procedures should be listed dynamically.
When UseDynamicStoredProcedures is true, you can pull a stored procedure from the Actions and Functions in the OData service $metadata document and use the EXEC command to list it at runtime.
In all other ways, dynamic stored procedures are just like standard static stored procedures. Like standard stored procedures, they can also be listed using CALL or via edition-specific code.
Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint.
This option is useful when precise column metadata is required, and the default data type attributes cannot be relied upon. Since EntityMetadata entities contain a lot of data, more detailed information is provided, including column length, description, precision, and scale. However, due to the larger metadata payload, response times are slower.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
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 GoalHeadings 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.