Skip to main content

Microsoft Dynamics 365 Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

Microsoft Dynamics is a portfolio of intelligent business applications that delivers superior operational efficiency and breakthrough customer experiences enabling businesses to become more agile and reduce complexity without increasing costs.

The Microsoft Dynamics 365 Reader connects to Microsoft Dynamics and reads supported objects.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

Custom objects

Authentication

Basic authentication

Username and password

OAuth authentication

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

Initial load

Pull-based incremental load

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

Striim TQL

Runtime

Resilience/recovery

Parallel execution

Metrics

Standard metrics

Supported authentication method

The Microsoft Dynamics 365 Reader supports OAuth authentication. Creating a connection requires registering an application in Azure Active Directory, granting the necessary API permissions, obtaining OAuth credentials and exchanging them for an access token, and setting connection properties in Striim.

To create a connection using OAuth authentication:

  1. Register the application in Azure Active Directory. See Register an application in Azure AD.

    1. Create an app in Azure AD to authenticate and interact with Dynamics 365.

    2. 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 (default), then you must set Tenant Id to the ID of the Azure AD Tenant. Otherwise, the authentication attempt fails.

  2. Grant the necessary API permissions. For example, Dynamics CRM > user_impersonation, or Dynamics 365 Business Central > user_impersonation. See Set API permissions in the Microsoft Entra documentation.

  3. Create a client secret under Certificates & secrets for secure authentication.

  4. Obtain an access token:

    1. Direct the user to the Azure AD authorization endpoint to get an authorization code.

      https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize?
      client_id=your-client-id&
      response_type=code&
      redirect_uri=https://your-redirect-uri&
      scope=<https://<yourorgname>>.crm.dynamics.com/.default offline_access&
      state=random-state-string
    2. Exchange this code for an access token by making a POST request to the token endpoint.

      https://login.microsoftonline.com/%7Btenant%7D/oauth2/v2.0/token 
      client_id=your-client-id&
      client_secret=your-client-secret&
      code=authorization-code-received&
      redirect_uri=https://your-redirect-uri&
      grant_type=authorization_code

    See OAuth 2.0 Auth Code Flow in the Microsoft Entra documentation.

  5. Obtain the Organization URL:

    1. To find your Microsoft Dynamics 365 organization's URL, sign in at https://m365.cloud.microsoft/apps/ with your credentials.

    2. After logging in, select the Dynamics 365 App you wish to connect to, and you will be taken to the Dynamics 365 home page.

    3. The organization’s URL will appear in the browser’s address bar and will look like: https://<yourorgname>.crm.dynamics.com/. For example: https://org00000000.crm.dynamics.com/

Supported editions

The following editions of Microsoft Dynamics 365 are supported:

  • Commerce

  • CustomerService

  • FieldService

  • FinOpsOnline

  • FinOpsOnPremise

  • HumanResoures

  • Marketing

  • ProjectOperations

  • Sales

Supported objects

The supported objects for each Dynamics 365 edition vary, as availability depends on licensing, configuration, and customizations. Objects may also change with updates and version differences. The following are sample objects supported by each edition:

  • Customer Service: Cases, Activities, Users, Entitlements, Queues, SocialPosts, etc.

  • Field Service: WorkOrders, Resources, ServiceBookings, Agreements, Inventory, Products, ServiceCalls, etc.

  • FinOpsOnline (Dynamics 365 Supply Chain Management): Products, Purchase Orders, SalesOrders, Invoices, Inventory, Warehouses, Costing, Procurement, Transactions, etc.

  • FinOpsOnPremise (Dynamics 365 Supply Chain Management): Same as FinOpsOnline, but specifically for on-premise deployments.

  • Human Resources: Employees, Positions, Compensation, Benefits, Requests, Requisitions, AbsenceManagement, Statements, Recruiting, etc.

  • Marketing: Campaigns, Segments, Leads, MarketingLists, Forms, Events, Emails, Posts, etc.

  • Project Operations: Projects, Tasks, Milestones, Budgets, Invoices, Entries, Resources, Contracts, etc.

  • Commerce : Products, Carts, Orders, Payments, Customers, Stores, Catalogs, Price Lists, Transactions, Categories, etc.

Microsoft Dynamics 365 Reader properties

Property

Type

Default value

Notes

Organization URL

String

To find your Microsoft Dynamics 365 organization's URL, sign in at https://m365.cloud.microsoft/ with your credentials. After logging in, you'll be directed to the Dynamics 365 home page.

The organization’s URL will appear in the browser’s address bar and will look like: https://<yourorgname>.crm.dynamics.com/. The <yourorgname> part is a unique identifier specific to your organization.

Edition

String

The edition of Microsoft Dynamics 365 being used.

When you set the Edition to 'FinOpsOnPremise', you must also specify the ADFS Server, which is displayed as an additional property.

Tenant ID

String

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com.

Alternatively, specify the tenant ID. This value is the directory ID in the Azure Portal > Azure Active Directory > Properties.

Client ID

String

The client ID assigned when you register your application with an OAuth authorization server.

Client secret

Password

The client secret assigned when you register your application with an OAuth authorization server.

Refresh token

Password

The OAuth refresh token for the corresponding OAuth access token.

Connection pool size

Integer

20

Specifies the maximum number of active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list:

  • Automated mode

  • Initial load

  • Incremental load

Automated

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.