Installing a Business Central Spring 2019 Cumulative Update

Note

If you're coming from version 13 or earlier, Business Central Spring 2019 (v14) is a required step to upgrade to the latest version of Business Central. However, mainstream support for version 14 ends in October 2023, and minor updates to the version are no longer available. New customers can't use version 14 in production, but only as a path for upgrading to latest version. Existing customers on version 14 remain supported by Microsoft as defined in the Fixed Lifecycle Policy.

This article describes how to install a cumulative update for Business Central on-premises. A cumulative update is a set of files that include hotfixes and regulatory features released for Business Central.

Download the cumulative update package

The first thing to do is to download the Cumulative Update package that matches your Business Central deployment.

  1. Go to the relevant list of available updates for your on-premises version of Business Central. Then, choose the Cumulative Update you want.

    For a list of supported versions of Business Central on-premises, see the See Also section.

  2. From the cumulative update page, under the Resolution section, select the link for downloading the update and follow the instructions.

  3. On the computer where you downloaded cumulative update, extract files from all .zip files.

The cumulative update includes files that are separated into the following folders:

  • APPLICATION folder

    Used for updating your application with the new or modified application objects that form the cumulative update.

  • DVD

    Contains the full Business Central product, including the Business Central installation program (setup.exe) and tools for upgrading to the platform.

When this step is done, you can continue to update your Business Central deployment to the new platform and application.

Update the platform

The following components are part of the Business Central platform:

  • Business Central Web Server
  • Business Central Server
  • SQL Server components
  • Dynamics NAV Client connected to Business Central

To upgrade to the latest platform, the database must be converted by using the Dynamics NAV Development Environment.

  1. (Single-tenant deployment only) Uninstall all extensions.

    If the Business Central Server is configured as a single-tenant instance, you must uninstall all extensions from tenant. For example, using the Uninstall-NAVApp cmdlet from the Business Central Administration Shell, you can run the following command:

    Get-NAVAppInfo -ServerInstance <ServerInstanceName> -Tenant default | % { Uninstall-NAVApp -ServerInstance <ServerInstanceName> -Name $_.Name -Version $_.Version }
    
  2. Install Business Central components of the cumulative update.

    There are two ways to install components. You can use the setup.exe file from the installation media or manually patch files to the existing installation:

    • Using setup.exe

      1. Uninstall the current version of Business Central.

        You can uninstall it by running setup.exe found in the DVD folder of the download or from Control Panel.

      2. From the DVD folder, run setup.exe to install Business Central.

        As a minimum, install the following components: Server, Web Server Components, SQL Server Components, and the Dynamics NAV Development Environment. For more information, see Installing Business Central Using Setup.

    • Manually patch the components

      With this way, you copy component files from installation media (DVD) to the current installation folders as described in the following table:

      Component Copy from DVD To current installation folder
      Server DVD\ServiceTier\program files\Microsoft Dynamics NAV\140 C:\Program Files\Microsoft Business Central<140>\Service
      WebClient DVD\WebClient\Microsoft Dynamics NAV\140\Web Client C:\Program Files\Microsoft Dynamics 365 Business Central<140>\Web Client
      Windows Client and Development Environment DVD\RoleTailoredClient\program files\Microsoft Dynamics NAV\140\RoleTailored Client C:\Program Files (x86)\Microsoft Dynamics 365 Business Central<140>\RoleTailored Client
      Microsoft Office Outlook Integration
      • DVD\Outlook\program files\Microsoft Dynamics NAV\140\OutlookAddin
      • Microsoft.Dynamics.NAV.OLSync.NAVSyncAddIn.dll
      • C:\Program Files(x64)\Microsoft Office\Office <version>
      • C:\Program Files (x64)\Microsoft Office\Office\xx-XX

    Tip

    Before you install, save a copy of the configuration files for the Business Central Server (CustomSettings.config), the Business Central Web Server (navsettings.json), and Dynamics NAV Client connected to Business Central (ClientUserSettings.config). You can then refer to settings the copies to configure the components again.

  3. Start the new development environment as an administrator. From the Start menu, right-click Dynamics NAV Development Environment and select Run as administrator.

  4. Open the application database.

    For more information, see Open a Database.

  5. If prompted, follow instructions to convert it to the new platform.

  6. (Multitenant deployment only) Mount an old tenant to the 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.

  7. Synchronize the database (tenant).

    For more information about syncing, see Synchronizing the Tenant Database and Application Database.

  8. Upload the Business Central Partner license to the database.

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

    Important

    The license that you upload must be a developer license. During the conversion, the development environment will convert the report objects that are stored in the old database to the RDL format.

Update the application

The APPLICATION folder includes the following files:

  • AccumulatedChangeLog.<Locale>.<Build No.>.txt
  • Changelog.<Locale>.<Build No.>.txt
  • CUObjects.<Locale>.<Build No.>.fob
  • Objects.<Locale>.Objects.<Locale>.<Build No.>.txt

Using Dynamics NAV Development Environment for Business Central, complete one of the following tasks.

Note

If a license update is required for a regulatory feature, customers can download an updated license from CustomerSource (see How to Download a Microsoft Dynamics 365 Business Central License from CustomerSource), and partners can download their customers' updated license from VOICE (see How to Download a Microsoft Dynamics 365 Business Central Customer License from VOICE).

Update an unmodified application to the Business Central cumulative update objects

  1. Open the database in the development environment.

  2. Import the CUObjects.<Locale>.<Build No.>.fob into the application database.

    For more information, see Importing Objects.

  3. Replace the existing objects in the database with the cumulative update objects.

Update a modified application to the Business Central cumulative update objects

  1. Import the CUObjects.<Locale>.<Build No.>.fob into the application database.

    For more information, see Importing Objects.

  2. When prompted, open the Import Worksheet, and review the information.

    1. Replace objects in the database that have NOT been modified.

    2. If a table in the cumulative update has a new field and the same table in your database has been modified, use the Merge: Existing<-New or Merge: New<-Existing option in the Import Worksheet to import the new fields.

    3. For other objects that have been modified, use the CUObjects.<Locale>.<Build No.>.txt file to compare and merge the cumulative update objects with the objects in your database.

      For more information about the worksheet, see Import Worksheet.

      Note

      If you don't want to use the Worksheet, you can use the Changelog.<Locale>.<Build No.>.txt file to manually apply the changes to the objects in your database.

Updating from Business Central October 2018 DE Cumulative Update 2 or earlier

Starting with Cumulative Update 03, the ELSTER local functionality is contained in an extension instead of the base application. If you want the latest updates to the ELSTER functionality, you must publish and install the ELSTER extension. Publishing the extension is described later. To prepare for this step, delete the following objects from the application database: page 11016, page 11017, page 11019, and report 11016. These objects will be replaced by the ELSTER extension.

Make sure you synchronize the tenant after you delete the objects.

Set the application version of database to the application version of the cumulative update

Increase the application version of the application database in order to do a data upgrade. We recommend that you change to the application version to that of the cumulative update. You can get this version from the cumulative update release page. For more information, see Version numbers in Business Central.

To set the application version, use the Set-NAVApplication cmdlet of the Business Central Administration Shell to set the application version as follows:

Set-NAVApplication -ServerInstance <ServerInstanceName> -ApplicationVersion Major.CU.ApplicationBuild.Revision -Force

Synchronize and upgrade tenants

  1. (Multitenant deployment only) Mount the tenant.

    For more information, see Mount or Dismount a Tenant .

  2. Synchronize the tenant.

  3. Run a data upgrade.

    Run Start-NavDataUpgrade cmdlet of the Business Central Administration Shell:

    Start-NavDataUpgrade -ServerInstance <ServerInstanceName> -Tenant <TenantID>
    

    Replace <TenantID> with the tenant ID of the database. If you don't have a multitenant server instance, use default or omit this parameter.

Publish and install/upgrade extensions

Complete this task if you're updating:

  • A Business Central October 2018 DE version earlier than Cumulative Update 3 and you want the latest updates to the Elster functionality. Use this procedure to install the following extension:

    Name Extension package
    ELSTER VAT Localization for Germany Elster.app
  • A Business Central application that uses extensions.

    The Business Central installation media (DVD) includes several new versions of Microsoft extensions (that is, extensions that have Microsoft as the publisher). If your old deployment uses these extensions, you have to upgrade the current versions to the new versions.

    Also, repair other extensions used in the old deployment that you still want to use so the extensions work on the new platform.

The general steps for this task are listed below. For detailed steps, see Publishing, Upgrading, and Installing Extensions During Upgrade .

  1. Publish new system, test, and application symbols.

    Unpublish the old versions first.

  2. Publish the new extension versions from the DVD.

    The extensions include new versions of Microsoft extensions that you already have used on your application, and the ELSTER app for the DE version. The new extension versions are found in the \Extensions folder of the installation media (DVD).

  3. Synchronize the tenant database with the schema changes of the extensions.

  4. Upgrade the data associated with the Microsoft extensions. This step isn't required the first time you publish the ELSTER extension.

  5. Install the newly published extensions on tenants.

  6. Repair, synchronize, and install any custom extensions (third-party) that are currently published. Do this step for old extensions that you still want to use.

    This step ensures that the extensions work on the new platform and application versions.

Import the customer license

Import the customer license as you did with the partner license. For more information, see Uploading a License File for a Specific Database.

See Also

Dynamics 365 Business Central On-Premises October'18 Updates
Dynamics 365 Business Central On-Premises April'19 Updates
Upgrading the Application Code
Upgrading to Business Central
Synchronizing the Tenant Database and Application Database
Version numbers in Business Central
Publish and Install an Extension