--- title: "DataMigrate PRO Synch-Service" id: "997928" type: "post" slug: "datamigrate-pro-synch-service" published_at: "2025-10-24T11:28:08+00:00" modified_at: "2026-09-02T06:06:42+00:00" url: "https://ioi.gmbh/en/2025/10/24/datamigrate-pro-synch-service/" markdown_url: "https://ioi.gmbh/en/2025/10/24/datamigrate-pro-synch-service.md" excerpt: "This documentation describes how to install and run the DataMigrate PRO service bus listener as a Windows service under the name “DataMigrate PRO Synch-Service”. It is based on the available CLI references and the requirements for settings.json. Overview The command..." taxonomy_category: - "DataMigrate Pro" - "General" - "Support & Documentation" --- Contents - [Overview](#overview) - [Prerequisites](#prerequisites) - [Installation steps](#installation-steps) - [How the service bus listener works](#how-the-service-bus-listener-works) - [Configuration in Business Central](#configuration-in-business-central) - [Example configuration (settings.json)](#example-configuration-settings-json) - [Notes:](#notes) - [Review and maintenance](#review-and-maintenance) - [Troubleshooting](#troubleshooting) This documentation describes the installation and operation of the DataMigrate PRO service bus listener as a Windows service under the name **“DataMigrate PRO Synch-Service”**. The instructions are based on the available CLI references and the requirements for `settings.json`. ## Overview The command ``` DataMigratePro -t listen --install "DataMigrate PRO Synch-Service" --registration "" --tenantid "" ``` Runs the following steps one after the other: 1. -t listen starts the Azure Service Bus listener of DataMigrate PRO. For productive operation, the connection settings are loaded from the settings.json file. 2. --install "DataMigrate PRO Synch-Service DWP" installs the listener in the Windows service wrapper (launcher) and sets up the specified service name. 3. --registration ... --tenantid ... checks and stores the registration/license key and the Azure AD tenant. Without valid registration, the tool refuses to operate as a service after a short time. ## Prerequisites - Windows server with administrator rights (required for the service installation). - Copy of the DataMigratePro program folder (incl. DataMigratePro.exe, settings.json). - Network access to: - SQL permissions for the service user - Registration key (--registration) and Azure AD tenant ID (--tenantid). ## Installation steps 1. **Prepare the folder** - Copy the complete delivery package to `C:\Programme\DataMigratePro` (or another target without spaces in the path). - Make sure that `DataMigratePro.exe` and `settings.json` are reachable, and that the service user is allowed to create the Logs directory in that path and to write log files there. 2. **Create or adjust settings.json** - Create or update `settings.json` in the installation folder, following the example in the [Example configuration](https://github.com/IOIntegrated/DataMigratePro/blob/preproduction/docs/DataMigratePro-Synch-Service-DWP.md#beispielkonfiguration-settingsjson) section. 3. **Prepare the registration** - Open an administrative PowerShell. - Navigate to the installation folder: `cd C:\Programme\DataMigratePro`. 4. **Run the registration** - Run the command above, but **without** `--install`, to validate the license and Service Bus data: - `.\DataMigratePro.exe -t listen --registration "" --tenantid ""` - If this succeeds, the Service Bus parameters (queue names, connection string) are added to the `settings.json` file. 5. **Install the service** - Then start the final installation: - `.\DataMigratePro.exe -t listen --install "DataMigrate PRO Synch-Service" --registration "" --tenantid ""` - The launcher registers a Windows service. Log output is redirected to the Windows event log. 6. **Start the service** - Open `services.msc`, look for **DataMigrate PRO Synch-Service DWP**, set the startup type to *Automatic* and start the service. ## How the service bus listener works - The listener monitors the configured RequestQueueName for incoming messages. Each message triggers the DataMigrate PRO data processing pipeline. - Responses and status messages are written to ResponseQueueName. - The loop runs continuously and uses short polling intervals (approx. 1 second) to detect new messages. - Errors are written to the Windows event log; in the case of serious errors, the service stops with a corresponding error code. ## Configuration in Business Central - In the Business Central Extension the same connectionId must be entered as in the settings.json, so that messages are assigned unambiguously to the listener. - Where possible, use a uniquely generated identifier (e.g. a GUID or a generated password) as connectionId in order to rule out overlaps with other integrations. - The Business Central configuration also stores the endpoint of the prepared Azure Function together with the access key generated in Azure. Only then can the application place messages into the Service Bus queue successfully. ## Example configuration (settings.json) ``` { "SqlConnectionString": "Data Source=SQLSERVER;Initial Catalog=BC_PROD;Integrated Security=SSPI;", "SourceCompany": "CRONUS AG", "DestinationCompany": "CRONUS AG", "SourceDatabase": "BC_PROD", "MappingDatabase": "BC_PROD", "MigrationDatabase": "BC_MIGRATION", "EndpointUrl": "https://api.businesscentral.dynamics.com/v2.0//Production/ODataV4/Upload_LoadData?company=CRONUS%20AG", "BlobMagicSignature": [2, 69, 125, 91], "IsSaaS": true, "Environment": "Production", "TenantInfo": { "TenantId": "", "ClientId": "", "ClientSecret": "" }, "HttpClientTimeoutSeconds": 100, "ServiceBus": { "ServiceBusConnectionString": "Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=", "RequestQueueName": "", "ResponseQueueName": "", "connectionId": "" } } ``` ### Notes: - The ServiceBus section is mandatory for -t listen. Missing values lead to a validation exception when the service starts. - Match the connectionId entered here with the configuration in Business Central. Use a unique identifier to avoid incorrect assignments. - TenantInfo is required for SaaS/OAuth. For on-premises operation, set IsSaaS to false and use BCUser/BCPassword instead of TenantInfo. - BlobMagicSignature can be adopted as it is, provided there is no specific requirement of your own. - Further optional settings such as SqlConnectionStringMigration or AppSourceEnabled can be added if required. ## Review and maintenance 1. **Check the service status** - Call `Get-Service "DataMigrate PRO Synch-Service"` in PowerShell. 2. **Review the log output** - Event Viewer → *Applications and Services Logs* → *DataMigratePro*. 3. **Adjust the settings** - Stop the service first, edit the `settings.json` file, then restart the service. 4. **Uninstall the service** - Run `DataMigratePro.exe --uninstall "DataMigrate PRO Synch-Service"` to remove it. ## Troubleshooting | Symptom | Cause | Solution | | --- | --- | --- | | Service starts and stops immediately | Invalid or missing ServiceBus entries | Verify settings.json, run the registration again | | Error message “Registration invalid” | Wrong key or tenant ID | Check the values, contact support if necessary | | No message processing | Wrong RequestQueueName or missing permissions | Check the queue name and the SAS policy | | OAuth authentication fails | TenantInfo incomplete or app registration without BC permissions | Check the Azure AD app, renew the secret | About the author #### Thomas Marquardt Leads migration projects and is the lead developer of DataMigrate Pro. Over 20 years of Microsoft ERP. Keep reading## More from the IOI blog [DataMigrate Pro Working with Configuration Data Six ways to move configurations between Business Central, the local installation and a ZIP archive – with the matching commands 23. October 2025 · 2 minutes](https://ioi.gmbh/en/2025/10/23/working-with-configuration-data/) [DataMigrate Pro Step-by-Step Guide for the Migration to Business Central From the AppSource install to the first migration run – the complete DataMigrate Pro sequence 9. October 2025 · 3 minutes](https://ioi.gmbh/en/2025/10/09/step-by-step-guide-migration-to-business-central/) [DataMigrate Pro Plugin Capability of DataMigrate Pro: “getprinter” Example How DataMigrate Pro can be extended through its plugin interface, shown with a call that lists the locally installed printers 12. September 2025 · 2 minutes](https://ioi.gmbh/en/2025/09/12/plugin-capability-datamigrate-pro-getprinter/) ## From reading to action. Book your upgrade check. In the free upgrade check we analyse your current Navision or NAV version and show you the direct path to Business Central – including effort, sequence and a fixed-price range. [Book a free Upgrade-Check →](/en/business-central-upgrade-check/) [Give us a quick call: +49 214 8402 3000](tel:+4921484023000) ✓ Directly from any Navision or NAV version ✓ Live test while the legacy system keeps running ✓ C/AL→AL conversion included ✓ Fixed-price range and timeline afterwards