Technical Upgrade to Version 18

Article
04/18/2024

Use this process to upgrade any of the following versions to the Business Central 2021 release wave 1 platform (version 18). This process won't upgrade the application to the latest version.

Business Central 2020 release wave 2 (version 17)
Business Central 2020 release wave 1 (version 16)
Business Central 2019 release wave 2 (version 15)

Upgrade on customized Business Central application.

Before you begin

Review the information in this section before you start upgrading your deployment.

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.

Prepare new runtime packages

If a deployment uses extensions that are published as runtime packages, create new versions of runtime packages against the new platform and application. Although you could run Repair-NAVapp on the extensions instead, as described later in this article, this way isn't recommended. Using Repair-NAVapp can lead to problems with the extensions after upgrade.

For more information, see Creating Runtime Packages for Business Central On-Premises.

Task 1: Install version 18

Choose a version 18 that's compatible with your current platform version.

There are several updates for each Business Central version. The update of your current version must be compatible version 18 update that you want to upgrade to. For more information, see Dynamics 365 Business Central Upgrade Compatibility Matrix. If your solution, for example, is currently running 17.6, you can't upgrade to 18.0. You'll have to wait until 17.7 is available.
Before you install version 18, it can be useful to create desktop shortcuts to the version 16.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 17.0 tools.
Install version 18 components.

You'll keep version 17 installed for now. When you install version 18, you must either specify different port numbers for components (like the Business Central Server instance and web services) or stop the version 17.0 Business Central Server instance before you run the installation. Otherwise, you'll get an error that the Business Central Server failed to install.

For more information, see Installing Business Central Using Setup.
Copy Dynamics Online Connect add-in.

The Dynamics Online Connect add-in was deprecated in version 17. As a result, it's been removed from the DVD and is no longer installed as part of the Business Central Server. However, for upgrade, the add-in may still be required for the old System Application. If the Business Central Server installation for your current version includes the Add-ins\Connect folder, then copy the Connect folder to the Add-ins folder of the version 18 server installation.

Task 2: Upgrade permission sets

Version 18 introduces the capability to define permissions sets as AL objects, instead of as data. Permissions sets as AL objects is now the default and recommended model for defining permissions. However for now, you can choose to use the legacy model, where permissions are defined and stored as data in the database. Whichever model you choose, there are permission set-related tasks you'll have to go through before and during upgrade.

For more information, see Upgrading Permissions Sets and Permissions.

Task 3: Rewrite code to handle obsoleted system tables (v15 only)

In version 16, several system tables were removed and replaced by new tables, compared to version 15. For a list of these tables and the corresponding new tables, see Deprecated Tables. Code that uses the deprecated tables, must be rewritten to use the new tables. This change will typically affect your base application or the Microsoft System Application, if you're using it.

For the base application or system application extensions, you'll have to create a new version that uses the new tables. The basic steps are as follows:

Create AL project in Visual Studio Code for the system and/or base application.

If you're using the Microsoft System Application, start with this project first.
Include the source files of the current version in the project.
Copy the version 18 System symbols (System.app) file to the .alpackages folder of the project.

You'll find the System.app file on the installation media (DVD) for version 18 or in the AL Development Environment installation folder. By default, the folder is C:\Program Files (x86)\Microsoft Dynamics 365 Business Central\180\AL Development Environment.

For the base application, also include the extension package (.app) for the new version of the Microsoft System Application, if you're using it.
Modify the app.json:
- Increase "version" number. You have to increase the version so you can run a data upgrade later in this process.
- Set "runtime" to 7.0
- Set "platform" to 18.0.0.0
- Set "target" to OnPrem
For more information about the app.json file, see App.json file.
In the dotnet.al files in the project, find and delete all instances of Version = '15.0.0.0'; in Microsoft.Dynamics.Nav and Microsoft.Dynamics.Framework assembly declarations.
Rewrite code that references the deprecated table to reference the new tables.

Try to build the project first to see what errors you get. Then, resolve the errors.
Compile and build the new version of the extension.

Task 4: Prepare databases

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

Make backup of the database.

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.
(Single-tenant only) Uninstall all extensions from the old tenants.

Run the Business Central Administration Shell for version 17.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 <BC17 server instance> | % { Uninstall-NAVApp -ServerInstance <BC17 server instance> -Name $_.Name -Version $_.Version }
```
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 <BC17 server instance> -SymbolsOnly | % { Unpublish-NAVApp -ServerInstance <BC17 server instance> -Name $_.Name -Version $_.Version }
```
What are symbols?
(Multitenant only) Dismount the tenants from the application server instance.

To dismount a tenant, use the Dismount-NAVTenant cmdlet:
```
Dismount-NAVTenant -ServerInstance <BC17 server instance> -Tenant <tenant ID>
```

Stop the server instance.

Stop-NAVServerInstance -ServerInstance <BC17 server instance>

Task 5: Convert application database to version 18

This task runs a technical upgrade on the application database. A technical upgrade converts the current database to the version 18.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.

Important

The conversion does not modify the application objects, but it will remove any modifications that you have made to system tables. After the conversion you will no longer be able to use it with current version.

Start Business Central Administration Shell for version 18.0 as an administrator.

For more information, see Run Business Central Administration Shell.

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 "<BC17 database name>"

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

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

Note

When the database is on Azure SQL Database, you may get the following error:

SQL Server: Execution Timeout Expired. The timeout period elapsed prior to completion of the operation or the server is not responding. The statement has been terminated.

If you do, scale up the database resources in Azure SQL, then run the Invoke-NAVApplicationDatabaseConversion cmdlet again. If the conversion is successful, you can then scale it back down to its original setting and continue the upgrade.

Task 6: Configure version 18 server

When you installed version 18 in Task 1, a version 18 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 17 to version 18.0 upgrade and can be reverted after you complete the upgrade.

Set the server instance to connect to the application database.
```
Set-NAVServerConfiguration -ServerInstance <BC18 server instance> -KeyName DatabaseName -KeyValue "<BC17 database name>"
```
In a single tenant deployment, this command mounts the tenant automatically. For more information, see Connecting a Server Instance to a Database.

If you want to use permission sets defined as data, set the UserPermissionSetsFromExtensions setting to false.

Set-NavServerConfiguration -ServerInstance <BC18 server instance> -KeyName "UsePermissionSetsFromExtensions" -KeyValue false

Disable task scheduler on the server instance for purposes of upgrade.
```
Set-NavServerConfiguration -ServerInstance <BC18 server instance> -KeyName "EnableTaskScheduler" -KeyValue false
```
Be sure to re-enable task scheduler after upgrade if needed.

Restart the server instance.

Restart-NAVServerInstance -ServerInstance <BC18 server instance>

Task 7: Import Business Central partner license

If you've gotten a new Business Central partner license, make sure that it has been uploaded to the database. To upload the license, use the Import-NAVServerLicense cmdlet:

Import-NAVServerLicense -ServerInstance <BC18 server instance> -LicenseFile "<path to the license>"

For more information, see Uploading a License File for a Specific Database.

Task 8: Recompile published extensions

Compile all published extensions against the new platform.

Important

Don't do this step on extensions published as runtime packages. Create new versions of the runtime packages instead. For more information, see Creating Runtime Packages for Business Central On-Premises.

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

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

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

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

Restart the server instance.

Restart-NAVServerInstance -ServerInstance <server instance>

Task 9: Synchronize tenant

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

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

To mount the tenant, use the Mount-NAVTenant cmdlet:
```
Mount-NAVTenant -ServerInstance <server instance name> -DatabaseName <database name> -DatabaseServer <database server>\<database instance> -Tenant <tenant ID> -AllowAppDatabaseWrite
```
Important

You must use the same tenant ID for the tenant that was used in the old deployment; otherwise you'll get an error when mounting or syncing the tenant. If you want to use a different ID for the tenant, you can either use the -AlternateId parameter now or after upgrading, dismount the tenant, then mount it again using the new ID and the OverwriteTenantIdInDatabase parameter.

For upgrade, set the -AllowAppDatabaseWrite parameter. After upgrade, you can dismount and mount the tenant again without the parameter if needed.
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 10: 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.

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.
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.
Install the Application extension.
```
Install-NAVApp -ServerInstance <server instance> -Name "Application" -Version <extension version>
```
Replace <extension version> with the exact version of the published Application extension.

For more information about the Application extension, see The Microsoft_Application.app File.

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 11: 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:

Open the Business Central client.
Search for and open the Control Add-ins page.
Choose Actions > Control Add-in Resource > Import.
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\170\Service\Add-ins\BusinessChart\Microsoft.Dynamics.Nav.Client.BusinessChart.zip.
After you've imported all the new control add-in versions, restart Business Central Server instance.

As an alternate, 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 = 'BC180'
$ServicesAddinsFolder = 'C:\Program Files\Microsoft Dynamics 365 Business Central\180\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 12: Install upgraded permissions sets

In this task, you install the custom permission sets that you upgraded earlier in this procedure. The steps depend on whether you've decided to use permission sets as AL objects or as data.

For permission sets as AL objects

Publish the extension or extensions that include the permission sets.
Sync the extensions with the tenant.
Install the extensions on the tenant.

For permission sets as data in XML

Set the UserPermissionSetsFromExtensions setting of the Business Central Server instance to false.

Set-NavServerConfiguration -ServerInstance <BC18 server instance> -KeyName "UsePermissionSetsFromExtensions" -KeyValue false

Restart the serve instance.
Open the Business Central Web client.
Search for and open the Permission Sets page.
Select Import Permission Sets, and follow the instructions to import the XML file.

For more information, see To export and import a permission set.

Post-upgrade tasks

Enable task scheduler on the server instance.
(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.
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.