How to Upgrade DocRead for SharePoint Server

Note: this guide applies to DocRead for SharePoint Server (on-premises SharePoint 2019 and 2016) only. If you use DocRead for Microsoft 365, see the DocRead 365 release notes instead.

Upgrading DocRead gives you the new features, fixes and performance improvements in each release. The latest on-premises release is DocRead and DocSurvey V5.0 (build 5.0.21281.2). Its release notes list the fixes and the new Modern Experience Pack for SharePoint 2019. This page walks through the upgrade from start to finish. The full instructions, with screenshots, are in section 6 of the DocRead System Administrator’s Guide.

Prefer to watch? This video walks through the same steps.

Before you upgrade

An upgrade may update files on every front-end server and apply changes to the DocRead SQL database, so prepare properly first.

  • Check you’re eligible. Upgrades are included with a DocRead support plan. See support plans for on-premises versions of DocRead, or contact your account manager if you’re not sure.
  • Check your current version. If you’re on DocRead 3.4 or earlier, upgrade to version 3.5 first, then to version 5.
  • Test on a copy of your live farm first. Run every upgrade on a test farm before production. If you need a non-production license for this, Collaboris can arrange one free of charge for the upgrade.
  • Plan for downtime. The upgrade restarts your web application worker processes, and upgrading the SharePoint components can cause a temporary loss of service. Schedule it outside business hours.

Back up your databases

Before you start, back up:

  • The SharePoint configuration database
  • The SharePoint content databases for every site where DocRead is enabled
  • The DocRead database

Microsoft explains how to back up a SharePoint Server farm and how to create a full SQL Server database backup. If the upgrade fails, you’ll need these backups to restore.

Step 1: Update the DocRead installation files

  1. Uninstall DocRead from Control Panel > Programs > Uninstall a program. This removes only the installation files (such as the WSPs) from the local file system. DocRead stays in your SharePoint farm and you don’t lose any data.
  2. Download the latest version of DocRead from the link in your upgrade email.
  3. Right-click setup.exe, choose Run as administrator and follow the installer. On the Install Options screen, don’t select “Deploy Solution To SharePoint”: the solution packages are already installed in your farm.
  4. Wait for the installer to finish updating the files deployed by the previous version. On a large farm this can take several minutes.
  5. Restart the SharePoint Timer Service (Administrative Tools > Services) and run IISRESET on every server in the farm.

Restarting the timer service and resetting IIS on all web front ends and application servers is essential. If you skip it, files can stay locked and the upgrade can fail.

Step 2: Upgrade the DocRead database and SharePoint components

  1. In SharePoint Central Administration, open Collaboris Settings.
  2. Under Installation and Upgrades, select Upgrade.
  3. If you haven’t already, back up the DocRead database, then tick the box to confirm it.
  4. If the Upgrade button under “Upgrade the DocRead database” is enabled, click it.
  5. If the Upgrade button under “Upgrade DocRead SharePoint components” is enabled, confirm you understand that sites where DocRead is activated will be briefly unavailable, then click it. This updates features, web.config files and web parts, and it can take a while.
  6. If you’ve upgraded from DocRead version 1.x, 2.x, 3.x or 4.x, enter your new DocRead version 5 license in the Collaboris licensing screen in Central Administration. Licenses for versions 1 to 4 won’t work with version 5.
  7. Run IISRESET and restart the SharePoint Timer Service on all web front ends and application servers again.

Upgrading from a version earlier than 4.0

DocRead 4.0 introduced changes to support SharePoint 2019. If you’re upgrading from an earlier version, apply them to every site where DocRead is installed: go to Site Settings, then the DocRead Site settings link, and click OK at the bottom of the page without changing anything. This updates every document library where DocRead is configured.

Step 3: Upgrade the Collaboris Notification Scheduler

The Notification Scheduler sends DocRead’s emails, so upgrade it too. You’ll need permissions on the SQL Server that holds the DocRead and Scheduler databases, and local admin rights on the server where the Scheduler runs.

  1. Copy Jobs.config and CollaborisSchedulingAgent.exe.config from the Scheduler folder (usually %ProgramFiles%/Collaboris/DocRead/Scheduler) to a safe location. Back up any changes you’ve made to these files.
  2. Uninstall the Collaboris Notification Scheduler from Control Panel > Programs. This doesn’t affect notification data in the DocRead database.
  3. Run the new Scheduler setup.exe (from your upgrade email) as administrator.
  4. Copy your saved configuration files back into the Scheduler folder, replacing the new ones.
  5. Right-click Collaboris.Readership.Administration, choose Run as administrator, and check the Scheduler and DocRead database names match those in Central Administration’s DocRead database settings.
  6. Select Scheduler in the left navigation and click Start.

After the upgrade

Test DocRead on your test farm, and then in production, before you tell users it’s back. Open a site where DocRead is activated, check that existing reading tasks and reports still show, and assign a test policy to make sure new tasks and notification emails are sent.

Moving to a new SharePoint farm?

If you’re migrating your farm rather than upgrading DocRead in place, start with how to migrate DocRead from SharePoint 2016 to SharePoint 2019 and migrating between editions, which explains how a migration affects your licensing. Note that Microsoft’s extended support for SharePoint Server 2016 and 2019 ended on July 14, 2026 (Microsoft Learn). If you’re planning a move to SharePoint Online, talk to us about DocRead for Microsoft 365.

Need help with your upgrade?

We’re happy to help with any part of the upgrade. Email support@collaboris.com with your current DocRead version, your SharePoint version and the step you’re on. For self-help, see the knowledgebase, the documentation center or the DocRead support page.

Not on DocRead yet? Download the 30-day trial of DocRead for SharePoint Server, which includes 50 user licenses, or book a demo.