Setting up recurring integration in Dynamics 365 Finance and Operations

Microsoft Dynamics 365 Finance and Operations offers various data integration methods, and recurring integration is one of the most effective ways to automate data imports and exports. This method is particularly useful for businesses dealing with large-scale data transfers that need to be processed on a scheduled basis without manual intervention.

This blog will explore the concept of recurring integration in D365FO, its key components, setup process, endpoints, and best practices to ensure smooth data automation.

What is recurring integration in Dynamics 365 Finance and Operations?

D365 F&O recurring integration enables businesses to schedule and automate data imports and exports using the Data Management Framework (DMF). This integration method efficiently handles bulk data, reducing manual efforts and enhancing data accuracy.

How can recurring integration help?

• Asynchronous data transfer: Processes data without impacting system performance.
• Uses data entities: Ensures structured data import/export.
• Seamless Azure integration: Communicates with external systems via Azure Blob Storage.
• Error handling and logging: Tracks failures and generates logs for debugging.
• Data integrity and consistency: Ensures accurate data transfer.
  

Components of recurring integration

To understand how Recurring Integration works, let’s break down its main components:

• Data Management Framework (DMF): This core component handles data imports and exports.
• Recurring integration API: Facilitates communication between external applications and D365 F&O for scheduled data transfers.
• Execution pipeline: Processes data transformations and validations before final import/export.
• Batch processing: Automates execution through batch jobs to ensure timely data processing.

Setting up recurring integration in D365 F&O

Setting up Recurring Integration in Dynamics 365 Finance and Operations (D365 F&O) allows you to schedule and automate data imports/exports between D365 and external systems using the Data Management framework and Azure services.

Here’s a step-by-step guide:

Step 1: Create a data project

1. Open Data Management Workspace
2. On the main dashboard, click on the Data Management tile.

Step 2: Create a new data project

Click on Import or Export to start a new data project.

Step 3: Enter project details

1. Provide a valid job name.
2. Select the data source and entity name.

Step 4: Upload data file

1. Upload a file for one or more entities.
2. Ensure all entities are added without errors.

Step 5: Save the data project

Click Save to finalize the setup.

Creating a recurring data job

Step 1: Navigate to the data project page

Click on Create Recurring Data Job.

Step 2: Enter job details

Provide a valid name and description.

Step 3: Set up authorization policy

1. Enter the Application ID generated for your application.
2. Mark it as enabled.

Step 4: Configure advanced options

1. File – Push individual files for processing, following the format specified in the data project.
2. Data package – Submit multiple data files as a single unit for integration.

Step 5: Set up recurrence

1. Click Set Processing Recurrence, then configure the frequency in the Define Recurrence dialog box.
2. Click Set Monitoring Recurrence to monitor the queue load (This is optional).
   

Step 6: Confirm and save

1. Click OK, then select Yes in the confirmation message box.
2. We have created Customer Import and Export Projects and the respective jobs for each.

Step 7: Import/export customer job

We have created import/export customer jobs. We are sharing the import customer job one for reference.

Here, the ID field is the activity ID field.

In Application ID, we need to add the app ID obtained from Azure.

The batch job can be seen under System Administration, Data Management, IT, Recurring data jobs.

Transferring data via REST APIs

Recurring payment integration uses secure REST application programming interfaces (APIs) and authorization mechanisms to receive data from and send data back to integration systems.

Securing API Authorization in D365 Finance and Operations

The Data Management Framework (DMF) API in Dynamics 365 Finance & Operations uses OAuth 2.0 for secure authentication and access control. You must have a valid OAuth access token to interact with the API.

Here are the steps to enable authentication:

1. Register an Azure App Service to enable secure API authentication.
2. Retrieve the following credentials from the registered Azure application:
   • Client ID (Application ID)
   • Client Secret
   • Tenant ID
   • Finance & Operations URL
     

These credentials are crucial for establishing a secure connection between D365 F&O and external applications, ensuring smooth data integration and API communication.

Integrating with recurring data jobs

Use integration REST endpoints to:

• Submit documents for import
• Retrieve documents for export
  

These endpoints support OAuth authentication for secure access.

Recurring integration endpoints

D365 F&O provides specific endpoints to facilitate data exchange using the Recurring Integration API. These endpoints allow external systems to push and pull data efficiently.

Key endpoints

Enqueue Data Import API

This is a third-party API application that you can use to add data to the processing queue in D365 F&O and initiate the import process for a file or data package.

API endpoint

https:///api/connector/enqueue/?entity=

API details

• Type: POST request
• Format: Binary
• Purpose: Add a file to the import queue for processing
• Response: This will return the message ID, which we can use to get the status of the request that we have made.
  

API body

Binary (e.g., .xlsx file)

We have added four new customers to an Excel file and sent it via an API call. Since the job is set up, new records should be created. Verify that the records have been successfully created.

Export Data (Dequeue) API

This API allows a third-party application to retrieve a data package from D365 F&O. The package contains all the data entities defined in the data project, which the client application can download, unzip, and process.

API endpoint

https://{baseURL}/api/connector/dequeue/

API details

• Type: GET request
• Purpose: Retrieve exported data for processing

Get Status API

When a file or data package is added to the queue in D365 F&O, the system generates a message ID. You can use the Get Status API to check whether the message was processed successfully or failed. If it fails, your app can retry or take other actions.

API endpoint

https://{baseURL}/data/DataManagementDefinitionGroups/Microsoft.Dynamics.DataEntities.GetMessageStatus

API details

• Type: POST request
• Format: JSON
• Purpose: Check the processing status of an import message
  

API body
{
“messageId”:””
}

These endpoints ensure smooth interaction between D365 F&O and external applications, enabling real-time data synchronization.

Conclusion

Recurring Integration in Dynamics 365 Finance and Operations is a powerful way to automate data transfers, minimize manual effort, and maintain data accuracy. Organizations can ensure smooth and reliable data synchronization across systems using the Data Management Framework (DMF), Azure integration, API endpoints, and best practices.

If you encounter challenges during setup or need support with enabling recurring integration in Dynamics 365, our experts are here to help. Contact us at marketing@confiz.com for guidance or any Dynamics 365 Finance and Operations queries.