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

Connecting to Microsoft Dataverse

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

Accessing Data from CData Cloud Services

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

Connect to Microsoft Dataverse 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.

Schema

Microsoft Dataverse supports two values for the Schema property, System and Entities.

• System: uses the Web API to query entities and tables directly.
• Entities: uses the EntityDefinitions entity set path to retrieve metadata about EntityMetadata entities and tables. This typically provides more user-friendly names, but requires additional metadata requests.

Connecting to Microsoft Dataverse

To authenticate to the Microsoft Dataverse source, begin by setting the OrganizationURL property to the URL of the organization you are connecting to.

For example: https://[organization].crm.dynamics.com.

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

The Cloud supports authentication to Microsoft Dataverse through OAuth 2.0, using Entra ID. The specific OAuth behavior depends on the value of the AuthScheme connection property, which determines the authentication flow used.

The following table outlines the relationship between AuthScheme, OAuth grant types, and typical use cases:

AuthScheme	OAuth Grant Type	Use Case
AzureAD	Authorization Code	User login with browser interaction (desktop/web), or on a separate device in headless environments
AzureServicePrincipal	Client Credentials	Application-only access using client secret
AzureServicePrincipalCert	Client Credentials	Application-only access using certificate-based authentication
AzureMSI	Managed Identity	Azure-hosted apps/services using Azure's Managed Identity

Client Credentials

Client credentials refers to a flow in OAuth where there is no direct user authentication taking place. Instead, credentials are created for just the app itself. All tasks taken by the application are done without a default user context. This makes the authentication flow a bit different from standard.

Client OAuth Flow

All permissions related to the client oauth flow require admin consent. This means the app embedded with the CData Cloud cannot be used in the client oauth flow. You must create your own OAuth app in order to use client credentials. See Creating an Entra ID (Azure AD) Application for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions - Delegated and Application permissions. The permissions used during client credential authentication are under Application Permissions. Select the applicable permissions you require for your integration.

You are ready to connect after setting one of the below connection properties groups depending on the authentication type.

1. Client Secret
   • AuthScheme Set this to AzureServicePrincipal.
   • InitiateOAuth: Set this to GETANDREFRESH. You can cuse InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • AzureTenant: Set this to the tenant you wish to connet to.
   • OAuthClientId: Set this to the Client Id in your app settings.
   • OAuthClientSecret: Set this to the Client Secret in your app settings.
2. Certificate
   • AuthScheme Set this to AzureServicePrincipalCert.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • AzureTenant: Set this to the tenant you wish to connect to.
   • OAuthClientId: Set this to the Client Id in your app settings.
   • OAuthJWTCert: Set this to the JWT Certificate store.
   • OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.

Authentication with client credentials will take place automatically like any other connection, except there will be no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections will take place and be handled internally.

Azure Service Principal

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

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For information about how to set up Azure Service Principal authentication, see Creating a Service Principal App in Entra ID (AzureAD).

Managed Service Identity (MSI)

If you are running Microsoft Dataverse on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials to connect, set AuthScheme to AzureMSI.

User-Managed Identities

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

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

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.

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.

The CData Cloud models Microsoft Dataverse data as an easy-to-use SQL database with tables, views, and stored procedures. The definitions are dynamically obtained from the Microsoft Dataverse OData service you connect to. You can load changes to the metadata, such as new or removed columns, or changes in data type, by reconnecting to the service.

The Cloud exposes two data models:

• The Entities Data Model describes the schemas available to connect to Microsoft Dataverse. You can use tables to work with live Microsoft Dataverse data.
• The System Data Model defines the underlying framework that supports core platform functionality, including security, auditing, and system-level operations.

You can use the stored procedures provided by CData Cloud to automate working with Microsoft Dataverse data.

The Entities Data Model defines, stores, and manages structured data within business applications. It enables data relationships, security, automation, and integration with Microsoft Power Platform, Dynamics 365, and external systems.

Views

The Views section, which lists read-only SQL tables, contain samples of what you may have access to in your Microsoft Dataverse account.

The following views are shipped with the Cloud:

Table	Description
MultiSelectPickListAttributeMetaData	Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.
MultiSelectPickListOptions	Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.
PickListAttributeMetaData	Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.
PickListOptions	Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.
StateAttributeMetadata	Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.
StateAttributeOptions	Lists the selectable states available for State attributes, representing various predefined states.
StatusAttributeMetadata	Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.
StatusAttributeOptions	Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including retrieving and refreshing the OAuth Access Token.

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

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

CData Cloud - Microsoft Dataverse Views

Name	Description
MultiSelectPickListAttributeMetaData	Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.
MultiSelectPickListOptions	Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.
PickListAttributeMetaData	Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.
PickListOptions	Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.
StateAttributeMetadata	Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.
StateAttributeOptions	Lists the selectable states available for State attributes, representing various predefined states.
StatusAttributeMetadata	Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.
StatusAttributeOptions	Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.

View-Specific Information

Select

The Cloud will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

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

Note that without filtering on TableName, the Cloud returns the results for the first table found.

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'

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

Columns

Name	Type	References	Description
ColumnName [KEY]	String		The name of the column in the table where the multi-select picklist is defined.
MetadataId	String		The unique identifier for the metadata associated with this attribute.
OptionSet_Description_LocalizedLabels	String		Localized descriptions of the options in the picklist for different languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String		Indicates whether the user-localized description label has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-localized description label is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label	String		The localized label text for the option set description.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the localized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the localized description label.
OptionSet_DisplayName_LocalizedLabels	String		Localized display names of the picklist options for different languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String		Indicates whether the user-localized display name label has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-localized display name label is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label	String		The localized label text for the option set display name.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the localized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the localized display name label.
OptionSet_ExternalTypeName	String		The external type name associated with the option set, if applicable.
OptionSet_HasChanged	String		Indicates if the option set has been modified.
OptionSet_IntroducedVersion	String		The version of the system in which the option set was introduced.
OptionSet_IsCustomizable_CanBeChanged	Boolean		Indicates whether the option set can be customized.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String		The logical name of the managed property that controls the customizability of the option set.
OptionSet_IsCustomizable_Value	Boolean		Specifies if the option set is customizable.
OptionSet_IsCustomOptionSet	Boolean		Indicates whether the option set is custom or part of a managed solution.
OptionSet_IsGlobal	Boolean		Specifies if the option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged	Boolean		Indicates if the option set is managed (part of a managed solution).
OptionSet_MetadataId	String		The unique identifier for the metadata associated with the option set.
OptionSet_Name	String		The name of the option set.
OptionSet_OptionSetType	String		The type of the option set (e.g., picklist, multi-select).
OptionSet_ParentOptionSetName	String		The name of the parent option set, if this option set is part of a hierarchy.
TableName	String		The name of the table where this multi-select picklist attribute is defined.

Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.

View-Specific Information

Select

The Cloud will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

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

Note that without filtering on TableName, the Cloud returns the results for the first table found.

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'

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

Columns

Name	Type	References	Description
ColumnName	String	MultiSelectPickListAttributeMetaData.ColumnName	The name of the column in the table where the multi-select picklist option is defined.
Color	String		The color code associated with the picklist option, often used for UI display purposes.
ExternalValue	String		An external system value mapped to this picklist option, if applicable.
HasChanged	String		Indicates whether the option has been modified since its creation or last update.
IsManaged	Boolean		Specifies if the picklist option is managed (part of a managed solution).
Label_LocalizedLabels	String		Localized labels for the picklist option in different languages.
Label_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized label for the picklist option has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized label for the picklist option is managed.
Label_UserLocalizedLabel_Label	String		The user-customized label text for the picklist option.
Label_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized label.
Description_LocalizedLabels	String		Localized descriptions for the picklist option in different languages.
Description_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized description for the picklist option has been modified.
Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized description for the picklist option is managed.
Description_UserLocalizedLabel_Label	String		The user-customized description text for the picklist option.
Description_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized description.
Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized description.
MetadataId	String		The unique identifier for the metadata associated with the picklist option.
ParentValues	String		Specifies the parent values for hierarchical picklist options, if applicable.
Value	Integer		The integer value associated with this picklist option, used for storage and retrieval.
TableName	String		The name of the table where this picklist option is defined.

Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.

View-Specific Information

Select

The Cloud will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

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

Note that without filtering on TableName, the Cloud returns the results for the first table found.

For example, the following queries are processed server side:

SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'

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

Columns

Name	Type	References	Description
ColumnName [KEY]	String		The name of the column in the table where the picklist attribute is defined.
MetadataId	String		The unique identifier for the metadata associated with this attribute.
OptionSet_Description_LocalizedLabels	String		Localized descriptions of the options in the picklist for various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized description label has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized description label is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label	String		The localized label text for the description of the picklist.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-localized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-localized description label.
OptionSet_DisplayName_LocalizedLabels	String		Localized display names for the picklist options in various languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized display name label has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized display name label is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label	String		The localized label text for the display name of the picklist.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-localized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-localized display name label.
OptionSet_ExternalTypeName	String		The external type name associated with the option set, if applicable.
OptionSet_HasChanged	String		Indicates if the option set has been modified since its creation or last update.
OptionSet_IntroducedVersion	String		The version of the system in which the option set was introduced.
OptionSet_IsCustomizable_CanBeChanged	Boolean		Indicates whether the option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String		The logical name of the managed property controlling customizability of the option set.
OptionSet_IsCustomizable_Value	Boolean		Specifies if the option set is customizable.
OptionSet_IsCustomOptionSet	Boolean		Indicates whether the option set is custom or part of a default configuration.
OptionSet_IsGlobal	Boolean		Specifies if the option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged	Boolean		Indicates if the option set is managed (part of a managed solution).
OptionSet_MetadataId	String		The unique identifier for the metadata associated with the option set.
OptionSet_Name	String		The name of the option set.
OptionSet_OptionSetType	String		The type of the option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName	String		The name of the parent option set, if this option set is part of a hierarchy.
TableName	String		The name of the table where the picklist attribute is defined.

Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.

View-Specific Information

Select

The Cloud will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

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

Note that without filtering on TableName, the Cloud returns the results for the first table found.

For example, the following queries are processed server side:

SELECT * FROM PickListOptions WHERE TableName = 'teams'

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

Columns

Name	Type	References	Description
ColumnName	String	PickListAttributeMetaData.ColumnName	The name of the column in the table where the picklist option is defined.
Color	String		The color code associated with the picklist option, often used for display purposes in user interfaces.
ExternalValue	String		An external value associated with this picklist option, used for integration with external systems.
HasChanged	String		Indicates whether the picklist option has been modified since its creation or last update.
IsManaged	Boolean		Specifies if the picklist option is managed (part of a managed solution).
Label_LocalizedLabels	String		Localized labels for the picklist option in multiple languages.
Label_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized label for the picklist option has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized label for the picklist option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label	String		The user-customized label text for the picklist option.
Label_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels	String		Localized descriptions for the picklist option in various supported languages.
Description_UserLocalizedLabel	String		The user-customized description for the picklist option, providing additional context or meaning.
MetadataId	String		The unique identifier for the metadata associated with this picklist option.
ParentValues	String		Specifies the parent values for hierarchical picklist options, if applicable.
Value	Integer		The integer value associated with this picklist option, used for storage and retrieval.
TableName	String		The name of the table where this picklist option is defined.

Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.

View-Specific Information

Select

Note that without filtering on TableName, the Cloud returns the results for the first table found.

The following examples show how to query the view for a specific table or list of tables:

SELECT * FROM StateAttributeMetaData WHERE TableName='AccountLeads'

SELECT * FROM StateAttributeMetaData WHERE TableName IN ('Account','AccountLead');

Columns

Name	Type	References	Description
ColumnName [KEY]	String		The name of the column in the table where the state attribute is defined.
MetadataId	String		The unique identifier for the metadata associated with this state attribute.
OptionSet_Description_LocalizedLabels	String		Localized descriptions for the state options in various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized description label for the state options has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized description label for the state options is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label	String		The user-customized label text for the description of the state options.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-customized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized description label.
OptionSet_DisplayName_LocalizedLabels	String		Localized display names for the state options in various supported languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized display name label for the state options has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized display name label for the state options is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label	String		The user-customized label text for the display name of the state options.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-customized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized display name label.
OptionSet_ExternalTypeName	String		The external type name associated with the state options, if applicable.
OptionSet_HasChanged	String		Indicates whether the state option set has been modified since its creation or last update.
OptionSet_IntroducedVersion	String		The version of the system in which the state option set was introduced.
OptionSet_IsCustomizable_CanBeChanged	Boolean		Indicates whether the state option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String		The logical name of the managed property controlling the customizability of the state option set.
OptionSet_IsCustomizable_Value	Boolean		Specifies if the state option set is customizable.
OptionSet_IsCustomOptionSet	Boolean		Indicates whether the state option set is custom or part of a default configuration.
OptionSet_IsGlobal	Boolean		Specifies if the state option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged	Boolean		Indicates if the state option set is managed (part of a managed solution).
OptionSet_MetadataId	String		The unique identifier for the metadata associated with the state option set.
OptionSet_Name	String		The name of the state option set.
OptionSet_OptionSetType	String		The type of the state option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName	String		The name of the parent option set, if this state option set is part of a hierarchy.
TableName	String		The name of the table where this state attribute is defined.

Lists the selectable states available for State attributes, representing various predefined states.

View-Specific Information

Select

Note that without filtering on TableName, the Cloud returns the results for the first table found.

The following examples show how to query the view for a specific table or list of tables:

SELECT * FROM StateAttributeOptions WHERE TableName='AccountLeads'

SELECT * FROM StateAttributeOptions WHERE TableName IN ('Account','AccountLead');

Columns

Name	Type	References	Description
ColumnName	String	StateAttributeMetadata.ColumnName	The name of the column in the table where the state option is defined.
Color	String		The color code associated with the state option, often used for UI representation.
ExternalValue	String		An external system value mapped to this state option, if applicable.
HasChanged	String		Indicates whether the state option has been modified since its creation or last update.
IsManaged	Boolean		Specifies if the state option is managed (part of a managed solution).
Label_LocalizedLabels	String		Localized labels for the state option in various supported languages.
Label_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized label for the state option has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized label for the state option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label	String		The user-customized label text for the state option.
Label_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels	String		Localized descriptions for the state option in various supported languages.
Description_UserLocalizedLabel	String		The user-customized description for the state option, providing additional context or details.
MetadataId	String		The unique identifier for the metadata associated with the state option.
ParentValues	String		Specifies the parent values for hierarchical state options, if applicable.
Value	Integer		The integer value associated with this state option, used for storage and retrieval.
TableName	String		The name of the table where this state option is defined.

Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.

View-Specific Information

Select

Note that without filtering on TableName, the Cloud returns the results for the first table found.

The following examples show how to query the view for a specific table or list of tables:

SELECT * FROM StatusAttributeMetaData WHERE TableName='AccountLeads'

SELECT * FROM StatusAttributeMetaData WHERE TableName IN ('Account','AccountLead');

Columns

Name	Type	References	Description
ColumnName [KEY]	String		The name of the column in the table where the status attribute is defined.
MetadataId	String		The unique identifier for the metadata associated with this status attribute.
OptionSet_Description_LocalizedLabels	String		Localized descriptions for the status options in various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized description label for the status options has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized description label for the status options is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label	String		The user-customized label text for the description of the status options.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-customized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized description label.
OptionSet_DisplayName_LocalizedLabels	String		Localized display names for the status options in various supported languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String		Indicates whether the user-customized display name label for the status options has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized display name label for the status options is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label	String		The user-customized label text for the display name of the status options.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer		The language code associated with the user-customized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata of the user-customized display name label.
OptionSet_ExternalTypeName	String		The external type name associated with the status options, if applicable.
OptionSet_HasChanged	String		Indicates whether the status option set has been modified since its creation or last update.
OptionSet_IntroducedVersion	String		The version of the system in which the status option set was introduced.
OptionSet_IsCustomizable_CanBeChanged	Boolean		Indicates whether the status option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String		The logical name of the managed property controlling the customizability of the status option set.
OptionSet_IsCustomizable_Value	Boolean		Specifies if the status option set is customizable.
OptionSet_IsCustomOptionSet	Boolean		Indicates whether the status option set is custom or part of a default configuration.
OptionSet_IsGlobal	Boolean		Specifies if the status option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged	Boolean		Indicates if the status option set is managed (part of a managed solution).
OptionSet_MetadataId	String		The unique identifier for the metadata associated with the status option set.
OptionSet_Name	String		The name of the status option set.
OptionSet_OptionSetType	String		The type of the status option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName	String		The name of the parent option set, if this status option set is part of a hierarchy.
TableName	String		The name of the table where this status attribute is defined.

Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

View-Specific Information

Select

Note that without filtering on TableName, the Cloud returns the results for the first table found.

The following examples show how to query the view for a specific table or list of tables:

SELECT * FROM StatusAttributesOptions WHERE TableName='AccountLeads'

SELECT * FROM StatusAttributesOptions WHERE TableName IN ('Account','AccountLead');

Columns

Name	Type	References	Description
ColumnName	String	StatusAttributeMetadata.ColumnName	The name of the column in the table where the status option is defined.
Color	String		The color code associated with the status option, typically used for visual representation in user interfaces.
ExternalValue	String		An external system value mapped to this status option, if applicable.
HasChanged	String		Indicates whether the status option has been modified since its creation or last update.
IsManaged	Boolean		Specifies if the status option is managed (part of a managed solution).
Label_LocalizedLabels	String		Localized labels for the status option in various supported languages.
Label_UserLocalizedLabel_HasChanged	String		Indicates if the user-customized label for the status option has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean		Specifies if the user-customized label for the status option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label	String		The user-customized label text for the status option.
Label_UserLocalizedLabel_LanguageCode	Integer		The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId	String		The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels	String		Localized descriptions for the status option in various supported languages.
Description_UserLocalizedLabel	String		The user-customized description for the status option, providing additional context or details.
MetadataId	String		The unique identifier for the metadata associated with the status option.
ParentValues	String		Specifies the parent values for hierarchical status options, if applicable.
Value	Integer		The integer value associated with this status option, used for storage and retrieval.
TableName	String		The name of the table where this status option is defined.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Dataverse.

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

CData Cloud - Microsoft Dataverse Stored Procedures

Name	Description

The System Data Model defines the underlying framework that supports core platform functionality, including security, auditing, and system-level operations. It manages metadata, user roles, workflows, and background processes to ensure seamless data governance and integration across business applications.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including retrieving and refreshing the OAuth Access Token.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Dataverse.

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

CData Cloud - Microsoft Dataverse Stored Procedures

Name	Description
CreateAssociation	Establishes a link between two entities using their navigation properties. Requires navigation properties to be enabled in the connection configuration.
ListAssociations	Displays all associations for a specified table and its navigation properties, detailing entity relationships.
ListNavigationProperties	Lists navigation properties for a specified table and its associated tables, aiding in relationship discovery.
RemoveAssociation	Deletes a previously established link between two entities, managed via their navigation properties.

Establishes a link between two entities using their navigation properties. Requires navigation properties to be enabled in the connection configuration.

Input

Name	Type	Required	Description
FromId	String	True	The unique identifier (Id) of the source entity for which you are establishing an association.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId belongs to a record in the Customers table, set this parameter to 'Customers'.
ToNavigationProperty	String	True	The name of the navigation property used to define the relationship. This property can be retrieved using the ListNavigationProperties procedure.
ToId	String	True	The unique identifier (Id) of the target entity in the associated table defined by the navigation property.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the association creation operation was successful (true) or failed (false).

Displays all associations for a specified table and its navigation properties, detailing entity relationships.

Input

Name	Type	Required	Description
FromId	String	True	The unique identifier (Id) of the source entity for which you want to list associated entities.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId belongs to a record in the Customers table, set this parameter to 'Customers'.
NavigationProperty	String	True	The name of the navigation property representing the relationship you want to retrieve. This can be obtained using the ListNavigationProperties procedure.

Result Set Columns

Name	Type	Description
Uri	String	The URL linking to the associated entities, providing a way to access the related records through the specified navigation property.

Lists navigation properties for a specified table and its associated tables, aiding in relationship discovery.

Input

Name	Type	Required	Description
TableName	String	True	The name of the table for which you want to list the available navigation properties. This table represents the source of the relationships.

Result Set Columns

Name	Type	Description
Name	String	The name of the navigation property that defines a relationship or association within the specified table.
AssociatedTable	String	The name of the table that the navigation property links to, representing the target entity in the relationship.

Deletes a previously established link between two entities, managed via their navigation properties.

Input

Name	Type	Required	Description
FromId	String	True	The unique identifier (Id) of the source entity for which you want to remove an association.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId belongs to a record in the Customers table, set this parameter to 'Customers'.
ToNavigationProperty	String	True	The name of the navigation property representing the relationship to be removed. This property can be retrieved using the ListNavigationProperties procedure.
ToId	String	True	The unique identifier (Id) of the target entity in the associated table defined by the navigation property.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the removal operation was successful (true) or not (false).

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 Dataverse:

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

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.

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.

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.

Describes the columns of the available tables and views.

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

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

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.

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.

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

Describes the primary and foreign keys.

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

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

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.

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.

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.

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.

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.

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.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported 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_FUNCTIONS	Supported 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_FUNCTIONS	Supported 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_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A 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_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All 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_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates 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.

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.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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 Dataverse (OData V4)	CData Schema
Edm.Binary	binary
Edm.Boolean	bool
Edm.Date	datetime
Edm.DateTimeOffset	datetime
Edm.Decimal	decimal
Edm.Double	double
Edm.Guid	guid
Edm.Int32	int
Edm.String	string
Edm.TimeOfDay	time

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

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

Authentication

---

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Microsoft Dataverse. If this property is left blank, the default authentication is used.
OrganizationURL	The URL to your Dynamics 365 organization, sometimes referred to as the resource. To find the correct URL for your Microsoft Dataverse instance, search the Web Services page.
ApiVersion	Identifies the API version being used. Keep this setting up to date to ensure that the full range of available API features are accessed during authentication.

Azure Authentication

---

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

OAuth

---

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

JWT OAuth

---

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

SSL

---

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

Logging

---

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

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Schema	Specifies the schema to use when listing metadata from Microsoft Dataverse.

Miscellaneous

---

Property	Description
AllowNavigationDisassociation	Specifies whether the provider binds navigation properties to null values.
ContinueOnError	Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
EntityTypes	When using entity definitions define what type of entities to include during metadata discovery.
IncludeFormattedValues	Specifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalName	Indicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeys	Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only).
IncludeNavigationProperties	Specifies whether the column listing should include navigation properties.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseDisplayNames	If set to true, the provider will use display names for some operations.

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

---

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Microsoft Dataverse. If this property is left blank, the default authentication is used.
OrganizationURL	The URL to your Dynamics 365 organization, sometimes referred to as the resource. To find the correct URL for your Microsoft Dataverse instance, search the Web Services page.
ApiVersion	Identifies the API version being used. Keep this setting up to date to ensure that the full range of available API features are accessed during authentication.

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

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

The URL to your Dynamics 365 organization, sometimes referred to as the resource. To find the correct URL for your Microsoft Dataverse instance, search the Web Services page.

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

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.

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

---

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

Identifies the Microsoft Dataverse 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.

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.

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

---

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

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

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.

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

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

---

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

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

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

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

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

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.

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:

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

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

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

---

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

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

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.

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

---

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

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.

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

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Schema	Specifies the schema to use when listing metadata from Microsoft Dataverse.

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.

Specifies the schema to use when listing metadata from Microsoft Dataverse.

Possible Values

System, Entities

Data Type

string

Default Value

"System"

Remarks

You can set this connection property to the following values:

• System: Exposes Microsoft Dataverse objects with less detailed metadata. Tables use system-level names. Due to the relative simplicity of the metadata returned, retrieving data from this schema is faster. This schema is selected by default.
• Entities: Exposes Microsoft Dataverse objects with more detailed metadata (including details about annotations and data types), as well as more user-friendly table names. Due to the increased complexity of the metadata returned, retrieving data from this schema takes longer.

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

---

Property	Description
AllowNavigationDisassociation	Specifies whether the provider binds navigation properties to null values.
ContinueOnError	Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
EntityTypes	When using entity definitions define what type of entities to include during metadata discovery.
IncludeFormattedValues	Specifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalName	Indicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeys	Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only).
IncludeNavigationProperties	Specifies whether the column listing should include navigation properties.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseDisplayNames	If set to true, the provider will use display names for some operations.

Specifies whether the provider binds navigation properties to null values.

Data Type

bool

Default Value

false

Remarks

In Microsoft Dataverse, navigation properties represent relationships between entities. Disassociating a navigation property removes the relationship, and some services support doing this by binding the property to a null value.

When set to true, the Cloud binds navigation properties to null in INSERT or UPDATE requests when those properties are set to null and the Microsoft Dataverse supports null binding. This can be used to disassociate navigation properties.

When set to false, navigation properties set to null or an empty string are omitted from the request body.

This property is useful when you need to explicitly remove or disassociate related entities through null binding.

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.

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.

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.

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.

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.

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

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.

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:

*=*

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.

If set to true, the provider will use display names for some operations.

Data Type

bool

Default Value

false

Remarks

If set to true, the Cloud will use display names for some operations. This property is used only for Entities schema.

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.