Adding a Connection to Microsoft Dynamics 365

To add a connection to Microsoft Dynamics 365:

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 Dynamics 365 icon is not available, click the Add More icon to download and install the Microsoft Dynamics 365 connector from the CData site.

For required properties, see the Settings tab.

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

Connecting to Microsoft Dynamics 365

The Microsoft Dynamics 365 driver supports connecting to the following Microsoft Dynamics 365 editions:

• CustomerService
• FieldService
• FinOpsOnline (Default)
• FinOpsOnPremises
• HumanResources
• Marketing
• ProjectOperations
• Sales

Notes:

• Supply Chain Management is the same as Finance and Operations. To connect to either of these, set Edition to either FinOpsOnline or FinOpsOnPremises.
• For Microsoft Dynamics 365 Business Central, use the separate Microsoft Dynamics 365 Business Central driver.

To connect to any of the supported Microsoft Dynamics 365 editions, set these parameters:

• OrganizationURL: The URL to your Microsoft Dynamics 365 organization; for example, https://orgcb42e1d0.crm.dynamics.com.
• Edition: As shown in the list of editions above.

Authenticating to Microsoft Dynamics 365

Microsoft Dynamics 365 supports authentication via Microsoft Entra ID (Azure AD), Azure Service Principal, or Azure Managed Service Identity (MSI). All of these are based on the OAuth standard. The following subsections describe how to set up these authentication schemes.

Note: Before you begin, confirm which authentication scheme your organization supports. If necessary, consult your System Administrator.

Entra ID (Azure AD)

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

Microsoft Entra ID is a multi-tenant, cloud-based identity and access management platform. It supports OAuth-based authentication flows that enable the driver to access Microsoft Dynamics 365 endpoints securely.

Authentication to Entra ID via a web application always requires that you first create and register a custom OAuth application. This enables your application to define its own redirect URI, manage credential scope, and comply with organization-specific security policies.

For full instructions on how to create and register a custom OAuth application, see Creating an Entra ID (Azure AD) Application.

After setting AuthScheme to AzureAD, the steps to authenticate vary, depending on the environment. For details on how to connect from desktop applications, web-based workflows, or headless systems, see the following sections.

Azure Service Principal

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

Service principals are security objects within a Microsoft Entra ID (Azure AD) application that define what that application can do within a specific tenant. Service principals are created in the Entra admin center, also accessible through the Azure portal. As part of the creation process we also specify whether the service principal will access Entra resources via a client secret or a certificate.

Depending on the service you are connecting to, a tenant administrator may need to enable Service Principal authentication or assign the Service Principal to the appropriate roles or security groups.

Instead of being tied to a particular user, service principal permissions are based on the roles assigned to them. These roles determine which resources the application can access and which operations it can perform.

When authenticating using a service principal, you must register an application with an Entra tenant, as described in Creating a Service Principal App in Entra ID (Azure AD).

This subsection describes properties you must set before you can connect. These vary, depending on whether you will authenticate via a client secret or a certificate.

Authentication with Client Secret

• AuthScheme: AzureServicePrincipal.
• AzureTenant: The Azure AD tenant to which you will connect.
• OAuthClientId: The client ID in your application settings.
• OAuthClientSecret: The client secret in your application settings.
• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

Authentication with Certificate

• AuthScheme: AzureServicePrincipalCert.
• AzureTenant: The Azure AD tenant to which you will connect.
• OAuthClientId: The client Id in your application settings.
• OAuthJWTCert: The JWT Certificate store.
• OAuthJWTCertType: The JWT Certificate store type.
• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

Managed Service Identity (MSI)

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.

User-Managed Identities

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

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

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

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

For further information, see Query Processing.

Logging

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

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

The CData Sync App models Microsoft 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.

Views

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

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.

Microsoft Dynamics 365 Connector for CData Sync Views

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.

Select

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.

• TableName supports '=','IN' operators.

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'

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

To successfully query this view, it is important to include the TableName filter, as it is required. A value must be provided for the TableName attribute in order to access the relevant functionality.

Columns

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.

Select

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.

• TableName supports '=','IN' operators.

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'

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

To successfully query this view, it is important to include the TableName filter, as it is required. A value must be provided for the TableName attribute in order to access the relevant functionality.

Columns

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.

Select

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.

• TableName supports '=','IN' operators.

For example, the following queries are processed server side:

SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'

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

To successfully query this view, it is important to include the TableName filter, as it is required. A value must be provided for the TableName attribute in order to access the relevant functionality.

Columns

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.

Select

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.

• TableName supports '=','IN' operators.

For example, the following queries are processed server side:

SELECT * FROM PickListOptions WHERE TableName = 'teams'

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

To successfully query this view, it is important to include the TableName filter, as it is required. A value must be provided for the TableName attribute in order to access the relevant functionality.

Columns

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.

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

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

Microsoft Dynamics 365 Connector for CData Sync Stored Procedures

Name	Description
CreateAssociation	Creates an association between two entities based on a navigation property. Set the IncludeNavigationProperties connection property to true in order to use this stored procedure.
GetAdminConsentURL	Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.
ListAssociations	Lists associations for a given table and navigation property. Set the IncludeNavigationProperties connection property to true in order to use this stored procedure.
ListNavigationProperties	Lists navigation properties for a given table and the tables they are associated with. Navigation properties are used by the Association stored procedures. Set the IncludeNavigationProperties connection property to true in order to use this stored procedure.
RemoveAssociation	Removes an association between two entities based on a navigation property. Set the IncludeNavigationProperties connection property to true in order to use this stored procedure.

Creates an association between two entities using the specified navigation property. This procedure is essential for linking related entities dynamically and requires the IncludeNavigationProperties connection property to be enabled.

Input

Name	Type	Required	Description
FromId	String	False	The unique identifier of the entity for which you are creating an association. This is essential to link the source entity to the target.
UrlId	String	False	The full URL of the source resource for creating the association. This is required when the navigation property is abstract or when specifying a child type in cases where the navigation property entity type serves as a base type.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId corresponds to an entity in the Customers table, set this parameter to 'Customers'.
ToNavigationProperty	String	True	The name of the navigation property on which the association is being created. This value can be retrieved from the ListNavigationProperties function.
ToId	String	False	The unique identifier of the target navigation entity. This ID should come from the table associated with the specified navigation property.
ToUrlId	String	False	The full URL of the target resource to be associated. This is required when the navigation property is abstract or when specifying a child type in cases where the navigation property entity type serves as a base type.

Result Set Columns

Name	Type	Description
Success	Boolean	Indicates whether the operation was successful. Returns true if the association was created successfully; otherwise, returns false.

Generates a schema file for a specified table or view, providing a structural blueprint for data organization.

CreateSchema

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

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

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

Input

Name	Type	Required	Description
TableName	String	True	The name of the table or view for which the schema is being created. This parameter determines the structure to be exported.
FileName	String	False	The complete file path and name where the schema file will be saved. For example, 'C:\\Users\\User\\Desktop\\D365\\Contents.rsd'.

Result Set Columns

Name	Type	Description
FileData	String	The schema file data, encoded in Base64, if neither FileName nor FileStream inputs are provided. This allows the schema to be retrieved directly as a Base64-encoded string.
Result	String	Indicates whether the schema was successfully generated and downloaded. Returns true for success and false otherwise.

Enables change tracking on an entity, allowing incremental updates and efficient data synchronization. Note: This feature is irreversible once activated.

Input

Name	Type	Required	Description
TableName	String	True	The name of the table for which change tracking should be enabled. This must be a valid table within the database.

Result Set Columns

Name	Type	Description
Success	Bool	Indicates whether the operation to enable change tracking was successful. Returns true if successful; otherwise, false.
Message	String	Provides details about any errors encountered during the operation. If no errors occurred, this is empty.

Retrieves the admin consent URL required for granting domain-wide access to the application by an administrator. Necessary when using custom OAuth credentials.

Input

Name	Type	Required	Description
CallbackUrl	String	False	The URL to which the user is redirected after authorizing your application. This must match the Reply URL configured in the Azure Active Directory application settings.
State	String	False	A value used to maintain state between the request and the callback. This should match the value you sent when requesting the authorization code to ensure security.

Result Set Columns

Name	Type	Description
URL	String	The generated authorization URL that the user must visit in a web browser to grant consent and obtain the verifier token for your application.

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

Input

Name	Type	Required	Description
AuthMode	String	False	Specifies the type of authentication being used. Use 'App' for Windows applications or 'Web' for web-based applications. The default value is APP.
Verifier	String	False	The verifier token returned by the service, required to obtain the access token. This is needed only when using the 'Web' authentication mode and is obtained by navigating to the URL provided by the GetOAuthAuthorizationUrl function.
CallbackUrl	String	False	The URL to which the user is redirected after authorizing your application. This must match the Reply URL configured in the application's Azure AD settings.
State	String	False	A value used to maintain application state between the authorization request and response. This value is echoed back by the Dynamics authorization server and can be used for purposes such as resource redirection, nonce generation, and cross-site request forgery mitigation.
Prompt	String	False	Determines the behavior of the authentication prompt. Defaults to 'select_account' to prompt the user to select an account. Use 'None' for no prompt, 'login' to force credential entry, or 'consent' to trigger the OAuth consent dialog for granting permissions.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The OAuth Access Token issued upon successful authentication. This token is used to access protected resources.
OAuthRefreshToken	String	An OAuth Refresh Token that can be used to obtain a new access token without requiring the user to reauthenticate.
ExpiresIn	String	The duration, in seconds, for which the access token is valid before it expires.

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

Input

Name	Type	Required	Description
CallbackURL	String	False	The URL to which the user is redirected after authorizing your application. This must match the Reply URL configured in the Azure Active Directory application settings.
State	String	False	A value used to maintain application state between the authorization request and response. This value is echoed back by the Dynamics authorization server and can be used for purposes such as redirecting the user to the correct resource, nonce generation, and mitigating cross-site request forgery attacks.
Prompt	String	False	Determines the behavior of the authentication prompt. Defaults to 'select_account', which prompts the user to select an account. Use 'None' for no prompt, 'login' to force credential entry, or 'consent' to trigger the OAuth consent dialog for granting app permissions.

Result Set Columns

Name	Type	Description
Url	String	The generated authorization URL that the user must open to grant permission and authorize your application.

Lists all associations for a specified table and its related navigation properties. Requires the IncludeNavigationProperties connection property to be enabled.

Input

Name	Type	Required	Description
FromId	String	False	The unique identifier of the entity for which you want to list associations. This helps specify the source entity.
UrlId	String	False	An alternative to using FromId, representing the full URL of the resource for which associations are being listed. This is required when the navigation property is abstract or when specifying child types of a base-type navigation property entity.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId corresponds to an entity in the 'Customers' table, set this parameter to 'Customers'.
NavigationProperty	String	True	The navigation property associated with the entity for which you want to list associations. This can be obtained using the ListNavigationProperties function.

Result Set Columns

Name	Type	Description
Uri	String	The URL of the associated resource, providing a direct link to the related entity.

Displays the navigation properties for a specified table, showing their relationships with associated tables. Useful for defining entity associations and dependencies.

Input

Name	Type	Required	Description
TableName	String	True	The name of the table for which you want to list navigation properties. This table must exist in the database.

Result Set Columns

Name	Type	Description
Name	String	The name of the navigation property associated with the specified table. Navigation properties define relationships to other entities.
AssociatedTable	String	The name of the table that is related to the specified table through the navigation property.

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

Input

Name	Type	Required	Description
OAuthRefreshToken	String	True	The OAuth Refresh Token obtained from the original authorization code exchange. This token is used to request a new access token without requiring user reauthentication.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The new OAuth Access Token issued by the service, used to authenticate and access protected resources.
OAuthRefreshToken	String	A new OAuth Refresh Token that can be used to obtain additional access tokens as needed.
ExpiresIn	String	The duration, in seconds, for which the new access token remains valid before expiring.

Deletes an association between two entities based on a specified navigation property. This requires the IncludeNavigationProperties connection property to be enabled.

Input

Name	Type	Required	Description
FromId	String	False	The unique identifier of the source entity for which you are removing an association. This helps specify the source entity involved in the relationship.
UrlId	String	False	An alternative to specifying the FromId. This is the full URL of the resource for which the association is being removed. It is required when the navigation property is abstract or when specifying child types for base-type navigation properties.
FromTable	String	True	The name of the table containing the source entity for which you are removing an association. For example, if the FromId corresponds to an entity in the 'Customers' table, set this parameter to 'Customers'.
ToNavigationProperty	String	True	The name of the navigation property for which the association is being removed. This value can be retrieved using the ListNavigationProperties function.
ToId	String	False	The unique identifier of the target entity in the association. This ID should come from the table related to the specified navigation property.
ToUrlId	String	False	An alternative to specifying the ToId. This is the full URL of the target resource in the association. It is required when the navigation property is abstract or when specifying child types for base-type navigation properties.

Result Set Columns

Name	Type	Description
Success	Boolean	Indicates whether the operation to remove the association was successful. Returns true if successful; otherwise, returns false.

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

Authentication

---

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.

Azure Authentication

---

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

OAuth

---

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

JWT OAuth

---

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

SSL

---

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

Firewall

---

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

Proxy

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

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	This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.
EntityTypes	When using entity definitions define what type of entities to include during metadata discovery.
IncludeFormattedValues	Specifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalName	Indicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeys	Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only).
IncludeNavigationProperties	Specifies whether the column listing should include navigation properties.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MinimumColumnSize	Specifies the minimum size, in characters, for Edm.String columns. If Microsoft Dynamics 365 reports a smaller size, the provider uses this value instead.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Microsoft Dynamics 365.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseClientSidePaging	Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.
UseDynamicStoredProcedures	Specifies whether or not stored procedures are 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 that defines 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.

Remarks

AuthScheme values include:

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

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

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

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.

Remarks

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

Specifies the Microsoft Dynamics 365 edition in use. If not specified, the default (FinOpsOnline) is assumed.

Remarks

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.

Remarks

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.

Remarks

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

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

---

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

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

Remarks

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

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

This property is required in the following cases:

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

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

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

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

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

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

Remarks

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

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

---

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

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

Remarks

This property is required in two cases:

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

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

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

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

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

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

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

Remarks

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

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

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

Notes:

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

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

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

---

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

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

Remarks

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

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

Designations of certificate stores are platform-dependent.

Notes

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

Identifies the type of key store containing the JWT Certificate.

Remarks

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

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

Remarks

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

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

Remarks

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

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

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

Common fields include:

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

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

The issuer of the Java Web Token.

Remarks

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.

Remarks

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.

Remarks

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

This property can take the following forms:

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

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

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

---

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

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

Remarks

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

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

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

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

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Microsoft 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.

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

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

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

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

Remarks

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

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

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

Remarks

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

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

For other proxy types, see FirewallType.

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

Remarks

Supported authentication types :

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

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

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

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

Remarks

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

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

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

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

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

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

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

By default, logged operations from all modules are included.

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

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

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

The available modules and submodules are:

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

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.

Remarks

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

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 .

Remarks

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

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

Remarks

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

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

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

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

Remarks

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

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

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

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	This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.
EntityTypes	When using entity definitions define what type of entities to include during metadata discovery.
IncludeFormattedValues	Specifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalName	Indicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeys	Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only).
IncludeNavigationProperties	Specifies whether the column listing should include navigation properties.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MinimumColumnSize	Specifies the minimum size, in characters, for Edm.String columns. If Microsoft Dynamics 365 reports a smaller size, the provider uses this value instead.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Microsoft Dynamics 365.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseClientSidePaging	Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.
UseDynamicStoredProcedures	Specifies whether or not stored procedures are 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 that defines 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.

Remarks

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

Remarks

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

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

Specifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.).

Remarks

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.

Remarks

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:

• Non-ASCII characters are replaced with their equivalent in the form of a "%" followed by two hexadecimal digits.
• Spaces are replaced with either a plus sign (+) or %20.

This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.

Remarks

The behavior of the Sync App is dependent on both EnableAtomicBatchOperation and ContinueOnError. The ContinueOnError option is effective only when EnableAtomicBatchOperation is set to false.

When the EnableAtomicBatchOperations property is set to true, the Create, Update, and Delete (CUD) operations within a transaction are completed successfully as a single unit. If any part of the transaction fails, the entire transaction is aborted, and the database is left unchanged. Therefore, when atomic batch operations are enabled, ContinueOnError will be ignored.

ContinueOnError can be used in conjunction with EnableAtomicBatchOperations set to true. When EnableAtomicBatchOperations is set to true, the API will ensure that if any request in the batch fails, the entire batch will be rolled back.

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

Remarks

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

Specifies whether columns that hold formatted values should be exposed.

Remarks

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

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

Remarks

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

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

Remarks

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

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

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

Specifies whether the column listing should include navigation properties.

Remarks

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

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

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

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

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

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

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

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

Remarks

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

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

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

Specifies the minimum size, in characters, for Edm.String columns. If Microsoft Dynamics 365 reports a smaller size, the provider uses this value instead.

Remarks

When the reported size of an Edm.String column from Microsoft Dynamics 365 is less than this property value, the Sync App overrides the reported size with the configured minimum.

Set this property when you need to enforce consistent column sizes or accommodate downstream systems with minimum length requirements.

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

Remarks

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

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

Integration and Formatting

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

Specifies the maximum number of records per page the provider returns when requesting data from Microsoft Dynamics 365.

Remarks

When processing a query, instead of requesting all of the queried data at once from Microsoft Dynamics 365, the Sync App can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Sync App requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.

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

Remarks

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

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

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

Remarks

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

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

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

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

Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.

Remarks

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.

Client-Side Paging

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.

If you set UseClientSidePaging to True, ensure that the value of PageSize is not set higher than the maximum value supported by the service. Setting PageSize to a higher value than supported may result in missing information.

Server-Side Paging

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.

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.

Specifies whether or not stored procedures are listed dynamically.

Remarks

Some OData services expose custom server-side actions and functions in their $metadata document. These can be treated as stored procedures in the Sync App. Enabling this property allows the Sync App to fetch the latest available stored procedures directly from the service at runtime, which is useful if the set of available procedures changes often or is not known in advance.

When set to true, the Sync App queries the service metadata for Actions and Functions and lists them as stored procedures, allowing you to execute them using EXEC, CALL, or edition-specific code.

When set to false, only the statically defined stored procedures are available.

This property is helpful when working with dynamic or evolving OData services where procedures may be added or removed without notice.

Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint.

Remarks

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 that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

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

For example:

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

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

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

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

For further information, see User Defined Views.

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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