Upgrading DocView Capture

New releases of DocView Capture add features and fix problems. This page explains how to upgrade each kind of installation, what happens to your data, and how to roll back.

Before you upgrade

1. Read the release notes. Each release lists what changed in CHANGELOG.md, including any database changes. See Releases and versioning.
2. Check the version number. DocView Capture uses semantic versioning:
   • a new major version (for example 2.0.0) means administrators need to take action;
   • a new minor version (1.3.0) adds features;
   • a new patch version (1.2.1) fixes problems.
3. Back up the database. Upgrades can add to the database schema, and schema changes only go forward.
4. Try it on a test system first, if you have one. Install exactly the same release on test and then on production.

To see which version you have now, open About and support from the account menu (your initials at the top right). It shows the version and build, for example "1.2.0 · build 1205f0796c71".

What is kept

An upgrade keeps:

• your database, with all batches, Batch Setups, users and settings;
• page images and outputs in your storage location;
• appsettings.Production.json and the logs folder.

The database schema is upgraded automatically when the new version starts. Batches in progress stay on the Batch Setup version they started with.

Upgrading to 1.7

• The worker is now called DocView Worker. Setup and the install scripts replace the 1.6 service DocViewCaptureWorker with DocViewWorker and move it to C:\Program Files\DocView Worker. Its settings and database access are kept. A service that runs under a named account keeps its old name.
• People can choose the language of the screens under their initials at the top right. Nothing changes for anyone until they choose one.
• Team now is now on everyone's menu. Without the Reports.People permission it shows only the person's own figures, the team average and their place.

Setup finds what is installed

Run the new DocView Setup on a computer where DocView is already installed: it finds DocView Capture (on the PC or on IIS), DocView Worker and DocView OmniRead, says what it found and which version, chooses it, and suggests Update an existing installation. Settings, documents and the database are kept. Choose Install only to add a second, separate installation.

DocView Workers and DocView OmniRead after an upgrade

Once the website runs the new version, a DocView Worker that is older takes no new work until it is upgraded (batches it was already processing finish). A DocView OmniRead server older than the OmniRead the website offers (on Downloads) gets no OCR work until it is upgraded. This keeps old and new versions from working on the same batches.

• DocView Workers installed as a Windows service (with DocView Setup or the worker package) upgrade themselves: the scheduled task DocView Worker Update checks the server every 10 minutes, downloads the new worker package, checks it, and upgrades the service with its settings kept.
• DocView OmniRead installed as a Windows service upgrades itself the same way within 15 minutes.
• Workers and OmniRead in containers (Azure Container Apps, Docker) are upgraded by deploying the new image.
• Anything that did not upgrade itself: run the new DocView Setup on that computer (it suggests the update).

System › Upgrades shows the website's version, every DocView Worker with its version, how it runs and whether it is waiting to be upgraded, the DocView OmniRead servers, and the upgrade history: every version change of the website, the workers and OmniRead, every part found out of date, and every upgrade that failed. The DocView Workers page warns about outdated workers too.

Upgrade a single workstation

1. Download and unzip the newer DocViewCapture-Workstation-<version>.zip.
2. Double-click Install.cmd in the new folder and allow administrator rights.

Your settings, data and database are kept. When it finishes, open DocView Capture from the desktop or Start menu shortcut. See Install on a single workstation.

Upgrade an IIS installation

Take a database backup first. Then run the same scripts with the new packages, as Administrator:

.\deploy\iis\Install-DocViewWorker.ps1 -Package .\DocViewWorker-1.3.0.zip   # on every worker server
.\deploy\iis\Install-DocViewWeb.ps1    -Package .\DocViewCapture-Web-1.3.0.zip

Upgrade the DocView Workers on every DocView Worker server, then the web app. You don't need to pass the connection string or other settings again. Upgrading from version 1.6 or earlier: Setup replaces the old service DocViewCaptureWorker with DocViewWorker and keeps its settings, its name in DocView Workers and its database access.

During the upgrade:

• the web app shows a "being updated" page while its files are replaced;
• stopped DocView Workers return their batches to the queue, so no work is lost;
• the current version is zipped to DocViewCapture-backups (web) or %ProgramData%\DocViewCapture\Backups\Worker (DocView Worker), and the last 5 backups are kept;
• the database schema is upgraded when the web app starts.

Note: If your DBAs apply schema changes themselves (InitializeOnStartup set to false), ask them to run DocViewCapture-Database-<version>.sql before you upgrade. It is safe to run more than once.

See Install on IIS.

Upgrade on Azure App Service

Deploy the new packages, the DocView Worker first:

az webapp deploy -g rg-docview-prod -n contoso-docview-worker --src-path .\DocViewWorker-Azure-1.3.0.zip --type zip
az webapp deploy -g rg-docview-prod -n contoso-docview-web    --src-path .\DocViewCapture-Web-1.3.0.zip --type zip

Azure SQL has point-in-time restore built in, but taking a copy before a major upgrade is still good practice. For zero downtime, deploy to staging slots and swap. See Install on Azure.

Update the Scan Agent

The web app, the DocView Worker and the Scan Agent share one version number. After you upgrade the server, operators see a prompt on the Scan screen when their agent's version differs:

1. On the Scan screen, select Update.
2. Open the downloaded file.

The update keeps the scanner and settings, and takes a few seconds. The new agent installer is inside the web package, so you don't need to distribute it yourself.

• Operators can select Not now and keep scanning when the difference is small.
• If the agent is too old or too new to work with the server, scanning pauses until it is updated.

See Scan Agent.

Batch Setup files from older versions

Batch Setup files exported from an older version of DocView Capture can be imported into a newer one. They are upgraded on import. A file exported from a newer version is refused with a clear message, so upgrade the older system first. See Import and export Batch Setups.

After the upgrade

1. Sign in and open About and support from the account menu to confirm the new version.
2. Check Administration › DocView Workers. Every DocView Worker should be online and show the new version.
3. Import a small test batch and check that it exports as expected.

Roll back

If something goes wrong:

• Workstation: contact support before you try to go back to an older version.
• IIS: run the install scripts with the previous release's packages. Each upgrade also keeps a zip of the previous files in DocViewCapture-backups.
• Azure: deploy the previous release again, or swap the slots back.

Important: If the newer version changed the database schema, you must also restore the database backup you took before the upgrade. Schema changes are listed in CHANGELOG.md.

If you need help, see Support.