Skip to main content
PI System
PI Manual Logger
Data Entry
Data Validation

Can You Require Comments for Every Entry in PI Manual Logger?

Explore whether PI Manual Logger can force users to enter a comment for every manual data entry—and what alternatives might exist if this feature is essential for your process.

Roshan Soni

4 min read

Forcing Comments on Every Data Entry in PI Manual Logger: Is it Possible?

PI Manual Logger is a vital tool for many organizations that require structured, auditable, and user-friendly manual data entry into the PI System. One common user requirement is the ability to mandate that every manual entry during a tour run be accompanied by a comment, providing crucial context and supporting data quality and compliance.

In this post, let's address a frequently asked question: Can you require comments for every single data entry in PI Manual Logger, regardless of value, and can this be set at the tour or tag group level?

The Built-in Comment Requirement Features

PI Manual Logger 2010 R2 (and later versions) offers data validation options that enable you to trigger mandatory comments when a value falls outside specified LoLo/Low/High/HiHi thresholds. In other words, if a user enters a value outside of these limits, a comment is required before they can continue. This feature helps capture context for anomalous or out-of-bound entries.

The Limitation: Always-Required Comments

Unfortunately, as of PI Manual Logger 2010 R2, there is no built-in configuration option to force a comment entry for every value, regardless of whether it triggers a validation threshold. The trigger mechanism is tightly coupled with the limit-based validation structure. That means you can't directly set a 'require comment' rule for all entries without using those limits (such as setting very narrow limits to always trigger), which is not an ideal or scalable approach.

Group or Tour-Level Comment Requirements

Similarly, while PI Manual Logger allows you to define data validation and triggers for individual points or groups of points, there is no global tour-level or tag-group-level setting to mandate comments for all value entries as a policy.

Workarounds & Considerations

If your workflow or compliance requirements mandate a comment for every entry, you have some (less-than-ideal) options:

  • Training & SOP: Instruct data entry users to always include a comment, even if not technically required.
  • Custom Development: Extend or automate PI Manual Logger workflows with scripting, or develop a wrapper application using the PI AF SDK to enforce comment entry before saving values (this requires significant custom coding).
  • Very Tight Limits: As a workaround, set limits narrowly so that any reasonable value will always trigger the comment requirement—but this can be cumbersome and may lead to user frustration.
  • Submit a Feature Request: If this is a critical business need, consider submitting a feature request via OSIsoft feedback channels. Over time, user feedback does influence product roadmaps.

Summary

  • PI Manual Logger's comment requirement is limit-triggered, not universal.
  • No tour- or group-level global comment policy exists as of version 2010 R2.
  • Workarounds include custom development, user SOPs, or impractical limit settings.
  • Check for updates in newer versions or submit an enhancement request.

For highly regulated environments or quality-critical data, manual or process-based approaches may be needed unless and until the product adds this flexibility. Always refer to the latest PI Manual Logger documentation and reach out to OSIsoft Tech Support for guidance tailored to your deployment.


Have you found effective approaches to enforce comment policies in PI Manual Logger? Share your experiences in the comments!

Tags

#OSIsoft
#Best Practices
#PI Manual Logger
#comment requirement
#data validation
#tours
#manual entry

About Roshan Soni

Expert in PI System implementation, industrial automation, and data management. Passionate about helping organizations maximize the value of their process data through innovative solutions and best practices.

Sign in to comment

Join the conversation by signing in to your account.

Comments (0)

No comments yet

Be the first to share your thoughts on this article.

Related Articles

Enhancing PI ProcessBook Trends with Banding and Zones: User Needs, Workarounds, and the Road Ahead

A look at the user demand for trend banding/zoning in OSIsoft PI ProcessBook, current VBA workarounds, UI challenges, and how future PI Vision releases aim to address these visualization needs.

Roshan Soni

Migrating PIAdvCalcFilVal Uptime Calculations from PI DataLink to PI OLEDB

Learn how to translate PI DataLink's PIAdvCalcFilVal advanced calculations—like counting uptime based on conditions—into efficient PI OLEDB SQL queries. Explore three practical approaches using PIAVG, PIINTERP, and PICOunt tables, and get tips for validation and accuracy.

Roshan Soni

Understanding PI Web API WebID Encoding: Can You Generate WebIDs Client-Side?

Curious about how PI Web API generates WebIDs and whether you can encode them client-side using GUIDs or paths? This article explores the encoding mechanisms, current documentation, and best practices for handling WebIDs in your applications.

Roshan Soni