SSIS Components for Microsoft Dynamics 365

Build 24.0.9175

Establishing a Connection

Enabling SSIS in Visual Studio 2022

If you're using Visual Studio 2022, you will need to install the SQL Server Integration Services Projects extension to use SSIS.

  1. Navigate to Extensions > Manage Extensions.
  2. In the Manage Extensions window's search box, search for "SQL Server Integration Services Projects 2022" and select the extension in the list.
  3. Click Download.
  4. Close Visual Studio and run the downloaded Microsoft.DataTools.IntegrationServices.exe installer. Proceed through the installer with default settings.
  5. Open Visual Studio. There should now be an "Integration Services Project" project template available.

Adding the Microsoft Dynamics 365 Connection Manager

Create a new connection manager as follows:

  1. Create a Visual Studio project with the "Integration Services Project" template.
  2. In the project, right-click within the Connection Managers window and select New Connection from the menu.
  3. In the Description column, select CData Microsoft Dynamics 365 Connection Manager and click Add...
  4. Configure the component as described in the next section.

Alternatively, if you have an existing project and CData Microsoft Dynamics 365 Source or CData Microsoft Dynamics 365 Destination:

  1. Right-click your CData Microsoft Dynamics 365 source or destination component in your data flow
  2. Select Edit... to open an editor window.
  3. Click the New... button next to the Connection manager: dropdown selector to create a connection manager.
  4. Configure the component as described in the next section.

Connecting to Microsoft Dynamics 365

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

  • CustomerService
  • FieldService
  • FinOpsOnline (Default)
  • FinOpsOnPremise
  • 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 FinOpsOnPremise.
  • For Microsoft Dynamics 365 Business Central, use the separate Microsoft Dynamics 365 Business Central driver.

To connect, set these parameters:

Authenticating to Microsoft Dynamics 365

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

Azure AD

Authenticating via Azure AD requires you to create a custom AzureAD application, as described in Creating an Azure AD Application. You can authenticate with either a client secret or a JWT certificate.

To connect, set these properties:

Admin Consent

Admin consent refers to permissions granted by an Azure AD Tenant's admin to a custom application, as required for the use case. (Since the embedded application within the CData SSIS Components for Microsoft Dynamics 365 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 Azure AD Application), you must specify which permissions the application requires. If you know that your organization requires admin consent for new custom applications, you can start by specifying permissions that are already labeled Admin Consent Required. (For example, all Groups permissions require admin consent.)

There are two ways to grant admin consent:

  • 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 CData SSIS Components for Microsoft Dynamics 365 cannot be used in the client OAuth flow. You must create your own OAuth application to use client credentials, as described in Creating an Azure AD Application.

To do this:

  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:

Azure Service Principal

Actions in Azure AD 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 an Azure Service Principal is handled via the OAuth Client Credentials flow, without user involvementy Authentication as an Azure Service Principal requires you to create a custom AzureAD Service Principal application, as described in Creating a Custom AzureAD Service Principal App.

When you are ready to connect, set these properties:

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.

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