How to install a Microsoft Dynamics NAV 2017 cumulative update

Introduction

This article describes how to install a cumulative update for Microsoft Dynamics NAV 2017. You have to recompile all objects after you install a cumulative update.A cumulative update is a cumulative set of files that includes all hotfixes and regulatory features that have been released for Microsoft Dynamics NAV 2017.A cumulative update includes files that are separated into the following folders:

APPLICATION
DVD

How to install the cumulative update files

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

To install the application files, follow these steps:

Unmodified databases:
1. Import the CUObjects.<Locale>.<Build No.>.fob file into an unmodified Microsoft Dynamics NAV 2017 database.
2. Replace the existing objects in the database with the cumulative update objects.
For more information, see How to: Import Objects.
Modified databases or local databases for which local cumulative updates are not released:
1. Import the CUObjects.<Locale>.<Build No.>.fob file into the Import Worksheet window in your modified database. For more information, see Import Worksheet.
2. Replace the objects in your database that have NOT been modified.
3. Use the CUObjects.<Locale>.<Build No.>.txt file to compare and merge the cumulative update objects with the objects in your database that have been modified.
Or, you may use the Changelog.<Locale>.<Build No.>.txt file to manually apply the changes to the objects in your database.Note 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 the Merge: New<-Existing options in the Import Worksheet window to import the new fields. For more information, see Options for Merging Objects.

Note about Regulatory Features If a license update is required for a regulatory feature, customers can download an updated license from CustomerSource and partners can download their customers' updated license from VOICE. For more information, see the following How To articles:

PLATFORM

The following components are defining the Microsoft Dynamics NAV Platform:

Microsoft Dynamics NAV Web Client
Microsoft Dynamics NAV Windows Client
Microsoft Dynamics NAV Service Tier

The Microsoft Dynamics NAV platform can be installed by the following methods:

Use the installation program
- Un-install current client or server
- Open the DVD folder and run the setup.exe
- Connect to the database
Note This is a recommended method because different installations may have different strategies. For example, stx/etx file updates may not be included in a localized or Multilanguage setting.
Manually patch the Microsoft Dynamics NAV platform
- See the Manual Patching Process section
Use the ClickOnceInstaller (Web Client and Windows Client only)
- For more information, see Deploying Microsoft Dynamics NAV Using ClickOnce

The Microsoft Dynamics NAV platform cumulative updates are made available as single files. To install a Microsoft Dynamics NAV cumulative update, you must replace the existing Microsoft Dynamics NAV installation files with the cumulative update files. To do this, follow the steps outlined in the Automated Copy Process and Manual Patching Process sections.

Automated Copy Process

Step 1: Download and Un-pack the DVD.zip you downloaded

In the package you downloaded there is a compressed DVD folder. Un-pack the folder by right-clicking the file and choose Extract All.

Step 2: Import the Copy-UpdateFilesToBatchDirectory.ps1 module

Importing the module "as is" will give you an automated process for creating the following directory structure with the DVD as base directory:

ADCS
BPA
HelpServer
NST\Add-ins
OUTLOOK
RTC\Add-ins
UpgradeToolKit
WEB CLIENT
WindowsPowerShellScripts

Before import, you can modify the module to your needs regarding input and output directories.

Open either Windows PowerShell or the Microsoft Dynamics NAV 2017 Administration Shell as an administrator.
Run the Import-Module DIRECTORY\Copy-UpdateFilesToBatchDirectory.ps1 command.
Run the Copy-UpdateFilesToBatchDirectory -DvdDirectory DVDDIRECTORY -BatchDirectory BATCHDIRECTORY command where DVDDIRECTORY is the location where you unzipped the DVD from the update, and BATCHDIRECTORY is the location where you want to files to be copied to.

The process takes a couple of minutes. When completed, you should have the same structure as you had before, located in the path that you specified for BATCHDIRECTORY.

Manual Patching Process

Step 1: Replace the files in the Microsoft Dynamics NAV Server installation

In the Microsoft Dynamics NAV Server installation, replace the files by using the cumulative update files. This includes the *.etx, *.stx, and other files in the relevant languages. Also, merge your current *.config files with the *.config files from the cumulative update.To replace the existing Microsoft Dynamics NAV files, follow these steps:

Stop the Microsoft Dynamics NAV Server service.
Copy the files in the DVD\ServiceTier\program files\Microsoft Dynamics NAV\<100>\Service\ folder from the DVD that you downloaded.
Paste the files into the Microsoft Dynamics NAV Server installation directory. The Microsoft Dynamics NAV Server is usually installed in the following directory:

C:\Program Files\Microsoft Dynamics NAV\<100>\Service
Choose Yes to overwrite the files in the directory.
Start the Microsoft Dynamics NAV Server service.

Step 2: Replace the files in the Microsoft Dynamics NAV Windows client installation

In the Microsoft Dynamics NAV Windows client installation, replace the files by using the cumulative update files. This includes the *.etx, *.stx, and other files in the relevant languages. Also, merge your current *.config files with the *.config files from the cumulative update.To replace these files, follow these steps:

Close the Microsoft Dynamics NAV Windows client.
Copy the files in the DVD\RoleTailoredClient\program files\Microsoft Dynamics NAV\<100>\RoleTailored Client\ folder from the DVD that you downloaded.
Paste the files into the Microsoft Dynamics NAV Windows client installation directory. The Microsoft Dynamics NAV Windows client is usually installed in the following directory:

C:\Program Files (x64)\Microsoft Dynamics NAV\<100>\RoleTailored Client
Choose Yes to overwrite the files in the directory.

Note The above steps must be followed for each Microsoft Dynamics NAV Windows client.

Step 3: Replace the files in the Microsoft Dynamics NAV Web client installation

If you have the Microsoft Dynamics NAV Web client installed, replace the files by using the cumulative update files.To replace these files, follow these steps:

Close the Microsoft Dynamics NAV Web client.
If you did not use the automated copy process then copy the files in the DVD\WebClient\Microsoft Dynamics NAV\<100>\Web Client folder from the DVD that you downloaded.
Paste the files into the Microsoft Dynamics NAV Web client installation directory. The Microsoft Dynamics NAV Web client is usually installed in the following directory:

C:\Program Files\Microsoft Dynamics NAV\<100>\Web Client
Choose Yes to overwrite the files in the directory.

Note The above steps must be followed for each Microsoft Dynamics NAV Web client.

Step 4: Replace the files in the Microsoft Office Outlook Integration installation

If you have Microsoft Office Outlook Integration installed, replace the files in the Microsoft Office Outlook Integration installation by using the cumulative update files.To replace the files, follow these steps:

If you did not use the automated copy process then copy the files in the DVD\Outlook\program files\Microsoft Dynamics NAV\<100>\OutlookAddin\folder from the DVD that you downloaded.
Paste the files into the Microsoft Office Outlook Integration directory. Microsoft Office Outlook Integration is usually installed in the following directory:

C:\Program Files(x64)\Microsoft Office\Office xxNote The xx placeholder represents the version of Microsoft Office that you have installed.
Choose Yes to overwrite the files in the installation directory.
Copy the following file from the files that you downloaded:

Microsoft.Dynamics.NAV.OLSync.NAVSyncAddIn.dll
Paste the file into the language folders in the Microsoft Office Outlook Integration directory. The language folders are installed in the following directories:

C:\Program Files (x64)\Microsoft Office\Office\xx-XXNote The xx-XX placeholder represents the language version, for example, en-US.

Step 5: Replace the files in the Microsoft Dynamics NAV Automated Data Capture System (ADCS) installation

If you have Automated Data Capture System (ADCS) installed, replace the files in the Automated Data Capture System installation by using the cumulative update files.To replace the files, follow these steps:

If you did not use the automated copy process then copy the files in the DVD\ADCS\program files\Microsoft Dynamics NAV\<100>\Automated Data Capture System\ folder from the DVD that you downloaded.
Paste the files into the Automated Data Capture System installation directory. Automated Data Capture System is usually installed in the following directory:

C:\Program Files (x64)\Microsoft Dynamics NAV\<100>\Automated Data Capture System
Choose Yes to overwrite the files in the directory.