Documentation Vision Audit+ Documentation

Vision Audit+ / Reference

Configuration Attributes

This chapter lists the attributes of the Configuration element under \\<AF server>\<AF database>\SoftwareAthlete\VisionAudit+.

Overview

This chapter lists the attributes of the Configuration element under \\<AF server>\<AF database>\SoftwareAthlete\VisionAudit+.

The default is the value on a new AF database. "Utility" means the Configuration Utility; "Toolbar" means the Configuration view in the PI Vision toolbar. The service reads the attributes every minute.

Display History

AttributeTypeDefaultValues and effectSet in
AuditAllDisplaysBooleantruetracks every display; when false, only displays with auditing enabledUtility Displays; Toolbar Track all displays
BackupStrategyStringIntelligentOnSave, Intelligent, Daily, Manual. Read at service startUtility Backup Strategy; Toolbar Snapshot strategy
IntelligentStrategyInactivityMinutesInt3215idle minutes before an Intelligent snapshot (1 or more)Utility, Toolbar
DailySnapshotTimeOfDayString00:00:00server local time of the Daily snapshot. Read at service startToolbar Daily snapshot time
RetentionPolicyStringByTimeByTime, ByCount, KeepForeverUtility Displays; Toolbar Retention Policy
RetentionPeriodDaysInt32365days kept with ByTimeUtility, Toolbar
RetentionCountInt32100entries kept per display with ByCountUtility, Toolbar
ProtectManualSnapshotsBooleantrueretention keeps manual snapshotsUtility, Toolbar
SaveReasonRequirementStringNoneNone, AllDisplays, ValidationEnabledDisplaysToolbar Require a reason when saving
RequireSaveReasonForNewDisplaysBooleanfalsethe reason policy also covers the first save of a new displayToolbar Include first-time saves
RequireSaveReasonForSaveAsBooleanfalsethe reason policy also covers Save AsToolbar Include Save As copies

Permissions

AttributeTypeDefaultValuesSet in
AllowRevertStringWriteAdmin, Owner, WriteUtility Permissions; Toolbar Revert Display
AllowRestoreStringOwnerAdmin, Owner, Read (anyone)Utility; Toolbar Restore Display
AllowPermanentDeleteStringAdminNone, Admin, OwnerUtility Permanent Delete; Toolbar Permanently Delete Displays
AllowEmptyRecycleBinStringAdminNone, AdminUtility, Toolbar Empty Recycle Bin
AllowValidateStringWriteAdmin, Owner, WriteUtility Display Validation; Toolbar Validate Display

Display Validation

AttributeTypeDefaultValues and effectSet in
EnableValidationBooleanfalsefeature switchUtility Display Validation
ValidateAllDisplaysBooleanfalseevery display is in the workflowUtility Validate all Displays by default; Toolbar Enable for All Displays
ValidationTransitionReasonRequirementStringDecisionsAndLifecycleChangesDecisionsAndLifecycleChanges (submission comment optional), AllStateChangesUtility Transition Reasons; Toolbar Require reasons for
ValidationFeatureLabelStringValidationname of the workflowUtility, Toolbar Workflow Label
ValidationValidateActionLabelStringValidatename of the approval actionUtility, Toolbar Primary Action Label
ValidationDraftStateLabel, ValidationInReviewStateLabel, ValidationValidatedStateLabel, ValidationArchivedStateLabelStringDraft, In Review, Validated, Archivedstate names; empty returns to the defaultUtility, Toolbar

Visual state indicators

AttributeTypeDefaultEffect
WatermarkShowStateBorderBooleanfalsedraws the state border
StateBorderThicknessInt323border thickness in pixels (1 to 32)
StateBorderOpacityDouble0.45border opacity (0 to 1)
StateBorderShadowBlurInt3226border shadow in pixels
WatermarkEnabledBooleanfalseshows the watermark text
WatermarkFontSizeInt3224watermark font size (8 to 240)
WatermarkPositionStringBottomLeftTopLeft, TopCenter, TopRight, Center, BottomLeft, BottomCenter, BottomRight
WatermarkOpacityDouble0.5text opacity (0 to 1)
WatermarkRotateDouble0rotation in degrees (-180 to 180)
WatermarkDraftEnabled, WatermarkInReviewEnabled, WatermarkValidatedEnabled, WatermarkArchivedEnabledBooleantrueshows the indicator in this state
WatermarkDraftColor, WatermarkInReviewColor, WatermarkValidatedColor, WatermarkArchivedColorString#6B6B6B, #C9821B, #1B7F3A, #FFFFFFstate color
WatermarkDraftText, WatermarkInReviewText, WatermarkValidatedText, WatermarkArchivedTextStringDraft, InReview, Validated, Archivedwatermark text

All are set on the Utility Watermark page and in the Toolbar Visual State Indicator section.

Data Sources and display health

AttributeTypeDefaultValues and effectSet in
EnableDataSourcesBooleanfalsefeature switchUtility Displays
EnableDataExportBooleanfalsedata export; needs EnableDataSourcesUtility Displays; Toolbar Enable data export
DisplayHealthMonitoringModeStringPerDisplayDisabled, PerDisplay, AllDisplaysUtility, Toolbar Health monitoring
DisplayHealthDefaultCheckModeStringQualityAndStaleQualityAndStale, QualityOnly, StaleOnly, IgnoreUtility, Toolbar Default datasource check
DisplayHealthStaleAfterMinutesInt321440age in minutes after which a value is staleUtility, Toolbar Value is stale after
DisplayHealthStaleDataTypesStringNumericOnlyNumericOnly, AllUtility, Toolbar Stale detection applies to
DisplayHealthAssetContextMissingBehaviorStringAllowedAllowed, Warning, ErrorUtility Missing asset-context attribute; Toolbar Missing in asset context
ShowDisplayHealthBorderBooleantruecolored border and message on Warning and ErrorUtility, Toolbar Show Status Border
AutoHighlightUnhealthySymbolsBooleanfalseoutlines symbols with problem data sourcesUtility, Toolbar

System

AttributeTypeDefaultEffectSet in
SqlServer, SqlDatabaseStringlocalhost, PIVisionPI Vision SQL Server and database; must match the licenseUtility SQL Database
SqlUseIntegratedSecurityBooleantrueWindows authentication to SQL ServerUtility
SqlUser, SqlPasswordStringemptySQL login; the password is stored encryptedUtility
SystemTelemetryEnabledBooleanfalsewrites the service state to PI Points; needed for leader election with several nodesUtility System Status
SystemTelemetryPIPointsDataArchive, SystemTelemetryServiceAccountPIIdentityStringemptyData Archive and PI identity for the telemetry pointsUtility System Status
DebugLoggingBooleanfalseservice log at debug levelToolbar Debug Logging
CompressDisplayDataBooleanfalsestores new display and history data compressed. Change only on advice from Software Athlete supportnone