report

report — requests notification of changes to a data point.

Synopsis

(report name)
    

Arguments

name

The name of a data point.

Returns

A message each time any of the following occurs:

  • The point value changes.

  • The point quality changes.

  • The point timestamp changes and the General property option Do not transmit insignificant changes is unchecked.

  • A value is written to the point by force, such as with the force or cforce command, or by using the set_canonical command with the force option set.

The message contains a complete definition of the point, according to this syntax:

(point name type value [conf security locked seconds nanoseconds 
 flags quality])

where:

name

The name of the point.

type

The data type of the point, one of integer, floating point, or character string, where:.

  • 0 indicates string.

  • 1 indicates floating point.

  • 2 indicates integer.

value

The value of the point.

conf

The confidence level of the point, 0 - 100 percent. This is unused by most applications.

security

The security level of the point, 0 to 32768, where higher numbers represent higher security. This is unused by most applications.

locked

1 for locked, or 0 for unlocked. This is unused by most applications.

seconds

The seconds portion of the point’s timestamp.

nanoseconds

The nanoseconds portion of the point’s timestamp, as an integer.

flags

System-defined flags, for internal use.

quality

A integer constant representing the quality of the point value, such as Good, Bad, Last known, Local override, etc. The possible values are shown in the quality command reference page.

Description

This command requests the DataHub instance to report changes (also called exceptions) to the value or quality of a point, as soon as a change takes place. See also creport.