PI Vision administration guide
How to Update Vision Report+ and Vision Audit+
Run the matching MSI installer, let it update the product database and PI Vision toolbar, refresh the browser extension files, and verify the service and one representative workflow before closing the maintenance window.
Before you begin
This procedure applies to an existing Vision Report+ or Vision Audit+ installation. The products use separate installers, Windows services, databases, and PI Vision toolbars, so update and validate each installed product independently.
Prerequisites
- Download the intended customer package and read its release notes and supplied Installation and Administration Guide.
- Confirm the product, current version, target version, PI Vision node, and maintenance window.
- Use an account permitted to install software and update the product database and PI Vision toolbar.
- Choose a known report or a non-production audit display for post-update validation.
- Keep the previous installer and an approved server, database, or virtual-machine rollback point.
1. Confirm the package and target server
Match the package to the installed product. Use VisionReport.Installer.msi for Vision Report+ and VisionAudit.Installer.msi for Vision Audit+. Do not run one product's installer as a substitute for the other.
Record the downloaded package name, target version, source, and the PI Vision server or node on which it will run. If the environment contains several PI Vision nodes, list every node that carries the product service and toolbar so none are left on the previous release.
Vision Report+
Confirm a representative report definition, output type, delivery path, and execution that can be used as the acceptance test.
Vision Audit+
Choose a non-production display whose history, toolbar, and controlled test change can be checked without affecting a validated production display.
2. Record the current state and rollback point
Before starting the installer, record the installed version, Windows service state, service logon account, license status, target PI Vision URL, and any release-specific configuration. Capture screenshots or an export from the Configuration Utility when that is part of your normal change record.
Create the rollback point required by your server and database change procedure. Retain the previous MSI and protect the existing product data and configuration. The updater migrates the product database; a rollback should therefore restore a complete known-good state rather than mixing an older application with a newer database.
3. Stop the product service if required
The current administration guides describe stopping the Vision Report+ or Vision Audit+ Windows service as optional for an update. Use the service action defined in your maintenance plan. Stopping it prevents new work during the installer run, but it also pauses scheduled reporting or display-history processing for that product.
For redundant installations, update one node at a time and confirm the active node and heartbeat before and after each change. Do not disable telemetry merely to run the update. With telemetry disabled, multiple Vision Report+ services can process work independently, and multiple Vision Audit+ services no longer share leadership coordination.
4. Run the matching MSI installer
Run the approved MSI on the target server and complete the installer. Confirm the product name and installation target before accepting each prompt. Do not launch both product installers simultaneously.
The installer updates the product database and the corresponding PI Vision toolbar automatically. Wait for an explicit completion result and record any warning or error. If the installer reports that a database or toolbar update could not be completed, do not treat the maintenance as finished.
5. Complete the Configuration Utility when required
If the installer could not update the database or PI Vision toolbar—for example, because the installer account lacked the required permissions—open the matching Configuration Utility with the approved administrative account and complete its configuration sequence.
Review the settings before applying them. Confirm the existing PI Web API, Asset Framework database, service account, delivery, storage, licensing, telemetry, and authentication values rather than replacing them with guessed defaults. Apply the configuration, then start the product service if it is not already running.
In Windows Services, verify that the service uses the intended Log On As account and remains running. If it starts and then stops, use the product log and Windows Application event log before rerunning the installer.
6. Refresh the PI Vision toolbar files
Browsers may keep the previous extension files for up to 24 hours. In a test browser, open PI Vision and press F12. Select the Network tab, enable Disable cache, and reload PI Vision while Developer Tools remains open. Close Developer Tools after the new toolbar has loaded.
If only one user still sees the previous toolbar after the server-side update, test a hard refresh or a new browser session before changing the installation again. If every user sees the old toolbar, verify the installer or Configuration Utility result on each PI Vision node.
7. Validate the updated product
Do not close the maintenance window after checking only that the service is running. Test one complete product workflow with a representative non-administrator account as well as the administrative account used for the update.
- Confirm the Windows service remains running and the installed version matches the change record.
- Open the Vision Report+ or Vision Audit+ toolbar in PI Vision and confirm that it loads without an error.
- For Vision Report+, run a known on-demand report and check its status, output, storage, and configured delivery. Where used, confirm schedule, event trigger, approval, or collection behavior separately.
- For Vision Audit+, open the chosen non-production display, verify its history, make one controlled test change if permitted, and confirm that the expected history or snapshot appears.
- Check the browser console and network requests for failed extension files or authentication errors.
- Review the product log and Windows Application event log for new startup, database, permission, or dependency errors.
- Repeat the checks on every updated node and record the tester, time, product version, and result.
Keep the rollback point until the updated service has completed the validation period defined by your change process.
Roll back a failed update
- Remove the affected node or product from normal use and stop new executions or display changes.
- Save the installer result, product logs, Windows Application events, and the exact failing test.
- Restore the approved complete rollback point, or use the previous installer only when the supplied administration guide or Software Athlete support confirms that path for the database version.
- Start the restored service, refresh the browser cache, and repeat the same acceptance test.
- Do not delete the product AF database or toolbar files as an update rollback shortcut.
Troubleshooting
C:\ProgramData\Software Athlete\Vision Report+\Logs or C:\ProgramData\Software Athlete\Vision Audit+\Logs.Common administration questions
Vision Report+ and Vision Audit+ update FAQ
Do I have to stop the Windows service before updating? +
The current product administration guides list the service stop as optional. Follow your maintenance plan. Stopping the product service gives a clean pause but also pauses scheduled reports or audit processing until it starts again.
Which installer should I run? +
Run VisionReport.Installer.msi for Vision Report+ or VisionAudit.Installer.msi for Vision Audit+. Verify the product and release before running the package.
When should I run the Configuration Utility? +
Run it after the MSI when the installer could not complete the database or PI Vision toolbar update, or when the release notes explicitly require configuration review. Preserve the verified environment values instead of substituting guessed defaults.
Where can I check the latest release requirements? +
Use the Software Athlete release history, then read the Installation and Administration Guide supplied with the downloaded package. The current detailed release overviews are available for Vision Report+ v1.13 and Vision Audit+ v1.4.
