Documentation PI Nexus+ Documentation

PI Nexus+ / Reference

Reference

Look up issue catalogues, health states, defaults, intervals, rights, ports, and paths.

Overview

Software Athlete

Version: 1.7.0.0

This Reference holds the tables the Installation, Administration and User Guides link to: settings, defaults, states, thresholds, issue catalogues, rights, ports and paths.

The documentation has four parts:

  • Installation Guide: plan, install, upgrade and repair PI Nexus+, and fix installation problems.
  • Administration Guide: connect PI Data Archives, AF, PI Vision and hosts, set up scan automation and notifications, and keep PI Nexus+ running.
  • User Guide: find unhealthy objects, investigate issues, follow dependencies and changes, and confirm repairs.
  • Reference (this document, online only): the tables behind all three guides, such as defaults, states, issue catalogues, rights and ports, at https://www.software-athlete.com/pages/documentation-pi-nexus-reference.

Articles in this category

38 articles
Ports and FirewallThis reference lists every network connection PI Nexus+ makes, so you can request firewall rules before installation. Plan the Deployment in the Installation Guide shows the same connections as a diagram.PrerequisitesThis reference lists what each PI Nexus+ server needs, what the setup program installs itself, and what the installer creates.Paths and FilesThis reference lists the folders, files, logs and settings files of a PI Nexus+ installation. On a split deployment each server has its own copy of the data folder.SQL Server Rights and SizingThis reference lists the SQL Server rights each setup step needs, what the preparation script does, and the tempdb figures for the PI Nexus+ instance.Service Account RightsThis reference lists the rights of the PI Nexus+ service account, where each is needed, and what happens when one is missing.Installer and Script ParametersThis reference lists the installer's pages and properties, how it behaves on upgrade, repair and removal, and the parameters of the setup and recovery scripts.Schema MigrationsThis reference describes how PI Nexus+ keeps its database schema in step with the installed version: the migration files, the ledger, and the time limits that apply.Deployment Readiness ChecksThis reference lists the groups and checks on Admin > Support > Readiness. The tab is checked again each time Admin > Support opens.License StatesThis reference lists what PI Nexus+ checks in a license, the states a license can be in, and what each state allows.Roles and PermissionsThis reference lists what each PI Nexus+ role may do, how roles are assigned, and how to recover Admin access. The same checks apply in the web interface and in the API.PI Data Archive SettingsThis reference lists the columns, actions and dependent features of Admin > PI Data Archives, and the statuses of PI Interface runtime monitoring.AF Server SettingsThis reference lists the settings of AF servers and AF databases under Admin > AF Servers, the rules for scanning them, and the analysis recalculation permission.OpenID Connect SettingsThis reference lists the OpenID Connect client settings, the registration values for AVEVA Identity Manager, and the commands for the secret certificate.PI Vision Instance SettingsThis reference lists the fields, defaults and actions of a PI Vision instance under Admin > PI Vision Instances.PI Point Rule FieldsThis reference lists every field of a PI Point Rule, its default for a new rule, and the rule list's columns and actions.External System SettingsThis reference lists the fields and defaults of an External System, its data health policies, and the archive and delete rules.PI Adapter Monitoring StatusesThis reference lists the source statuses on Admin > PI Adapters, the Runtime statuses of PI Adapter Collectors, the service issues and the fixed thresholds.Sites and Change Tracking SettingsThis reference lists the rules for sites and the change tracking settings.Scan Automation ReferenceThis reference lists the cadences, windows, queue rules and timings of automatic monitoring. The Administration Guide chapter Scan Automation links here instead of repeating them.Scan Runs ReferenceThis reference lists the kinds of scan work, what starts them, their scopes and their outcomes, as the Scanning page and the scan history show them.Notifications ReferenceThis reference lists every email PI Nexus+ sends, its settings and defaults, and how delivery, retries and sites work. The Administration Guide chapter Notifications links here.Logs and Support Bundle ReferenceThis reference lists the log files, log levels, event log sources and the contents of the support bundle. The Administration Guide chapter Support and Diagnostics links here.Retention and Maintenance ReferenceThis reference lists how long PI Nexus+ keeps each kind of data, when cleanup runs, and what each purge and reset removes. The Administration Guide chapter Inventory Maintenance and SQL Admin UI links here. Times are the scanner server's local time.Health and KPI CalculationThis reference lists the health states, how an object's health follows its issues, how the dashboard percentages are calculated, and the rules for suppressing issues. The User Guide chapters Health, Issues and KPIs and Investigate an Issue link here.Dashboard ReferenceThis reference lists what each part of the Dashboard shows, its limits and what a click opens. The percentages and bands are defined in Health and KPI Calculation.Servers and Sites ReferenceThis reference lists the service health rules, the columns and dialogs of the Servers page, and how objects belong to sites. The User Guide chapter Servers and Sites links here. The Hosts tab is described in Host Monitoring Reference.Scanning Page ReferenceThis reference lists the cards, tabs, columns, filters and actions of the Scanning page. Kinds of work, triggers, scopes and outcomes are in Scan Runs Reference; cadences and the heavy-work window in Scan Automation Reference.Detail Dialogs and Dependency GraphThis reference lists the tabs and actions of each detail dialog, the dependency graph controls and limits, and the Issues page filters. The User Guide chapter Investigate an Issue links here.Navigation, Search and ExportsThis reference lists the navigation and its roles, what search covers, which pages follow the site, the CSV exports, Change History filters, and what the Evaluation edition locks. The User Guide chapters Getting Started and Change History, Missing Inventory and Exports link here.PI Point IssuesThis reference lists the issues PI Nexus+ raises for PI Points and PointSources, the PI Point health states, and the rule defaults behind them. The User Guide chapters PI Points and Point Sources link here.PI Interface Issues and RuntimeThis reference lists the PI Interface issues, the runtime statuses and the runtime thresholds. The User Guide chapter PI Interfaces links here.PI Adapter Issues and RuntimeThis reference lists the PI Adapter statuses, issues and thresholds. The User Guide chapter PI Adapters links here.AF Issues and ThresholdsThis reference lists the issues PI Nexus+ raises for AF attributes and AF analyses, the analysis thresholds and the attribute scan modes. The User Guide chapters AF Attributes, Elements and Templates and AF Analyses and Recalculation link here.PI Vision IssuesThis reference lists the issues PI Nexus+ raises for PI Vision displays and how display health is counted. The User Guide chapter PI Vision Displays links here.External System IssuesThis reference lists the External System issues and the defaults that turn PI Point health into External System health. The User Guide chapter External Systems links here.Compression Tuning ReferenceThis reference lists the classifications, observation modes, limits, profiles and statuses of Compression Tuning. The User Guide chapter Compression Tuning links here.Analysis Recalculation ReferenceThis reference lists the rules, states, limits and permissions of analysis recalculation, scheduled recalculation and recalculation suggestions. The User Guide chapter AF Analyses and Recalculation links here.Host Monitoring ReferenceThis reference lists the issues, limits, rights, ports and timings of host monitoring. The Administration Guide and the User Guide link here instead of repeating these values.