PI Nexus+ / Reference
Paths and Files
This reference lists the folders, files, logs and settings files of a PI Nexus+ installation. On a split deployment each server has its own copy of the data folder.
Overview
This reference lists the folders, files, logs and settings files of a PI Nexus+ installation. On a split deployment each server has its own copy of the data folder.
Folders
| Item | Path |
|---|---|
| Installation folder (default) | C:\Program Files\Software Athlete\PI Nexus+ |
| Web application | ...\PI Nexus+\Web |
| Scanner service | ...\PI Nexus+\Worker (PINexus.Worker.exe) |
| Setup and recovery scripts | ...\PI Nexus+\Admin |
| Schema migrations used by Database Setup | ...\PI Nexus+\Admin\Migrations |
| Installer helper scripts | ...\PI Nexus+\Installer |
| Data folder | C:\ProgramData\Software Athlete\PI Nexus+ |
| Logs | C:\ProgramData\Software Athlete\PI Nexus+\Logs |
| Compression tuning working files | ...\ProgramData\Software Athlete\PI Nexus+\CompressionTuningSpool and CompressionTuningPreviews |
Scripts in the Admin folder
| File | Purpose |
|---|---|
Setup-Database.bat | Starts Database Setup interactively |
Setup-Database.ps1 | Database Setup; can be run with parameters |
Prepare-Database.sql | One-time preparation by a SQL administrator |
Recover-AdminAccess.bat | Restores an Admin role mapping; asks for the group |
Recover-AdminAccess.ps1 | The same, with parameters |
The parameters are in Installer and Script Parameters.
Installation logs
The application logs (pi-nexus-api-<date>.log, pi-nexus-worker-<date>.log) and log levels are described in Logs and Support Bundle Reference. Installation writes these:
| File | Written by | Notes |
|---|---|---|
pi-nexus-installer-<yyyyMMdd>.log in the Logs folder | Installer helper scripts | IIS and service configuration, bootstrap writing |
| Setup program log | Setup program | %TEMP% by default; set with /log "<path>" |
| MSI log | msiexec | Only when you pass /l*v "<path>" |
| Windows Application log | Sources PI Nexus+ Installer, PI Nexus+ API, PI Nexus+ Worker | Installer messages use event ID 5100 |
bootstrap.json
C:\ProgramData\Software Athlete\PI Nexus+\bootstrap.json tells both processes which database to use. It is written by the installer, by Database Setup or by Admin > SQL Server > Apply. Upgrades and uninstall keep it. The processes read it at startup, so restart the app pool and the scanner service after changing it.
| Key | Meaning | Default |
|---|---|---|
server | SQL Server instance | Required |
database | PI Nexus+ database | Required |
logLevel | Base log level: Debug, Information, Warning or Error | Information |
secretCertificateThumbprint | Certificate in LocalMachine\My that protects stored secrets instead of Windows DPAPI. Needed on both servers of a split deployment that uses OpenID Connect | Absent: DPAPI |
startupMigrationTimeoutMinutes | How long the web application's start may spend on schema migrations | 120; at most 55 under IIS |
PI Nexus+ connects with Windows authentication as the process identity. Readiness warns under ProgramData ACLs when the data folder or bootstrap.json can be written by a broad group; limit write access to local administrators and the service account.
Registry
Value under HKLM\Software\Software Athlete\PI Nexus+ | Meaning |
|---|---|
InstallFolder | Installation folder, kept for upgrades |
IisPort | Port of the site, used for the shortcuts on upgrade and repair (installations before 1.7.0 fall back to 5139) |
ProgramDataInitialized | Marks the data folder as created |
