Documentation Vision Audit+ Product documentation

Product documentation

Vision Audit+

Learn how to install, configure, administer, and use Vision Audit+.

Installation Guide

6 pages
Installation GuidePrepare PI Web API, AF and the PI Vision SQL database, install and license Vision Audit+, and run the Configuration Utility.OverviewThis chapter explains what Vision Audit+ does and which components you install.Prerequisites and system preparationThis chapter lists the requirements and prepares PI Web API, the service account, the AF database and the PI Vision SQL database before you install Vision Audit+.Installation and licensingThis chapter installs Vision Audit+ and activates the license.Configuration Utility first runThis chapter walks through the Configuration Utility on a new installation. Each page has a sidebar entry, and Next is enabled once the page is complete.Update or remove Vision Audit+This chapter updates Vision Audit+ to a new version and removes it.

Administration Guide

10 pages
Administration GuideSwitch features on and off, set history, retention, validation and display health policies, manage permissions, and keep the Vision Audit+ service healthy.Where settings are madeThis chapter shows which settings you change in the Configuration Utility and which in the PI Vision toolbar.Turning features on and offThis chapter switches the four Vision Audit+ features on and off.Display History settingsThis chapter sets which displays are tracked, when snapshots are taken, and how long history is kept.Permissions and securityThis chapter decides who may revert, restore, delete and validate, and explains the AF permissions behind the toolbar.Display Validation settingsThis chapter sets up the validation workflow. Users work with it in the Display Validation pane (see Display Validation in the User Guide).Data Sources and display health settingsThis chapter sets up the Data Sources feature: the data source index, the display health check and data export.System Status and high availabilityThis chapter shows how to see the service state from PI Vision and how to run more than one service node.MaintenanceThis chapter covers the logs, debug logging, AF indexes and the toolbar files.TroubleshootingThis chapter lists common problems with their cause and fix, and how to collect information for support.

User Guide

10 pages
User GuideReview display history, revert and restore displays, validate displays, check data source health, find where data sources are used, and export their values.Getting startedThis chapter shows the Vision Audit+ panes and how to open them.Display HistoryThis chapter explains the history list and the details of each version.Reverting and restoring displaysThis chapter sets a display back to an earlier version, restores a deleted display and takes snapshots.Saving a display with a reasonThis chapter applies when your administrator requires a reason for display changes.Display ValidationThis chapter explains the validation workflow: how a display is reviewed, approved and locked, and how it is changed again.Data Sources and display healthThis chapter shows the data sources of a display, explains their status, and sets up the health check of a display.Display UsageThis chapter finds every display that uses a PI Point or AF attribute, for example before you rename or delete it.Exporting dataThis chapter downloads the values of data sources as an Excel workbook or a CSV file. It is available if your administrator has turned on data export.TroubleshootingThis chapter lists problems users meet in the panes.

Reference

8 pages
ReferenceLook up feature switches, AF configuration attributes, action types, health statuses, permissions, file locations and service intervals.Feature SwitchesThis chapter lists the switches that turn Vision Audit+ features on and off.Configuration AttributesThis chapter lists the attributes of the Configuration element under \\<AF server>\<AF database>\SoftwareAthlete\VisionAudit+.Action TypesThis chapter lists the action types of the display history. The stored value is the ActionType attribute of the DisplayHistory event frame.Display Health StatusesThis chapter lists the statuses of the display health check.PermissionsThis chapter maps every toolbar action to its check. "Admin" means a PI Vision administrator. "Edit access" means the user can edit the display in PI Vision. "Owner" means the display owner in PI Vision; administrators always pass an owner check. Every action also needs the AF permissions in Create the AF database (Installation Guide).Files and LocationsThis chapter lists the files and folders of Vision Audit+.Service Intervals and LimitsThis chapter lists the timing of the service and the limits of the toolbar.