Vision Audit+ / Administration Guide
Display History settings
This chapter sets which displays are tracked, when snapshots are taken, and how long history is kept.
Overview
This chapter sets which displays are tracked, when snapshots are taken, and how long history is kept.
Set these on the Displays and Backup Strategy pages of the Configuration Utility, or in the Display History section of the Configuration view.
Tracked displays
Enable Auditing for All Displays by Default (Configuration view: Track all displays) tracks every display. When it is off, no display is tracked until a user with edit access selects Enable Auditing in its Display History pane.
Validation actions are always recorded, even for displays that are not tracked.
Snapshot strategy
The snapshot strategy decides when a change becomes a history entry.
| Strategy | When a history entry is created | Use it for |
|---|---|---|
| On Every Save | after every save of a display | the most detailed history; the list can become long for displays that are saved often |
| Intelligent (Recommended) | when a display has not been saved for the Inactivity Delay (default 15 minutes); rapid saves become one entry | most installations |
| Daily Summary | once a day at the daily snapshot time, one entry per changed display | displays where one entry per day is enough |
| Manual Only | only when a user selects Create Snapshot | tightly controlled change processes |
The daily snapshot time (default 00:00, server local time) is set only in the Configuration view, as Daily snapshot time in 24-hour HH:mm format.
Important: Restart the Vision Audit+ service after you change the snapshot strategy or the daily snapshot time. The service reads both only when it starts.
With every strategy except On Every Save, users can take manual snapshots. A save that requires a reason (see Save reasons) is always recorded right away, whatever the strategy.
Retention
The retention policy deletes old history entries once a day at midnight (server local time).
| Policy | Effect |
|---|---|
| By Time (default, 365 days) | deletes entries older than the number of days |
| By Count (default 100) | keeps the newest number of entries per display |
| Keep Forever | deletes nothing |
Retention never deletes the first entry (Create) of a display or its validation entries (Submitted, Validated, Rejected, Revoked, DeValidated, Archived, Reactivated, and enrolling or removing the display from validation), so the validation record stays complete. Protect Manual Snapshots (default on) also keeps manual snapshots, whatever their age. Kept entries do not count toward the By Count limit.
Save reasons
Save reasons make users enter a reason before PI Vision saves a display. The reason becomes the history entry's Reason. Set the policy in the Configuration view, Display History section, under Require a reason when saving:
| Setting | Effect |
|---|---|
| None (default) | no reason dialog |
| All Displays | a reason is required for every save of an existing display |
| Displays where validation workflow is enabled | a reason is required only while validation is on and the display is in the validation workflow |
When a policy is set, two more switches appear: Include first-time saves (the first save of a new display) and Include Save As copies. Both are off by default. For Save As under the validation policy, the enrollment of the source display counts.
The reason dialog covers saves in the PI Vision editor. Changes made directly through PI Web API or in the SQL database bypass it. If AF is unavailable when a user saves, the toolbar warns the user and lets PI Vision save anyway; the history entry then shows a warning that the reason is missing.
