Technical upgrade from version 15 to version 16

Use this process to upgrade from Business Central 2019 release wave 2 (version 15) to the Business Central 2020 release wave 1 platform (version 16). This process won't upgrade the application to the latest version.

Single-tenant and multitenant deployments

The process for upgrading is similar for a single-tenant and multitenant deployment. However, there are some inherent differences. With a single-tenant deployment, the application code and business data are in the same database. In a multitenant deployment, application code is in a separate database (the application database) than the business data (tenant). In the procedures that follow, for a single-tenant deployment, consider references to the application database and tenant database as the same database. Steps are marked as Single-tenant only or Multitenant only where applicable.

Prerequisites

1. Your version 15 platform is compatible with version 16.

   There are several updates for version 15. The updates have a compatible version 16 update. For more information, see Dynamics 365 Business Central Upgrade Compatibility Matrix. For example, if your solution is currently running 15.5, you can't upgrade to 16.0. You must wait until 16.1 is available.

2. Disable data encryption.

   If the current server instance uses data encryption, disable it. You can enable it again after upgrading.

   For more information, see Managing Encryption and Encryption Keys.

   Instead of disabling encryption, you can export the current encryption key, which you'll then import after upgrade. However, we recommend disabling encryption before upgrading.

Task 1: Install version 16

1. Before you install version 16, it can be useful to create desktop shortcuts to the version 15.0 tools, such as the Business Central Server Administration tool, Business Central Administration Shell, and Dynamics NAV Development Shell because the Start menu items for these tools will be replaced with the version 16.0 tools.

2. Install version 16 components.

   You can keep version 15 component installed, but it isn't required. If you do, when you install version 16, you must either specify different port numbers for components during installation or stop the version 15.0 Business Central Server instance before you run the installation. Otherwise, you get an error that the Business Central Server failed to install.

   For more information, see Installing Business Central Using Setup.

Task 2: Rewrite code for obsoleted system tables

In version 16, many tables have been deprecated and replaced by new tables. You must rewrite code that uses the deprecated tables to use the new tables. For a list of the deprecated tables and new tables, see Deprecated Tables.

Task 3: Prepare databases

In this task, you prepare the application and tenant databases for the upgrade.

1. Make backup of the database.

2. Make sure that you have the extension packages for all published extensions.

   You need these packages later to publish and install the extensions again.

3. (Single-tenant only) Uninstall all extensions from the old tenants.

   Run the Business Central Administration Shell for version 15.0 as an administrator. For more information, see Run Business Central Administration Shell.

   Use the Uninstall-NAVApp cmdlet to uninstall an extension. For example, together with the Get-NAVAppInfo cmdlet, you can uninstall all extensions with a single command:

   Get-NAVAppInfo -ServerInstance <BC15 server instance> | % { Uninstall-NAVApp -ServerInstance <BC15 server instance> -Name $_.Name -Version $_.Version }
   

4. Unpublish all system, test, and application symbols.

   To unpublish symbols, use the Unpublish-NAVAPP cmdlet. You can unpublish all symbols by using the Get-NAVAppInfo cmdlet with the -SymbolsOnly switch as follows:

   Get-NAVAppInfo -ServerInstance <BC15 server instance> -SymbolsOnly | % { Unpublish-NAVApp -ServerInstance <BC15 server instance> -Name $_.Name -Version $_.Version }
   

   What are symbols?

5. (Multitenant only) Dismount the tenants from the application server instance.

   To dismount a tenant, use the Dismount-NAVTenant cmdlet:

   Dismount-NAVTenant -ServerInstance <BC15 server instance> -Tenant <tenant ID>
   

6. Stop the server instance.

   Stop-NAVServerInstance -ServerInstance <BC15 server instance>
   

Task 4: Convert the version 15.0 application database

This task runs a technical upgrade on the application database. A technical upgrade converts the database from the version 15.0 platform to the version 16.0 platform. This conversion updates the system tables of the database to the new schema (data structure). It also provides the latest platform features and performance enhancements.

1. Start Business Central Administration Shell for version 16.0 as an administrator.

   For more information, see Run Business Central Administration Shell.

2. Run the Invoke-NAVApplicationDatabaseConversion cmdlet to start the conversion. In a multitenant deployment, run this cmdlet against the application database.

   Invoke-NAVApplicationDatabaseConversion -DatabaseServer <database server>\<database instance> -DatabaseName "<BC15 database name>"
   

   When completed, a message like the following displays in the console:

   DatabaseServer      : .\BCDEMO
   DatabaseName        : Demo Database BC (15-0)
   DatabaseCredentials :
   DatabaseLocation    :
   Collation           :
   

Task 5: Configure version 16 server

When you installed version 16 in Task 1, a version 16 Business Central Server instance was created. In this task, you change server configuration settings that are required to complete the upgrade. Some of the changes are only required for version 15 to version 16.0 upgrade and can be reverted after you complete the upgrade.

1. Set the server instance to connect to the application database.

   Set-NAVServerConfiguration -ServerInstance <BC15 server instance> -KeyName DatabaseName -KeyValue "<BC15 database name>"
   

   In a single tenant deployment, this command mounts the tenant automatically. For more information, see Connecting a Server Instance to a Database.

2. Disable task scheduler on the server instance for purposes of upgrade.

   Set-NavServerConfiguration -ServerInstance <BC16 server instance> -KeyName "EnableTaskScheduler" -KeyValue false
   

   Be sure to re-enable task scheduler after upgrade if needed.

3. Restart the server instance.

   Restart-NAVServerInstance -ServerInstance <BC16 server instance>
   

Task 6: Publish new system symbols

Use the Publish-NAVApp cmdlet to publish the new symbols extension package. This package is called System.app. If you've installed the AL Development Environment, you find the file in the installation folder. By default, the folder path is C:\Program Files (x86)\Microsoft Dynamics 365 Business Central\160\AL Development Environment.

Publish-NAVApp -ServerInstance <BC16 server instance> -Path "<path to the System.app file>" -PackageType SymbolsOnly

Task 7: Recompile published extensions

Compile all published extensions against the new platform.

1. To compile an extension, use the Repair-NAVApp cmdlet, For example:

   Repair-NAVApp -ServerInstance <server instance> -Name <extension name> -Version <extension name>
   

   To compile all published extensions at once, you can use this command:

   Get-NAVAppInfo -ServerInstance <server instance> | Repair-NAVApp  
   

2. Restart the server instance.

   Restart-NAVServerInstance -ServerInstance <server instance>
   

Task 8: Synchronize tenant

1. (Multitenant only) Mount the tenant to the new Business Central Server instance.

   You have to do this step and the next for each tenant. For more information, see Mount or Dismount a Tenant.

2. Synchronize the tenant.

   Use the Sync-NAVTenant cmdlet:

   Sync-NAVTenant -ServerInstance <server instance> -Tenant <tenant ID> -Mode Sync
   

   For a single-tenant deployment, you can either set the <tenant ID> to default or omit the -Tenant <tenant ID> parameter. For more information about syncing, see Synchronizing the Tenant Database and Application Database.

Task 9: Reinstall extensions

Skip this task for a multitenant environment. In this task, you reinstall the same extensions that were installed on the tenant before.

To install an extension, you use the Install-NAVApp cmdlet.

1. If your solution uses the System Application, install this first.

   Install-NAVApp -ServerInstance <server instance> -Name "System Application" -Version <extension version>
   

   Replace <extension version> with the exact version of the published System Application.

2. Install the Base Application.

   Install-NAVApp -ServerInstance <server instance> -Name "Base Application" -Version <extension version>
   

   Replace <extension version> with the exact version of the published System Application.

3. (Upgrading from 15.3 and later) Install the Application extension.

   This extension was introduced in 15.3. For more information about it, see The Microsoft_Application.app File.

   Install-NAVApp -ServerInstance <server instance> -Name "Application" -Version <extension version>
   

   Replace <extension version> with the exact version of the published System Application.

4. Install other extensions, including Microsoft and third-party extensions.

   Install-NAVApp -ServerInstance <server instance name> -Name <extension name> -Version <extension version>
   

At this point, your solution has been updated to the latest platform.

Task 10: Upgrade control add-ins

The Business Central Server installation includes new versions of the Microsoft-provided Javascript-based control add-ins, like Microsoft.Dynamics.Nav.Client.BusinessChart, Microsoft.Dynamics.Nav.Client.VideoPlayer, and more. If your solution uses any of these control add-ins, upgrade them to the latest version.

To upgrade the control add-ins, do the following steps:

1. Open the Business Central client.

2. Search for and open the Control Add-ins page.

3. Choose Actions > Control Add-in Resource > Import.

4. Locate and select the .zip file for the control add-in and choose Open.

   The .zip files are located in the Add-ins folder of the Business Central Server installation. There's a subfolder for each add-in. For example, the path to the Business Chart control add-in is C:\Program Files\Microsoft Dynamics 365 Business Central\160\Service\Add-ins\BusinessChart\Microsoft.Dynamics.Nav.Client.BusinessChart.zip.

5. After you've imported all the new control add-in versions, restart Business Central Server instance.

Alternatively, you can use the Set-NAVAddin cmdlet of the Business Central Administration Shell. For example, the following commands update the control add-ins installed by default. Modify the commands to suit:

$InstanceName = 'BC160'
$ServicesAddinsFolder = 'C:\Program Files\Microsoft Dynamics 365 Business Central\160\Service\Add-ins'
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.BusinessChart' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'BusinessChart\Microsoft.Dynamics.Nav.Client.BusinessChart.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.FlowIntegration' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'FlowIntegration\Microsoft.Dynamics.Nav.Client.FlowIntegration.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.OAuthIntegration' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'OAuthIntegration\Microsoft.Dynamics.Nav.Client.OAuthIntegration.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.PageReady' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'PageReady\Microsoft.Dynamics.Nav.Client.PageReady.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.PowerBIManagement' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'PowerBIManagement\Microsoft.Dynamics.Nav.Client.PowerBIManagement.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.RoleCenterSelector' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'RoleCenterSelector\Microsoft.Dynamics.Nav.Client.RoleCenterSelector.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.SatisfactionSurvey' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'SatisfactionSurvey\Microsoft.Dynamics.Nav.Client.SatisfactionSurvey.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.SocialListening' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'SocialListening\Microsoft.Dynamics.Nav.Client.SocialListening.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.VideoPlayer' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'VideoPlayer\Microsoft.Dynamics.Nav.Client.VideoPlayer.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.WebPageViewer' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'WebPageViewer\Microsoft.Dynamics.Nav.Client.WebPageViewer.zip')
Set-NAVAddIn -ServerInstance $InstanceName -AddinName 'Microsoft.Dynamics.Nav.Client.WelcomeWizard' -PublicKeyToken 31bf3856ad364e35 -ResourceFile ($AppName = Join-Path $ServicesAddinsFolder 'WelcomeWizard\Microsoft.Dynamics.Nav.Client.WelcomeWizard.zip')

Task 11: Post-upgrade

1. Enable task scheduler on the server instance.

2. (Multitenant only) For tenants other than the tenant that you use for administration purposes, if you mounted the tenants using the -AllowAppDatabaseWrite parameter, dismount the tenants, then mount them again without using the -AllowAppDatabaseWrite parameter.

3. If you want to use data encryption as before, enable it.

   For more information, see Managing Encryption and Encryption Keys.

   Optionally, if you exported the encryption key instead of disabling encryption earlier, import the encryption key file to enable encryption.

4. Grant users permission to the Open in Excel and Edit in Excel actions.

   Version 16 introduces a system permission that protects these two actions. The permission is granted by the system object 6110 Allow Action Export To Excel. Because of this change, users who had permission to these actions before upgrading, will lose permission. To grant permission again, do one of the following steps:

   • If you have a version 16 application, export the EXCEL EXPORT ACTION permission set. Then, import it to your application and add it to appropriate users.

   • Add the system object 6110 Allow Action Export To Excel permission directly to appropriate permission sets.

   For more information about working with permission sets and permissions, see Export and Import Permission Sets.

See also

Upgrading to Business Central
Business Central 14.X to 15.X compatibility matrix