Update Office Telemetry components

Applies to: Office 365 ProPlus, Office 2019, and Office 2016

Note

To assess your Office compatibility, we recommend using the Readiness Toolkit for Office add-ins and VBA. The Readiness Toolkit is a free download and can be used to identify the VBA macros and add-ins used in your organization. Also, the Excel-based readiness reports can tell you which add-ins are adopted or supported in Office 365 ProPlus and can provide suggestions on how to remediate VBA macros issues that are identified. For more information, see Use the Readiness Toolkit to assess application compatibility for Office 365 ProPlus.

Follow these steps if you were using the Office Telemetry Dashboard in Office 2013 and you're now moving to using the Office Telemetry Dashboard in Office 2019 or Office 2016. These steps aren't needed if you were using Office Telemetry Dashboard in Office 2016 and are now moving to Office 2019.

When you install Office 2019 or Office 2016, Telemetry Dashboard and the built-in telemetry agents are updated to the new versions automatically. However, the telemetry processors and the telemetry database aren't updated, even if they are on the same computer as Office 2019 or Office 2016.

To use the new version of Telemetry Dashboard, you'll have to update the telemetry processors and telemetry database manually. If you don't, you'll see an error message similar to the following when you use Telemetry Dashboard to connect to the telemetry database:

Database connection failure. The database needs to be updated.

You need to ensure that each computer on which you install the telemetry processors and telemetry database is also running the latest version of the Universal C Runtime (CRT) for the version of Windows running on the computer. For information, see Update for Universal C Runtime in Windows.

Here are the procedures for uninstalling the old telemetry processors, installing the new telemetry processors, and updating the telemetry database.

Note

Be sure that you get the list of telemetry processors before you install Office 2019 or Office 2016. You can find the list on the Telemetry Processor worksheet in Telemetry Dashboard.

To uninstall the old version of telemetry processor

  1. On each computer where telemetry processor is installed, uninstall telemetry processor from the Windows Control Panel.

    • On Windows 8, choose Start > Control Panel. Then, under Programs choose Uninstall a program.

    • On Windows 10, choose Start > Settings. Then, choose System > Apps & Features.

  2. In the list of programs, select Microsoft Office Telemetry Processor.

  3. Select Uninstall, and then select Yes when you are prompted.

The following two procedures describe two options for installing the telemetry processor. Pick the procedure that applies to your situation. Do this for each computer that's running telemetry processor.

Option 1: To install the telemetry processor on a computer that's running Office 2019 or Office 2016

  1. Ensure that the computer where you want to update the telemetry processor is also running the latest version of the CRT. For more information, see Update for Universal C Runtime in Windows.

  2. On a computer where Office 2019 or Office 2016 is running, open Telemetry Dashboard, and then select Let's get started.

  3. On the Getting started worksheet, expand Step 2, and then select Install Telemetry Processor on This Computer. This starts the Microsoft Office Telemetry Processor Setup wizard.

  4. Select Next in the wizard, and then select Yes in the User Account Control dialog box, if you are prompted.

  5. When installation is complete, select Finish, and then select Yes when you are prompted. This will open the Office Telemetry Processor settings wizard, where you can complete the next procedure, To configure the telemetry processor and update the telemetry database, for each computer.

Option 2: To copy the telemetry processor to a computer that isn't running Office 2019 or Office 2016 and install it

  1. On a computer where Office 2019 or Office 2016 is running, open Telemetry Dashboard, and then select Let's get started.

  2. On the Getting started worksheet, expand Step 2, and then select the appropriate version of the Save the Telemetry Processor MSI link (either x86 or x64) to save the MSI file to the local computer.

  3. Copy the MSI file to the computers that run telemetry processor.

  4. Ensure that each computer that runs telemetry processor is also running the latest version of the CRT. For more information, see Update for Universal C Runtime in Windows.

  5. On each computer that runs telemetry processor, run the MSI file to start the Microsoft Office Telemetry Processor wizard.

  6. Select Next in the wizard, and then select Yes in the User Account Control dialog box, if you are prompted.

  7. When installation is complete, select Finish, and then select Yes when you are prompted. This will open the Office Telemetry Processor settings wizard, where you can complete the next procedure, To configure the telemetry processor and update the telemetry database, for each computer.

Complete the next procedure for each computer that runs Telemetry Processor. The Office Telemetry Processor settings wizard is started as part of the previous procedures.

To configure the telemetry processor and update the telemetry database

  1. Select Next in the Office Telemetry Processor settings wizard.

  2. On the Database Settings page, do the following:

    1. Verify that the server selected in SQL server corresponds to the database that you are updating for Office 2019 or Office 2016.

    2. Select Connect to connect to the SQL Server computer.

    3. Select the telemetry database in SQL database, and then select Next.

  3. If you are prompted to update the database, select Yes. You'll only be prompted to do this on the first computer where you run the Office Telemetry Processor settings wizard.

  4. Select Yes to set database permissions.

  5. On the Shared Folder page, verify that the shared folder is correct, and then select Next.

  6. Select Yes to set shared folder permissions, and then complete the rest of the wizard.

To connect Telemetry Dashboard to the telemetry database after you upgrade

On a computer where Office 2019 or Office 2016 is running, open Telemetry Dashboard, and then select Connect to Database to connect to the newly updated database. The connection should be successful and you won't see an error message about the database.