Chapter 9Updates and rollback
This chapter is for the support technician and the laboratory's computer administrator. It explains:
- How the program learns of an update, and how it is downloaded and installed.
- What is kept before an update, and when the previous version comes back.
- How member computers update, and what to do when an update stumbles.
9.1 How an update arrives
The program asks Clarus's server for updates when it starts, then every six hours. This is switched off or on by the setting Check for updates online in General settings, which is also shown at the first run. To look for updates the program asks the Clarus server every six hours, sending this installation's code, the computer's fingerprint, the licence, counts of the laboratory's work (patients, orders, samples, results and reports) and its hours of operation. The analyzers' connection profiles are uploaded to Clarus to be kept. No patient's name or data is sent.
To look by hand: from the Settings menu open Licence, then Check for an update in the Update section. The same section shows the Current version.
Every update is signed. The program checks its signature after downloading it and before installing it, and an update whose signature does not hold is never installed.
An update the check found. When the check finds a newer version that is not required, the program says so without stopping anyone. Whoever holds the Manage program updates permission sees a notice at the bottom of the screen naming the version found. Once closed, it does not come back for that version on that computer. In Licence, the Update section says the version is available and not downloaded yet, and it carries Download and prepare for the same person. The update is then downloaded and checked while the program works, and it is installed only when someone presses Update now (see 9.2 Installing).

9.1.1 A required update
An update may be required by a deadline. Until the deadline, its window reads A required update and shows the Time left, with Download and prepare and Update now. Nothing is refused while the time runs.
If the deadline passes without it: The required update's deadline has passed. The program now opens only to update; verified results can still be read, printed and delivered. In detail:
- Refused: new work. That is registering a patient, entering a result, a payment, an approval or a decision about money, pairing a phone, and changing a setting. The refusal names the version the laboratory must reach.
- Still allowed: reading every screen, and printing. Also signing in and out, the update itself, the licence, and taking a backup before updating. A verified result can still be delivered by the portal link, the result message or the manager's phone. On the manager's phone, taking access away still works: suspending a user, ending their sessions, switching work from outside off, and unpairing a phone. The exchange between a chain's branches is never stopped.
A failed update never locks. If the program tried the required update and it failed, the window says that the update did not complete. The program keeps working, and support is told of it at the next check. Read the update's log (see 9.5 The log and failures) and try again.
9.2 Installing
When an update is ready, the An update is ready to install window appears at the head of the program. It shows what is Installed now, what it Will become, and What this update changes. It is installed by whoever holds the Manage program updates permission. Anyone else is told: Ask the laboratory's system administrator to update it.
- Download and prepare: the update is downloaded and checked while the program works as usual.
- Update now: Installing closes the program and reopens it. Finish what is on the screen first.
During installation:
- The program is stopped.
- The current program folder is copied to
updates\rollbackin the data folder, into a folder named with its date and time. Only the two newest copies are kept. - The program's files are replaced with the new version's.
- The program is started again. At its first start it brings the database up to the new version by itself.
The installation is run by the Updater task under the system account (see C.2 Scheduled tasks). If that task is not registered, the update asks Windows for administrator rights.
Without internet. The newer Setup is installed over the existing installation. It keeps its folder and its data, and replaces only the program's files (see Chapter 2: Installation).
9.3 Member computers
A member computer takes its update from its branch's server, not from the internet. It is installed at its next start, or at once if the update is required. So update the server first, then restart the program on the members.
A member computer left on an older version than its server may be unable to do some work, such as printing reports silently (see 7.5 When the printer does not print).
9.4 Going back to the previous version
- By itself: if replacing the files fails during installation, the program puts back what it replaced, and the previous version stays as it was.
- After installation: there is no button on the screens to go back. If the program does not start after an update, contact support. The previous version is kept in
updates\rollback, so nothing in it is moved or deleted by hand.
9.5 The log and failures
Each update has a log in logs in the data folder, named clarus-lis-updater-<date and time>.log. A failed update is also written to updates\handoff, in a file starting with failed-. The state of the last update shows in Server and updates.
| What shows | Likely cause | What to do |
|---|---|---|
| The update service could not be reached. | No internet, or a firewall blocking port 443 | Check the connection (see A.3 Connections going out of the laboratory), or update without internet |
| The update could not be downloaded and prepared. | The download was cut, or the update's signature did not hold | Try again. If it happens again, contact support |
| The update could not be applied. | Installation failed, and the previous version stayed | Read the update's log, and try again after closing every window of the program |
In the log: Package SHA-256 mismatch or did not verify | The downloaded update file is damaged | Download it again |
In the log: The database service could not be started again | The database did not come back after the update | See 4.6 When the database does not run |
| The program does not start after the update | A failure at the new version's first start | Contact support, and do not touch updates\rollback |