Skip API data upgrade in cloud migration

When running the data upgrade during cloud migration, you can experience a long running upgrade because of the API upgrade. To prevent this condition, you can skip the API data upgrade during cloud migration, and then run it after going live on the tenant. Skipping the API data upgrade is done on per-company basis, and the only consequence is that the company starts using APIs later after you schedule the upgrade.

There are two ways to skip the API data upgrade during cloud migration. One way is to disable it as part of the on-premises upgrade process. The other way is to disable using cloud migration management in the Business Central online environment.

Skip from the online environment

Before you can do this task, you have to cloud migration setup and data replication.

  1. Sign in to Business Cental online.

  2. Search for and open the Cloud Migration Management page.

  3. Select the Manage API Upgrade action to open the API upgrade overview page.

  4. To disable the API data upgrade for a company, do the following steps:

    1. On the API upgrade overview page, select the company in the Company Name column.

      The API Data Upgrade List opens in a new browser tab.

    2. On the API Data Upgrade List page, select Disable API Data Upgrades > OK.

      You can close the API Data Upgrade List tab after you make the selection.

  5. Repeat the previous step for each company you want to disable the API data upgrade.

    The API upgrade overview page doesn't show the changes until it's refreshed (select (F5).

Skip from on-premises upgrade

You can use the following SQL query to skip upgrade for a single company:

DECLARE @UpgTag nvarchar(250);  
SET @UpgTag = UPPER('MS-469217-DisableAPIDataUpgrade-20230411')  
  
INSERT INTO [dbo].[Upgrade Tags$63ca2fa4-4f03-4f2b-a480-172fef340d3f] (Tag, [Tag Timestamp], [Skipped Upgrade], Company)  
VALUES (  
    UPPER(@UpgTag),  
    '1753-01-01 00:00:00.000',  
    1,  
    UPPER('SetCompanyName')  
);  

You can use the following SQL query to skip upgrade for all companies:

DECLARE @UpgTag nvarchar(250);  
  
SET @UpgTag = UPPER('MS-469217-DisableAPIDataUpgrade-20230411')  
  
INSERT INTO [dbo].[Upgrade Tags$63ca2fa4-4f03-4f2b-a480-172fef340d3f] (Tag, [Tag Timestamp], [Skipped Upgrade], Company)  
SELECT  
    UPPER(@UpgTag),  
    'SetDate',  
    1,  
    UPPER([Name])  
FROM  
    Company   
WHERE  
    UPPER([Name]) NOT IN (  
        SELECT [Company]   
        FROM [Upgrade Tags$63ca2fa4-4f03-4f2b-a480-172fef340d3f]   
        WHERE Tag = UPPER(@UpgTag)  
    )

Completing API data upgrade after going live

When you're finished with the cloud migration, run the API data upgrade as described Run API data upgrade.

Next steps

Run data upgrade