Skip to content

Install the service ​

One installer ships both components: the Service (the analysis engine and API) and the Launcher (the administrator's control panel).

Requirements ​

  • Windows x64. The requirement is not negotiable — the model reader calls into a native xpress9 decompressor built for win-x64.
  • Administrator rights, to register a Windows service and add a firewall rule.

Run it ​

Run PbiAnalyzer_Setup_<version>.exe as an administrator. It:

  • installs to C:\Program Files\Soterre PBI Analyzer\ — the Launcher at the root, the backend in a Service\ subfolder;
  • registers the PbiAnalyzer.Service Windows service as LocalSystem, auto-start, with auto-restart on crash;
  • adds an inbound firewall rule for the public API port 4533 only. The admin port is bound to loopback, so it is never exposed and deliberately gets no rule;
  • creates a Start Menu shortcut for the Launcher, and optionally a desktop icon.

First run ​

Open the Launcher

Start Soterre PBI Analyzer. It detects the running service and shows Mode Service and Status Running.

Create the admin password

Click Admin Password…. This is the only way to set it — there is no first-run web page, so the Admin Console stays unreachable until you do this.

Open the Admin Console

Click Open Admin Console, sign in, and add your tenant connections.

Ports ​

PortBindingPurpose
45330.0.0.0The port Soterre calls.
5001127.0.0.1The Admin Console. Loopback only, by design.

To change either, edit both Service\appsettings.json (Api:Urls, AdminUi:Url) and the Launcher's launcher.json (Port, AdminPort) so the Launcher talks to the same ports, then restart the service. If you move the public port, update the firewall rule too.

The Launcher's Settings button edits the launcher side of that pair.

Upgrading ​

Run the new installer over the old one. Service registration, firewall rule and shortcuts are refreshed; data in C:\ProgramData\Soterre PBI Analyzer\ is left alone, so connections, the admin password and the integration token survive the upgrade. The installer does replace Service\appsettings.json and recreates the firewall rule for port 4533, so any change you made there — ports included — has to be made again after upgrading.

Uninstalling ​

Uninstall stops and removes the service and the firewall rule. It leaves C:\ProgramData\Soterre PBI Analyzer\ in place — admin password, connections, key ring and the capacity database. Remove that folder by hand if you want the data gone.

Soterre PBI Analyzer — part of Soterre Enterprise