Microsoft Dynamics 365 Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

Microsoft Dynamics 365 Version Support

The connector supports read/write access to Microsoft Dynamics 365 through OData Web services.

Establish a Connection

Connect to Microsoft Dynamics 365

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

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

Notes:

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

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

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

Authenticate to Microsoft Dynamics 365

Microsoft Dynamics 365 supports authentication via Microsoft Entra ID (Microsoft Entra ID), Microsoft Entra service principal, or Azure Managed Service Identity (MSI). All of these are based on the OAuth standard.

The following subsections describe how to set up these authentication schemes.

Note:

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

Microsoft Entra ID (Microsoft Entra ID)

Authenticating via Microsoft Entra ID requires you to create a custom app registration, as described in Creating an Entra ID (Microsoft Entra ID) Application. You can authenticate with either a client secret or a JWT certificate.

To connect, set these properties:

• AuthScheme: Microsoft Entra ID.
• InitiateOAuth: GETANDREFRESH. This setting enables you to use InitiateOAuth to avoid repeating the Microsoft Entra ID exchange and manually setting the OAuthAccessToken.
• AzureTenant: The Azure tenant to which you will connect.
• OAuthClientId: The Client ID assigned when you created your custom application.
• OAuthClientSecret (Client Secret only): The Client Secret assigned when you created your custom application.
• OAuthJWTCert (Certificate only): The JWT Certificate store.
• OAuthJWTCertType (Certificate only): The type of the certificate store specified by OAuthJWTCert.

Admin Consent

Admin consent refers to permissions granted by a Microsoft Entra ID Tenant's admin to a custom application, as required for the use case.

(Since the embedded application within the Microsoft Dynamics 365 connector contains no permissions that require Admin consent, admin consent only applies to custom applications.)

If your organization requires admin consent for authorizing any new OAuth application for your Azure Tenant, it means that the first time someone in your organization installs and uses an OAuth application, an administrator for the organization must explicitly grant that application access.

(Your organization can choose to disable this requirement.)

Granting Admin Consent

When creating a new OAuth application in the Azure Portal (see Creating an Entra ID (Microsoft Entra ID) Application), you must specify which permissions the application requires. If you know that your organization requires admin consent for new custom applications, you can start by specifying permissions that are already labeled Admin Consent Required. (For example, all Groups permissions require admin consent.)

There are two ways to grant admin consent:

• The easiest way to grant admin consent is to just have an admin log into portal.azure.com and navigate to the application you have created in App Registrations.

  Under API Permissions, click Grant Consent. This grants your application the necessary permissions on the tenant on which it was created.

• If your organization has multiple tenants or the application needs to be granted permissions for other tenants outside your organization, you can use the GetAdminConsentURL to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationUrl, there is no important information returned from this endpoint. If the tenant grants access, it returns a Boolean confirming that permissions were granted.

After an admin grants consent, authentication is performed as usual.

Client Credentials Auth Flow

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

All permissions related to the client OAuth flow require admin consent.

This means the application embedded with the Microsoft Dynamics 365 connector cannot be used in the client OAuth flow. You must create your own OAuth application to use client credentials, as described in Creating an Entra ID (Microsoft Entra ID) Application.

To do this:

1. Login to portal.azure.com.

2. Navigate to App Registration > API Permissions.

3. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated Permissions and Application permissions.

   The permissions used during client credential authentication are under Application Permissions. Select the applicable permissions you require for your integration.

To connect, set these properties:

• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• AzureTenant: The tenant to which you will connect.
• OAuthClientId: The Client ID assigned when you created your custom application.
• OAuthClientSecret (Client Secret only): The Client Secret assigned when you created your custom application.
• OAuthJWTCert (Certificate only): The JWT Certificate store.
• OAuthJWTCertType (Certificate only): The type of the certificate store specified by OAuthJWTCert.

Microsoft Entra service principal

Actions in Microsoft Entra ID can be run by either user accounts or service principals. A service principal is a non-interactive account with elevated permissions, that performs tasks based on the roles and permissions assigned.

Authentication as a Microsoft Entra service principal is handled via the OAuth Client Credentials flow, without user involvement.

Authentication as a Microsoft Entra service principal requires you to create a custom Microsoft Entra ID Service Principal application, as described in Creating a Service Principal App with Entra ID (Microsoft Entra ID).

When you are ready to connect, set these properties:

• AuthScheme: AzureServicePrincipal for using a Client Secret or AzureServicePrincipalCert for using a JWT certificate.
• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• AzureTenant: The tenant you want to connect to.
• OAuthClientId (Client Secret only): The Client ID in your application settings.
• OAuthClientSecret (Client Secret only): The Client Secret assigned when you created your custom application.
• OAuthJWTCert (Certificate only): The JWT Certificate store.
• OAuthJWTCertType (Certificate only): The type of the certificate store specified by OAuthJWTCert.

Managed Service Identity (MSI)

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

User-Managed Identities

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

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

Create an Entra ID (Microsoft Entra ID) Application

Create an Entra ID (Microsoft Entra ID) Application

Microsoft Dynamics 365 supports OAuth-based authentication using Microsoft Entra ID. If you will connect via a web application and want to authenticate via Entra ID, you must first register a custom OAuth application in the Entra Admin Center, as described below.

If you will connect via a desktop application or headless machine, you can authenticate using Microsoft Dynamics 365's built-in embedded application credentials, which use branding. However, custom OAuth applications are also compatible with desktop and headless authentication flows, and may be preferable for production deployments or environments requiring strict policy control.

Register the Application

To register an OAuth application in Microsoft Entra ID, follow these steps:

1. Go to https://portal.azure.com.

2. In the left-hand navigation pane, select Microsoft Entra ID > App registrations.

3. Click New registration.

4. Enter a name for the application.

5. Specify the types of accounts this application should support:

   • For private-use applications, select Accounts in this organization directory only.
   • For distributed applications, select one of the multi-tenant options.

   Note

   If you select Accounts in this organizational directory only, when you connect with Microsoft Dynamics 365 connector, you must set AzureTenant to the tenant's ID (either GUID or verified domain). Otherwise, authentication will fail.

6. Set the redirect URI to http://localhost:33333 (default), or use another URI appropriate for your deployment.

   When using a custom redirect URI set a CallbackURL connection property; in those cases, set it to match this URI exactly.

7. Click Register. The application management screen opens. Record these values for later use:

   • Application (client) ID is used for OAuthClientId
   • Directory (tenant) ID is used for AzureTenant

8. Go to Certificates & Secrets. Click New Client Secret, set the desired expiration, and save the generated value. This value will only be shown once — record it to use with OAuthClientSecret.

9. Select Required Permissions > Add. Under Select an API, select Dynamics ERP > Delegated Permissions for [OAuthGrantType](#RSBDynamics365_p_OAuthGrantType) = CODE (default).

10. To confirm, click Add permissions.

Create a Service Principal App with Entra ID (Microsoft Entra ID)

Create a Service Principal App with Entra ID (Microsoft Entra ID)

When authenticating using a Microsoft Entra service principal, you must create a custom app registration and a service principal that can access the necessary resources.

Procedure

The following steps create a custom Microsoft Entra ID Service Principal application for most supported editions and and obtain the connection properties for the Microsoft Entra service principal authentication, then sets up an application user for your Power Platform (Microsoft Entra service principal) environment.

For information on how to create a custom Microsoft Entra ID Service Principal app for FinOps Online, see FinOps Online, below.

Create the Custom Microsoft Entra ID Service Principal Application

1. Log in to https://portal.azure.com.
2. In the left-hand navigation pane, select Microsoft Entra ID > Manage > App Registrations and click New registration. The portal displays the Register an application page.
3. Enter an application name.
4. Specify that the new application can be used by Accounts in this organizational directory only.
5. Click Register. The Portal displays the overview page for your new application.
6. Navigate to Manage > App Registrations.
7. In the API Permissions dialog, choose Dynamics CRM permissions. The Portal displays the Dynamics CRM menu.
8. Choose Delegated permissions type, select User_impersonation, then click Add Permissions.
9. Click yes.
10. Still in the Portal's Power Platform Service Principal section, click Certificates & secrets > + New Client Secret. The Portal displays the Add a client secret form.
11. Provide a description of the client secret (usually this is the same as the name you gave to your custom application) and choose an Expires date for the secret.
12. Click Add.
13. The Portal generates a Secret ID (a unique identifier) and a Value (the password) for the secret. These display only once, so record them for future use. (If you lose the key you will need to delete the secret and create a new one.)

Create the Application User

1. Login in to https://admin.powerplatform.microsoft.com/home.
2. In the navigation panel at left, click the Environments tab.
3. Select the D365 environment.
4. Navigate to Settings > Users + permissions.
5. Select Application users.
6. Click New app user > Add an app.
7. Select the custom Service Principal application that you just created.
8. Add the System administrator security role.
9. Click Create.
10. Assign a business unit.
11. Click Create.

Procedure for FinOps Online

To create a custom Microsoft Entra ID Service Principal application for use with Microsoft Dynamics 365 FinOps Online, you register the application with Microsoft Dynamics 365, generate a client secret for the custom application, configure the required permissions to use the application, and then register the application for Finance and Operations.

If no such account currently exists, create one before you begin the procedures below.

Register the application in the Microsoft Entra ID portal

1. Log in to https://portal.azure.com.
2. Switch to the tenant where you want to register the application.
3. In the left-hand navigation pane, select Microsoft Entra ID > App Registrations and click New registration. The portal displays the Register an application page.
4. Enter an application name.
5. For the account type, specify the Accounts in any organizational directory (Any Microsoft Entra ID directory - Multitenant).
6. Accept the default values for the remaining fields.
7. Click Register. The Portal displays the overview page for your new application, which displays certain "essentials".
8. Record the value for Application (client) ID for future use.

Generate the Client Secret

1. Next to Client credentials, click Add a certificate or secret. The portal displays the Certificates and Secrete page.
2. Click New client secret. The portal displays the Add a client secret panel.
3. Specify a description for the secret (for example, "App Connect secret"), then select an expiry period.
4. Click Add.
5. The portal generates the client secret and displays it on the Certificates & secrets page.
6. The secret is shown in full only this one time, so record the secret value now, for future use.

Configure required permissions

1. In the left navigation panel, click API permissions.

2. Navigate to Add a permission > Dynamics ERP > Application permissions.

3. Select Connector.FullAccess permission, then click Add permissions add it.

4. Navigate to Add a permission > Dynamics ERP > Delegated permissions.

5. Select AX.FullAccess, CustomService.FullAccess, and OData.FullAccess, then click Add permissions add them.

6. If any of the permissions you just added is Not granted for your domain, click Grand admin consent for yourdomain.

   Click Yes to confirm. The status of all permissions is updated to Granted.

Register the application with Microsoft Dynamics 365 Finance and Operations

1. Open your Microsoft Dynamics 365 Finance and Operations account.

2. Navigate to Modules > System administration > Setup > Microsoft Entra ID applications.

   The portal displays the Microsoft Entra ID applications page.

3. Click New.

4. At the Client Id field, enter the application (client) ID you reigistered in Microsoft Entra ID.

5. At the Name field, enter a name for the custom application.

6. At the User ID field, select an appropriate service account user ID as described at the beginning of this section.

7. Click Save.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

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

User Defined Views

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

SSL Configuration

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

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

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

For further information, see Query Processing.

Log

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

User Defined Views

The Microsoft Dynamics 365 connector supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

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

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

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

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

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

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

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

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

Data Model

The Microsoft Dynamics 365 connector models Microsoft Dynamics 365 data in relational tables, views, and stored procedures. The table definitions are dynamically obtained from the Microsoft Dynamics 365 OData service when you connect. Any changes to the metadata, such as new or removed columns, or changes in data type, are automatically loaded when you reconnect.

Views

The Views section, which lists read-only SQL tables, contains samples of what you might have access to in your Microsoft Dynamics 365 account.

The following views are shipped with the connector:

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, such as managing associations and retrieving OAuth access tokens.

Tables

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

Views

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

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

Microsoft Dynamics 365 Connector Views

MultiSelectPickListAttributeMetaData

Stores metadata for attributes with a MultiSelect OptionSet type. This metadata is only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'

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

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

Columns

MultiSelectPickListOptions

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

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'

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

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

Columns

PickListAttributeMetaData

Holds metadata for attributes of the Picklist type, detailing their options and configuration. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'

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

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

Columns

PickListOptions

Stores option values for Picklist metadata attributes, providing details for enumerated selections. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM PickListOptions WHERE TableName = 'teams'

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

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

Columns

Stored Procedures

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

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

Microsoft Dynamics 365 Connector Stored Procedures

CreateAssociation

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

Input

Result Set Columns

CreateSchema

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

CreateSchema

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

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

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

Input

Result Set Columns

EnableChangeTracking

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

Input

Result Set Columns

GetAdminConsentURL

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

Input

Result Set Columns

GetOAuthAccessToken

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

Input

Result Set Columns

GetOAuthAuthorizationUrl

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

Input

Result Set Columns

ListAssociations

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

Input

Result Set Columns

ListNavigationProperties

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

Input

Result Set Columns

RefreshOAuthAccessToken

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

Input

Result Set Columns

RemoveAssociation

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

Input

Result Set Columns

System Tables

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

Schema Tables

The following tables return database metadata for Microsoft Dynamics 365:

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

Data Source Tables

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

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector 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.

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

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

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

Columns

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

Describes stored procedure parameters.

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

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

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

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

Columns

Pseudo-Columns

sys_keycolumns

Describes the primary and foreign keys.

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

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

Columns

sys_foreignkeys

Describes the foreign keys.

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

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

sys_primarykeys

Describes the primary keys.

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

SELECT * FROM sys_primarykeys

Columns

sys_indexes

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

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

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

sys_connection_props

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

sys_sqlinfo

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

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.

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

sys_identity

Returns information about attempted modifications.

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

SELECT * FROM sys_identity

Columns

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Data Type Mapping

Data Type Mappings

The connector maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

Advanced Configurations Properties

The advanced configurations 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. Click the links for further details.

Authentication

Azure Authentication

OAuth

JWT OAuth

SSL

Schema

Miscellaneous

Authentication

This section provides a complete list of authentication properties you can configure.

AuthScheme

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

Possible Values

Microsoft Entra ID, AzureMSI, AzureServicePrincipal, AzureServicePrincipalCert

Data Type

string

Default Value

Microsoft Entra ID

Remarks

• Microsoft Entra ID: Perform Microsoft Entra ID (user-based) OAuth authentication.
• AzureMSI: Automatically obtain Microsoft Entra ID Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Authenticate as a Microsoft Entra service principal (role-based, application-based) using a Client Secret.
• AzureServicePrincipalCert: Authenticate as a Microsoft Entra service principal (role-based, application-based) using a Certificate.

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

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

OrganizationURL

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

Data Type

string

Default Value

""

Remarks

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

Edition

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

Possible Values

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

Data Type

string

Default Value

FinOpsOnline

Remarks

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

ADFSServer

Identifies the FinOpsOnPremise ADFS Server to be used for authentication. To find this server name, enter echo %logonserver% at the command prompt.

Data Type

string

Default Value

""

Remarks

Use only when Edition is set to FinOpsOnPremise. If no ADFS server name is specified, the property is ignored.

ApiVersion

Identifies the API version being used. Keep this setting up to date to ensure that the full range of available API features are accessed during authentication.

Data Type

string

Default Value

9.2

Remarks

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

Azure Authentication

This section provides a complete list of Azure authentication properties you can configure.

AzureTenant

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

Data Type

string

Default Value

""

Remarks

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

You can locate the directory (tenant) ID in the Microsoft Entra admin center by navigating to Microsoft Entra ID > Properties and copying 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 Microsoft Entra ID 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.

AzureEnvironment

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

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

Data Type

string

Default Value

GLOBAL

Remarks

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

OAuth

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

OFF

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for logging in users, exchanging their credentials for an OAuth access token to be used for authentication, and providing limited access to applications.

Microsoft Dynamics 365 supports the following options for initiating OAuth access:

1. OFF: No automatic OAuth flow initiation. The OAuth flow is handled entirely by the user, who will take action to obtain their OAuthAccessToken. Note that with this setting the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.
2. GETANDREFRESH: The OAuth flow is handled entirely by the connector. If a token already exists, it is refreshed when necessary. If no token currently exists, it will be obtained by prompting the user to login.
3. REFRESH: The user handles obtaining the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate. After the user logs in, the connector handles the refresh of the OAuth Access Token.

OAuthClientId

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

Data Type

string

Default Value

""

Remarks

This property is required when using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration. It is also required if an embedded OAuth application is not available for the driver. When an embedded OAuth application is available, this value may already be provided by the connector and not require manual entry.

This value 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 typically 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.

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.

Data Type

string

Default Value

""

Remarks

This property 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 will fail, and the server may return an invalid_client or 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. It may be referred to as the client secret, application secret, or consumer secret.

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.

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. This is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.

Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

OAuthSettingsLocation

Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.

Data Type

string

Default Value

%APPDATA%\Dynamics365 Data Provider\OAuthSettings.txt

Remarks

You can store OAuth values in a central file for shared access to those values, in either of the following ways:

• Set InitiateOAuth to either GETANDREFRESH or REFRESH and specify a filepath to the OAuth settings file.
• Use memory storage to load the credentials into static memory.

The following sections provide more detail on each of these methods.

Specifying the OAuthSettingsLocation Filepath

The default OAuth setting location is %APPDATA%\Dynamics365 Data Provider\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory.

Default values vary, depending on the user's operating system.

• Windows (ODBC and Power BI): registry://%DSN%
• Windows: %APPDATA%Dynamics365 Data Provider\OAuthSettings.txt
• Mac: %APPDATA%//Dynamics365 Data Provider/OAuthSettings.txt
• Linux: %APPDATA%//Dynamics365 Data Provider/OAuthSettings.txt

Loading Credentials Via Memory Storage

Memory locations are specified by using a value starting with memory://, followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose, but it should be unique to the user.

Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again.

To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

Supported Storage Types

• memory://: Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)
• registry://: Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name like registry://Microsoft Dynamics 365 connector Data Source, or registry://%DSN%.
• %DSN%: The name of the DSN you are connecting with.
• Default (no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with %APPDATA% or %PROGRAMFILES%.

CallbackURL

Identifies the URL users return to after authenticating to Microsoft Dynamics 365 via OAuth. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

If you created a custom OAuth application, the OAuth authorization server redirects the user to this URL during the authentication process. This value must match the callback URL you specified when you Configured the custom OAuth application.

OAuthVerifier

Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.

Data Type

string

Default Value

""

OAuthRefreshToken

Specifies the OAuth refresh token used to request a new access token after the original has expired.

Data Type

string

Default Value

""

Remarks

The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.

The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessToken stored procedure if you prefer to manage the refresh manually.

When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.

The OAuthRefreshToken should be handled securely and stored in a trusted location. Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.

OAuthExpiresIn

Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.

To determine how long the user has before the Access Token will expire, use OAuthTokenTimestamp.

OAuthTokenTimestamp

Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

JWT OAuth

This section provides a complete list of JWT OAuth properties you can configure.

OAuthJWTCert

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

Data Type

string

Default Value

""

Remarks

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

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates.

If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the Microsoft Dynamics 365 connector 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).

OAuthJWTCertType

Identifies the type of key store containing the JWT Certificate.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB, BCFKSFILE, BCFKSBLOB

Data Type

string

Default Value

USER

Remarks

OAuthJWTCertPassword

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

Data Type

string

Default Value

""

Remarks

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

OAuthJWTCertSubject

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

Data Type

string

Default Value

*

Remarks

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

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

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

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

OAuthJWTIssuer

The issuer of the Java Web Token.

Data Type

string

Default Value

""

Remarks

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

OAuthJWTSubject

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

Data Type

string

Default Value

""

Remarks

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

SSL

This section provides a complete list of SSL properties you can configure.

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

%APPDATA%\Dynamics365 Data Provider\Schema

Remarks

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

If left unspecified, the default location is %APPDATA%\Dynamics365 Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:

BrowsableSchemas

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

Data Type

string

Default Value

""

Remarks

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

Tables

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

Data Type

string

Default Value

""

Remarks

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

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

Views

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

Data Type

string

Default Value

""

Remarks

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

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

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

AllowDuplicateRecords

Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false.

Data Type

bool

Default Value

true

Remarks

This property only applies when Edition is CustomerService, FieldService, Marketing, ProjectOperations or Sales.

For further information, see https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/manage-duplicate-detection-create-update.

ContinueOnError

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

Data Type

bool

Default Value

false

Remarks

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

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

CrossCompany

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

Data Type

bool

Default Value

false

Remarks

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

CustomURLParams

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

Data Type

string

Default Value

""

Remarks

This property enables you to specify custom query string parameters that are included with the HTTP request. The parameters must be encoded as a query string in the form field1=value1&field2=value2&field3=value3, where each value is URL encoded. URL encoding converts the characters in the string that can be transmitted over the internet as follows:

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

EnableAtomicBatchOperations

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

Data Type

bool

Default Value

true

Remarks

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

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

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

EntityTypes

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

Possible Values

PUBLIC, PRIVATE, 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.

IncludeFormattedValues

Specifies whether columns that hold formatted values should be exposed.

Data Type

bool

Default Value

false

Remarks

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

IncludeLookUpLogicalName

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

Data Type

bool

Default Value

false

Remarks

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

IncludeNavigationKeys

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

Data Type

bool

Default Value

false

Remarks

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

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

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

IncludeNavigationProperties

Specifies whether the column listing should include navigation properties.

Data Type

bool

Default Value

false

Remarks

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

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

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

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

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

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

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

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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

MinimumColumnSize

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

Data Type

int

Default Value

0

Remarks

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

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

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

Pagesize

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

Data Type

int

Default Value

5000

Remarks

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

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

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

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector 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: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.

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

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UseClientSidePaging

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

Data Type

bool

Default Value

false

Remarks

Pagination is the process of batching data so that the data retrieved is displayed in batches of a particular size. To keep paging through the data, ask for "more". The data continues to display until all the retrieved data has been shown.

Client-Side Paging

In client-side paging, the client specifies how many records to return in each request, and the order of the requests.

If UseClientSidePaging is set to True, the limit/offset is calculated at the client and the requests are sent concurrently, as multiple threads.

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

Server-Side Paging

In server-side paging, the server returns only a subset of the data requested by the client. It also provides statistics on how large the full set of requested data is, and how much of the requested data set was not displayed.

Server-side pagination is best for large data sets.

Server-side paging requires traversing the data set both backward and forward. Not all data sources support that natively. To explicitly enable server-side paging with a data source that does not support it natively, you must configure your server to return a limited number of records per request, along with metadata about the total number of records. For details, see your data source's API documentation.

UseDynamicStoredProcedures

Specifies whether or not stored procedures are listed dynamically.

Data Type

bool

Default Value

false

Remarks

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

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

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

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

UseEntityDefinitions

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

Data Type

bool

Default Value

false

Remarks

This option is useful when precise column metadata is required, and the default data type attributes cannot be relied upon. Since EntityMetadata entities contain a lot of data, more detailed information is provided, including column length, description, precision, and scale. However, due to the larger metadata payload, response times are slower.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

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

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

}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.

Refer to User Defined Views for more information.