Cloud

Build 25.0.9434
  • Microsoft Dynamics 365
    • Getting Started
      • Establishing a Connection
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
      • Views
        • MultiSelectPickListAttributeMetaData
        • MultiSelectPickListOptions
        • PickListAttributeMetaData
        • PickListOptions
      • Stored Procedures
        • CreateAssociation
        • EnableChangeTracking
        • GetAdminConsentURL
        • ListAssociations
        • ListNavigationProperties
        • RemoveAssociation
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
      • Data Type Mapping
    • Connection String Options
      • Authentication
        • AuthScheme
        • OrganizationURL
        • Edition
        • ApiVersion
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
        • OAuthJWTIssuer
        • OAuthJWTSubject
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • AllowDuplicateRecords
        • ContinueOnError
        • CrossCompany
        • CustomURLParams
        • EnableAtomicBatchOperations
        • EntityTypes
        • IncludeFormattedValues
        • IncludeLookUpLogicalName
        • IncludeNavigationKeys
        • IncludeNavigationProperties
        • MaxRows
        • MinimumColumnSize
        • Pagesize
        • PseudoColumns
        • Timeout
        • UseClientSidePaging
        • UseDynamicStoredProcedures
        • UseEntityDefinitions
    • Third Party Copyrights

Microsoft Dynamics 365 - CData Cloud

Overview

CData Cloud offers access to Microsoft Dynamics 365 across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Microsoft Dynamics 365 through CData Cloud.

CData Cloud allows you to standardize and configure connections to Microsoft Dynamics 365 as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: Microsoft Dynamics 365 appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

This page provides a guide to Establishing a Connection to Microsoft Dynamics 365 in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Microsoft Dynamics 365

Establishing a Connection shows how to authenticate to Microsoft Dynamics 365 and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Microsoft Dynamics 365 through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

CData Cloud

Establishing a Connection

Connect to Microsoft Dynamics 365 by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

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.

CData Cloud

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud 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.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Cloud 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.

CData Cloud

Data Model

The CData Cloud 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 Cloud:

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.

CData Cloud

Tables

The Cloud uses the Microsoft Dynamics 365 OData services to dynamically retrieve all of your Microsoft Dynamics 365 tables when you connect.

CData Cloud

Views

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

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

CData Cloud - Microsoft Dynamics 365 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.

CData Cloud

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.

Select

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

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

CData Cloud

MultiSelectPickListOptions

Contains the values (options) for MultiSelect Picklist metadata attributes. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.

Select

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

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

CData Cloud

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.

Select

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

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

CData Cloud

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.

Select

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

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

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud 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.

CData Cloud - Microsoft Dynamics 365 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.

CData Cloud

CreateAssociation

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.

CData Cloud

EnableChangeTracking

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.

CData Cloud

GetAdminConsentURL

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.

CData Cloud

ListAssociations

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.

CData Cloud

ListNavigationProperties

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.

CData Cloud

RemoveAssociation

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.

CData Cloud

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Microsoft Dynamics 365:

  • sys_catalogs: Lists the available databases.
  • sys_schemas: Lists the available schemas.
  • sys_tables: Lists the available tables and views.
  • sys_tablecolumns: Describes the columns of the available tables and views.
  • sys_procedures: Describes the available stored procedures.
  • sys_procedureparameters: Describes stored procedure parameters.
  • sys_keycolumns: Describes the primary and foreign keys.
  • sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

  • sys_identity: Returns information about batch operations or single updates.

CData Cloud

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Cloud

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

CData Cloud

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the GoalHeadings table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='GoalHeadings' 

Columns

Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

CData Cloud

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

CData Cloud

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native Microsoft Dynamics 365 procedure.

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Cloud

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the GoalHeadings table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='GoalHeadings' 
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

CData Cloud

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

CData Cloud

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

CData Cloud

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

CData Cloud

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

CData Cloud

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported string functions.LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSSupported numeric functions.ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSSupported date/time functions.NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll supported SQL capabilities for this driver.SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

CData Cloud

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String The database-generated Id returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Data Type Mapping

Data Type Mappings

The Cloud 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

CData Cloud

Connection String Options

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

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

Authentication


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to Microsoft Dynamics 365. If this property is left blank, the default authentication is used.
OrganizationURLThe 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.
EditionSpecifies the Microsoft Dynamics 365 edition in use. If not specified, the default (FinOpsOnline) is assumed.
ApiVersionIdentifies 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


PropertyDescription
AzureTenantIdentifies 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.
AzureEnvironmentSpecifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

OAuth


PropertyDescription
OAuthClientIdSpecifies 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.
OAuthClientSecretSpecifies 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


PropertyDescription
OAuthJWTCertSupplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertTypeIdentifies the type of key store containing the JWT Certificate.
OAuthJWTCertPasswordProvides 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.
OAuthJWTCertSubjectIdentifies 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.
OAuthJWTIssuerThe issuer of the Java Web Token.
OAuthJWTSubjectThe user subject for which the application is requesting delegated access.

SSL


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

Logging


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema


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

Miscellaneous


PropertyDescription
AllowDuplicateRecordsNotes 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.
ContinueOnErrorSpecifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
CrossCompanySpecifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.).
CustomURLParamsA string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.
EnableAtomicBatchOperationsThis 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.
EntityTypesWhen using entity definitions define what type of entities to include during metadata discovery.
IncludeFormattedValuesSpecifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalNameIndicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeysSpecifies whether the column listing should include the primary keys of navigation properties. (JSON responses only).
IncludeNavigationPropertiesSpecifies whether the column listing should include navigation properties.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MinimumColumnSizeSpecifies the minimum size, in characters, for Edm.String columns. If Microsoft Dynamics 365 reports a smaller size, the provider uses this value instead.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Microsoft Dynamics 365.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseClientSidePagingSpecifies 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.
UseDynamicStoredProceduresSpecifies whether or not stored procedures are listed dynamically.
UseEntityDefinitionsSpecifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint.
CData Cloud

Authentication

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


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to Microsoft Dynamics 365. If this property is left blank, the default authentication is used.
OrganizationURLThe 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.
EditionSpecifies the Microsoft Dynamics 365 edition in use. If not specified, the default (FinOpsOnline) is assumed.
ApiVersionIdentifies 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.
CData Cloud

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.

Possible Values

AzureAD, AzureServicePrincipal, AzureServicePrincipalCert

Data Type

string

Default Value

"AzureAD"

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

CData Cloud

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.

Data Type

string

Default Value

""

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

CData Cloud

Edition

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

Possible Values

CustomerService, FieldService, FinOpsOnline, HumanResources, Marketing, ProjectOperations, Sales, Commerce

Data Type

string

Default Value

"FinOpsOnline"

Remarks

If the edition is FinOpsOnPremise, you must also specify the ADFSServer.

CData Cloud

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.

Data Type

string

Default Value

"9.2"

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.

CData Cloud

Azure Authentication

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


PropertyDescription
AzureTenantIdentifies 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.
AzureEnvironmentSpecifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.
CData Cloud

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.

Data Type

string

Default Value

""

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.

CData Cloud

AzureEnvironment

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

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

Data Type

string

Default Value

"GLOBAL"

Remarks

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

CData Cloud

OAuth

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


PropertyDescription
OAuthClientIdSpecifies 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.
OAuthClientSecretSpecifies 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.).
CData Cloud

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.

Data Type

string

Default Value

""

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

CData Cloud

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

Data Type

string

Default Value

""

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

CData Cloud

JWT OAuth

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


PropertyDescription
OAuthJWTCertSupplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertTypeIdentifies the type of key store containing the JWT Certificate.
OAuthJWTCertPasswordProvides 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.
OAuthJWTCertSubjectIdentifies 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.
OAuthJWTIssuerThe issuer of the Java Web Token.
OAuthJWTSubjectThe user subject for which the application is requesting delegated access.
CData Cloud

OAuthJWTCert

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

Data Type

string

Default Value

""

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

CData Cloud

OAuthJWTCertType

Identifies the type of key store containing the JWT Certificate.

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB

Data Type

string

Default Value

"PEMKEY_BLOB"

Remarks

ValueDescriptionNotes
USERA certificate store owned by the current user. Only available in Windows.
MACHINEA machine store.Not available in Java or other non-Windows environments.
PFXFILEA PFX (PKCS12) file containing certificates.
PFXBLOBA string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILEA Java key store (JKS) file containing certificates.Only available in Java.
JKSBLOBA string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Only available in Java.
PEMKEY_FILEA PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOBA string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILEA file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOBA string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILEA file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOBA string (base-64-encoded) that contains an SSH-style public key.
P7BFILEA PKCS7 file containing certificates.
PPKFILEA file that contains a PPK (PuTTY Private Key).
XMLFILEA file that contains a certificate in XML format.
XMLBLOBAstring that contains a certificate in XML format.
BCFKSFILEA file that contains an Bouncy Castle keystore.
BCFKSBLOBA string (base-64-encoded) that contains a Bouncy Castle keystore.

CData Cloud

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.

Data Type

string

Default Value

""

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.

CData Cloud

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.

Data Type

string

Default Value

"*"

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:

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

CData Cloud

OAuthJWTIssuer

The issuer of the Java Web Token.

Data Type

string

Default Value

""

Remarks

The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.

CData Cloud

OAuthJWTSubject

The user subject for which the application is requesting delegated access.

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.

CData Cloud

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

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

Data Type

string

Default Value

""

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.

CData Cloud

Logging

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


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
CData Cloud

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Cloud

Schema

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


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

BrowsableSchemas

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

Data Type

string

Default Value

""

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.

CData Cloud

Miscellaneous

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


PropertyDescription
AllowDuplicateRecordsNotes 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.
ContinueOnErrorSpecifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
CrossCompanySpecifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.).
CustomURLParamsA string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.
EnableAtomicBatchOperationsThis 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.
EntityTypesWhen using entity definitions define what type of entities to include during metadata discovery.
IncludeFormattedValuesSpecifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalNameIndicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeysSpecifies whether the column listing should include the primary keys of navigation properties. (JSON responses only).
IncludeNavigationPropertiesSpecifies whether the column listing should include navigation properties.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MinimumColumnSizeSpecifies the minimum size, in characters, for Edm.String columns. If Microsoft Dynamics 365 reports a smaller size, the provider uses this value instead.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Microsoft Dynamics 365.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseClientSidePagingSpecifies 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.
UseDynamicStoredProceduresSpecifies whether or not stored procedures are listed dynamically.
UseEntityDefinitionsSpecifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint.
CData Cloud

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.

Data Type

bool

Default Value

true

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.

CData Cloud

ContinueOnError

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

Data Type

bool

Default Value

false

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.

CData Cloud

CrossCompany

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

Data Type

bool

Default Value

false

Remarks

This property only applies when Edition is set to FinOpsOnline, FinOpsOnPremise or HumanResources.

CData Cloud

CustomURLParams

A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.

Data Type

string

Default Value

""

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.

CData Cloud

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.

Data Type

bool

Default Value

true

Remarks

The behavior of the Cloud 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.

CData Cloud

EntityTypes

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

Possible Values

PUBLIC, ALL

Data Type

string

Default Value

"ALL"

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.

CData Cloud

IncludeFormattedValues

Specifies whether columns that hold formatted values should be exposed.

Data Type

bool

Default Value

false

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.

CData Cloud

IncludeLookUpLogicalName

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

Data Type

bool

Default Value

false

Remarks

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

CData Cloud

IncludeNavigationKeys

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

Data Type

bool

Default Value

false

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.

CData Cloud

IncludeNavigationProperties

Specifies whether the column listing should include navigation properties.

Data Type

bool

Default Value

false

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

CData Cloud

MaxRows

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

Data Type

int

Default Value

-1

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.

CData Cloud

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.

Data Type

int

Default Value

0

Remarks

When the reported size of an Edm.String column from Microsoft Dynamics 365 is less than this property value, the Cloud 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.

CData Cloud

Pagesize

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

Data Type

int

Default Value

5000

Remarks

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

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

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

CData Cloud

PseudoColumns

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

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud 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:

*=*

CData Cloud

Timeout

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

Data Type

int

Default Value

60

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.

CData Cloud

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.

Data Type

bool

Default Value

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.

CData Cloud

UseDynamicStoredProcedures

Specifies whether or not stored procedures are listed dynamically.

Data Type

bool

Default Value

false

Remarks

Some OData services expose custom server-side actions and functions in their $metadata document. These can be treated as stored procedures in the Cloud. Enabling this property allows the Cloud 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 Cloud 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.

CData Cloud

UseEntityDefinitions

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

Data Type

bool

Default Value

false

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.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

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.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434