Chapter 2Installation
This chapter is for the technician who installs CLARUS Prime on the laboratory's computers. It follows Setup page by page, then explains what Setup does after copying the files, how to install without administrator rights or without the wizard, and what to do when an installation stumbles.
2.1 Before starting
- Setup's file. Its name starts with
CLARUS-Prime-Setup. The same file installs a server and a member computer, in every language Setup speaks. - An administrator account. Setup asks for administrator rights when it starts. Without them the database cannot be registered as a Windows service (see 2.10 Installing without administrator rights).
- The internet. It is not required to install. But the trial starts with the supplier's signature, which Setup fetches while it installs (see 3.2 The trial).
- The old program closed, if a version is already installed on this computer. Setup does not install over a program that is still running and holding its files.
2.2 Setup's pages, in order
Setup first asks for its language. From then on, every page, the licence and the data statement are in that language.
| Page | What it asks | When it shows |
|---|---|---|
| Welcome | Nothing | Always |
| The licence agreement | Acceptance of the licence | Always |
| Installation type | Branch server, or a computer in an existing branch | A new installation. An update keeps the role it finds |
| Data & Privacy | Agreement to how the program handles the laboratory's data | A server only |
| Checking this computer | Nothing; it shows what it found | Always for a server. For a member, only when it found something to fix |
| Ready to install | The recommended way, or choosing each part | A new laboratory's server |
| The folder | Where the program goes | When choosing each part, and for a member |
| A laboratory already on this computer | What the installation starts from | Only when Setup finds earlier data or backups for the chosen folder |
| Where the backups go | The backups folder | A server, when choosing each part |
| The laboratory's languages | The languages besides English | A new server, when choosing each part |
| The laboratory's country and this computer's settings | The country, the currency, the paper and the time zone | When choosing each part, and whenever Windows did not give the country |
| Activation | The serial number, or the member computer's licence number | Always |
| Ready | A summary of the choices | Only when choosing each part |
| Installing, then the finish page | Nothing | Always |
2.3 Server or member
The "Installation type" page has two choices:
| Choice | What it means |
|---|---|
| Branch server | The branch's database is kept on this computer and the program runs on it. Choose it for the first computer of a laboratory or a branch |
| A computer in an existing branch | It works on its branch server's database, and joins it with this computer's own licence number once the branch server allows that number. Nothing of the laboratory's data is kept on it |
A member computer's Setup is shorter: it has no Data & Privacy page, no backups page and no languages page, because none of them belongs to it. The member joins its server the first time the program starts (see Chapter 5: Network, branches and Clarus Link).
2.4 The recommended way, or choosing each part
For a new laboratory's server, the "Ready to install" page shows what Setup will do: the program's folder, the laboratory's data, its backups, and the country and currency. It offers two ways:
- Install this way (recommended). Setup goes straight to activation, and then installs.
- Let me choose the folders, the languages and the country. Setup shows each of those pages, then a summary before installing.
The recommended way still asks for the country if Windows did not give it. Nothing is chosen for the laboratory by guessing.
2.5 The folders
The program's folder. When the computer has a fixed drive D, Setup proposes D:\Clarus\Clarus_prime. Without one, C:\Program Files\Clarus\Clarus_prime. Either can be changed on the folder page.
The backups folder. Beside the program's folder on drive D: D:\Clarus\Clarus_prime-backups. Without drive D, C:\ProgramData\Clarus\Clarus_prime-backups. Why a second disk is better is explained in 8.2 Where the backups are kept.
The data folder. The database, the encryption keys and the logs. Setup places it by these rules, in order:
- An update keeps the data folder the installation already has.
- If the program is under Program Files, the data goes to
C:\ProgramData\Clarus\Clarus_prime\data. - Otherwise, the data folder is inside the program's folder:
D:\Clarus\Clarus_prime\dataon drive D.
Every path is listed in B.1 The main folders.
2.6 A laboratory already on this computer
If Setup finds the data or the backups of an earlier installation for the chosen folder, it asks what this installation starts from:
| Choice | What happens |
|---|---|
| Use the laboratory's data in the folder it found | The database is used as it is. The laboratory comes back with its users and data |
| Restore the newest backup | The laboratory is restored from that backup |
| Start a new laboratory | A new database. The earlier data stays where it is |
Nothing is deleted, whichever is chosen. 15.2 Reinstalling over existing data explains when this page appears after uninstalling.
2.7 Activation in Setup
On a server, the serial number is optional. Left empty, the program starts its full 14-day trial. The serial can be activated at any time from the licence screen inside the program (see 3.3 Activating the licence).
Setup checks the serial as it is typed. If one character does not match the rest, it says so: 1 and I, and 0 and O, are the usual pair.
On a member computer, the box takes this computer's own licence number in its branch. A member has no trial. If the number is not at hand, leave the box empty and type it in the program's window after installing.
2.8 What Setup does after copying
After copying the files, Setup runs the installation script. It:
- Records everything it does in
install-transcript.log, in the program's folder. - Picks the program's port: the first free one from 8000 (see A.1 Ports listening on the server).
- On a server, prepares the laboratory's database. This is the longest step. Then it registers the
ClarusPrimePostgresservice so the database starts with the computer (see 4.2 The database). - Adds the program to Windows' "Installed apps", under the name
Clarus_prime. - Registers the scheduled tasks in the
\Clarus\Clarus_prime\folder: updates, remote support, the firewall rules, and the program's start at sign-in (see C.2 Scheduled tasks). - Starts the trial or the activation, if the computer can reach the supplier.
2.9 When Setup finishes
The finish page says how the installation ended:
| What it says | What it means |
|---|---|
| The program is activated and ready | The serial was accepted |
| Your trial has started | No serial was typed, and the trial was signed |
| The serial was not accepted | The program is installed and works in its trial. Try the serial again from the licence screen |
| The trial starts with our signature, which did not arrive | The computer could not reach the supplier. Open the program with the internet and start the trial from its screen, or with the phone code it shows (see 3.2 The trial) |
| Setup did not finish | The files were copied, but the database could not be prepared. See the 2.12 When installation stumbles |
The first time a new laboratory opens the program, it asks for the laboratory's name, its contact numbers and its logo, and nothing more (see 3.1 The first setup).
2.10 Installing without administrator rights
When Setup starts, Windows asks for administrator rights. A user who cannot give them may install the program for their own account only. Then:
- Without drive D, the program goes to
%LOCALAPPDATA%\Programs\Clarus\Clarus_prime. - The database is not a service. A sign-in task named
ClarusPrime PostgreSQLstarts it when that user signs in, and only then (see 4.2 The database). - Updates and remote support will ask for administrator rights each time.
If the program is already installed for another account, or with other rights, Setup warns: installing again makes a second copy, with its own folder and its own database. The laboratory's data would then be in one copy and not the other.
2.11 Installing without the wizard
To install on several computers, run Setup from a command line with administrator rights:
CLARUS-Prime-Setup.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /LOG="C:\setup.log"
/LOGrecords Setup's own steps in that file. Without it, Setup keeps no log of its own./ROLE=membermakes the member computer the default installation type.- Without administrator rights, the database is not registered as a service.
Setup's exit code tells a deployment script how it ended:
| Code | Meaning |
|---|---|
| 0 | Finished |
| 3 | The files are in place, but the database could not be prepared. The program will not start |
| 1 | The installation script stopped on an error of its own. The program will not start |
When the code is not 0, the reason is in install-transcript.log in the program's folder.
2.12 When installation stumbles
| What shows | Likely cause | What to do |
|---|---|---|
| The computer check refuses to continue | A 32-bit system, Windows older than 10, or less than 5 GB free on the system drive (2 GB for a member) | Solve what the page names, then run Setup again (see 1.2 The server) |
| The computer check says a port is in use by another program | Another program already listens on it | Nothing: the program takes the next free port and records it (see A.1 Ports listening on the server) |
| The computer check warns about other security software | An antivirus other than Windows Defender | Nothing at first. If the database then fails to start, allow the program's folder in that antivirus and install again |
| "Setup did not finish" with an error code | The database could not be prepared | Restart the computer, then run Setup again as an administrator. If it fails again, send install-transcript.log to support |
| The program already on this computer is still running | The old version holds its files | Close it, or restart the computer, then run Setup again |
| "The database service could not be registered" | Setup did not run as an administrator | Run it again as an administrator. Until then, the database does not start after a restart |
| The finish page says the trial's signature did not arrive | No internet during installation | Start the trial from the program's screen with the internet, or with the phone code |