Documentation PI Nexus+ Documentation

PI Nexus+ / Reference

PI Point Rule Fields

This reference lists every field of a PI Point Rule, its default for a new rule, and the rule list's columns and actions.

Overview

This reference lists every field of a PI Point Rule, its default for a new rule, and the rule list's columns and actions.

Ownership rules

RuleBehavior
OrderRules are checked from the top. The first enabled rule that matches owns the PI Point
No rules yetThe built-in Default Quality Check applies to all PI Points: No Data Warning, Pt Created Warning, Bad Value Error, other checks off
Rules existPI Points that match no enabled rule are not inventoried
Scan and evaluate matching PI Points offMatching points are excluded and Not Evaluated; later rules are not tried for them. Previously scanned matches are marked Excluded after the next scan
Match, archive, scan switch or order changedOwnership changes; a full PI Point reconciliation is required
Data Flow, severities, reason changedNo reconciliation needed
Run Full Reconciliation unavailableAnother scan runs (Scan Already Active), or no PI Data Archive or no rule with Scan and evaluate matching PI Points is enabled (No Enabled Scan Scope)

Match fields

FieldDefaultNotes
EnabledOnOff: ignored by scans
Scan and evaluate matching PI PointsOnSee above. When off, only the Data Flow tab is shown
NameShown in issues and the rule list
PI Data ArchiveAll enabled PI serversOr one archive
PointSourceEmpty (any)Wildcards, comma-separated, for example OPC*, R
Name Include*Wildcards, comma-separated, for example *.PV
Name ExcludeEmptyWildcards, comma-separated, for example *_MANUAL*, *.SP, *.MODE
Preview Matching PI PointsCount and sample of matches for this rule alone, ignoring higher rules

Built-in Health Checks

Each check is Ignored, Warning or Error.

CheckNew-rule defaultRaised whenLimit
No DataWarningThe current value is the No Data state
Pt CreatedWarningThe point has never received a value
Bad ValueErrorThe current value is another bad state
StaleIgnoredNo fresh value within the limitDays without fresh value: 1 to 3,650, default 30
FrozenIgnoredA numeric value has not moved beyond its exception deadband within the limit. Digital, string, timestamp and blob points are never evaluatedHours without value change: 1 to 8,760, default 24
RangeIgnoredThe value is outside the point's zero and span
Rule ReasonEmptyOptional note shown with expected states

Tag Naming Pattern

Available after the rule is saved. The builder writes a regular expression that Tag name must match.

FieldValues
SeparatorDot (.), Underscore (_), Dash (-), Custom (one character)
Segment CharactersUppercase letters and numbers, Letters and numbers, Custom character class
Minimum Segments, Maximum Segments1 to 20; maximum empty means any
Allowed Final TokensComma-separated, for example PV, SP, CV
Advanced RegexThe generated expression; can be edited
Should Pass, Should FailExample tag names, one per line, checked live
Check Name, Severity, Enabled, MessageAs for point attribute checks

Point Attribute Checks

Available after the rule is saved.

FieldValues
Check NameRequired
PI Point AttributeA PI Point attribute name, for example instrumenttag, scan, location1; Name checks the tag name (Check Field)
OperatorEquals, Not equals, Is not empty, Is empty, Contains, Starts with, Matches wildcard, Matches regex, Greater than, Less than, In list
Expected Value / Regex PatternRequired for regex; for example 1, OPC*, ^[A-Z0-9]+(?:\.[A-Z0-9]+){1,}$
SeverityWarning (default), Error, Info
MessageShown when the check fails
EnabledOn by default

In a check's menu, Disable and Remove both switch the check off; it stays listed.

Compression Tuning

FieldDefaultValues
Candidate for compression tuningOnMatching points can be selected by Compression Tuning runs and plans
Signal profile overrideAuto detect (Recommended)General analog, Slow / smooth, Peak-sensitive, Step / event, Noisy / high-frequency
Protection levelNormalCritical: tighter error, peak and transition safeguards, individual review before applying, at least 99 % information fidelity on manual runs

Analysis Recalculation

ItemValue
Suggest analysis recalculationOff by default. Suggestions only, never automatic recalculation
Point limit2,000 PI Points per rule; above it, capture pauses for the whole rule
Captured fromSuccessful PI Point health refreshes and Check health on single points
EpisodeHealthy, then bad or stale, then healthy again, under the same rule and settings
Status shownMeaningNext step
Suggestions offNot enabled, or the rule or its inventory switch is offEnable the rule and inventory to collect suggestions
Not savedThe draft differs from the saved settingSave the rule
Monitoring enabledThe rule's scope is accepted. Not every point has a healthy baseline yet
Waiting for observationsNo trusted healthy observation yetRun inventory and health checks
Needs attentionScope or check problem, or more than 2,000 pointsNarrow the rule, then run inventory
Suggestion status unavailableThe status could not be loadedRetry

Data Flow

FieldValues
SourcesExternal Systems that feed the matching points. A source replaces the inferred InstrumentTag source in graphs
TargetsExternal Systems that receive data from the matching points
Connection labelOptional, for example OPC DA, PI Integrator export, CONNECT agent

Rule list

Column or actionMeaning
OrderPosition; 1 is checked first
Scan ActionScanned or Excluded
ChecksSeverity of each built-in check, with the stale days and frozen hours
StatusEnabled or Disabled
EditOpens the editor
Disable / EnableSwitches the rule
Move to top, Move up, Move down, Move to bottomChanges the order