| | Name | Description |
|---|
 | AdministratorSecurityGroup |
A security group name controlling tag configuration changes.
|
| ArchiveAbsoluteDeadband |
The absolute archive compression deadband value in effect with ArchiveAbsoluteDeadbanding=true.
|
| ArchiveAbsoluteDeadbanding |
Indicates whether archive-compression deadband is expressed as an absolute value (true)
or percent of engineering units (false).
|
| ArchiveCompression |
Whether to perform archive-compression on the tag's data stream. With archive compression enabled,
data samples within the archive-compression deadband are not recorded in archives. Archive-compression
is typically used to reduce data storage requirements in a Historian server.
|
| ArchiveCompressionTimeout |
With ArchiveCompression=true, the amount of time in milliseconds after which a data
sample will be recorded in an archive regardless of archive compression.
|
| ArchiveDeadbandPercentRange |
The archive-compression deadband expressed as a percent of the engineering units range.
|
| CalcType |
Specifies the calctype of the tag, it can be analytic or a raw tag.
|
| Calculation |
The calculation formula for tags bound to a Calculation collector. Internally this is mapped to the SourceAddress property.
|
| CalculationDependencies |
For a calculation tag, the list of tag names affecting this tag's value.
|
| CollectionDisabled |
Whether data collection for a tag is currently suspended.
|
| CollectionInterval |
A millisecond interval determining tag data collection. For DataCollectionType.Polled,
schedules periodic samples of data from a data source. For DataCollectionType.Unsolicited,
establishes the minimum time allowed in-between reports of values from a data source.
|
| CollectionOffset |
For DataCollectionType.Polled data collection, the number of milliseconds
from midnight to delay collection of the first data sample. Subsequent samples are then collected
at CollectionInterval intervals from the offset.
|
| CollectionType |
Determines how data is acquired from a data source. With DataCollectionType.Unsolicited collection,
new values are reported by the source on value change. Whereas with DataCollectionTypes.Polled collection,
new values are periodically sampled from the source.
|
| CollectorAbsoluteDeadband |
The absolute collector compression deadband value in effect with CollectorAbsoluteDeadbanding=true.
|
| CollectorAbsoluteDeadbanding |
Indicates whether collector-compression deadband is expressed as an absolute value (true)
or percent of engineering units (false).
|
| CollectorCompression |
Whether to perform collector compression on a tag's data stream. With collector compression enabled,
data samples within the collector-compression deadband are not forwarded by the collector. Collector
compression is typically used to limit redundant network traffic between Historian collectors and
server.
|
| CollectorCompressionTimeout |
With CollectorCompression=true, the amount of time in milliseconds after which a data
sample will be forwared by a collector regardless of collector compression.
|
| CollectorDeadbandPercentRange |
The collector-compression deadband expressed as a percent of the engineering units range.
|
| CollectorName |
A collector name of the collector responsible for furnishing a tag's data values.
|
| CollectorType |
The type of collector responsible for supplying tag data.
|
| Comment |
An optional tag comment.
|
| ConditionCollectionCompareValue |
A constant value to compare against the trigger tag's value with condition-based collection enabled.
|
| ConditionCollectionComparison |
A comparison operator for evaluating the trigger tag's value with condition-based collection enabled.
|
| ConditionCollectionEnabled |
Whether condition-based collection is active. Condition-based collection makes data collection for a tag
contingent on the current value of a separate trigger tag.
|
| ConditionCollectionMarkers |
Whether to insert end-of-collection, bad quality samples to indicate a tag stopped collecting due
due to condition-based collection.
|
| ConditionCollectionTriggerTag |
A trigger tag to monitor with condition-based collection enabled. A trigger tag's value is
evaluated to determine whether dependent tags should be collected.
|
| DataDensity |
|
| DataStoreName |
Name of the DataStore this tag belongs to
|
| DataType | A data type determining the types of values stored by this tag. Valid data types are defined in Tag.NativeDataType. |
| Description |
An optional tag description.
|
| EngineeringUnits |
An optional description of a tag's engineering units.
|
| EnumeratedSetName |
Name of the Enumerated Set used by this tag
|
| FixedStringLength | A string length for Tag.NativeDataType.FixedString data type. |
| General1 |
The first generic configuration field - purpose is determined by parent collector.
|
| General2 |
The second generic configuration field - purpose is determined by parent collector.
|
| General3 |
The third generic configuration field - purpose is determined by parent collector.
|
| General4 |
The fourth generic configuration field - purpose is determined by parent collector.
|
| General5 |
The fifth generic configuration field - purpose is determined by parent collector.
|
| HiEngineeringUnits |
The high engineering unit range of tag data. Along with LoEngineeringUnits, used
to determine deadband.
|
| HiScale |
The upper range of incoming raw tag values.
|
| Id |
A globally unique tag identifier.
|
| InputScaling |
Whether input scaling is applied to a tag's incoming data samples. With
InputScaling=true, raw values in the range of LoScale to HiScale are
converted to values in the range of LogEngineeringUnits to HiEngineeringUnits.
Any input values outside the LoScale to HiScale range are logged with
bad quality and ScaledOutOfRange sub-quality.
|
| IsStale |
|
| LastModified |
A time when a tag's configuration was last modified.
|
| LastModifiedUser |
A name of a user who last modified this tag's configuration.
|
| LoadBalancing |
Whether to evenly distribute data collection over available sample times for
DataCollectionType.Polled collection.
|
| LoEngineeringUnits |
The low engineering unit range of tag data. Along with HiEngineeringUnits, used
to determine deadband.
|
| LoScale |
The lower range of incoming raw tag values.
|
| Name |
A user configurable tag name. Tag names are unique within a single Historian server.
|
| NumberOfElements |
The number of elements in the array if the tag is of type array.
|
| ReadSecurityGroup |
A security group name controlling reading of tag data.
|
| SourceAddress |
A data source-specific identifier determining the location of tag data in a data source.
|
| SpikeLogic |
Controls the application of spike detection logic during data collection. For tags configured for
collector compression, enabling SpikeLogic causes the data sample immediately before a large deviation
from the deadband to be recorded. This more faithfully represents a sudden signal spike as opposed
to a gradual rise over time.
|
| SpikeLogicOverride |
Whether to use a parent collector's spike logic setting (false) or a tag's own setting (true).
|
| StepValue |
Indicates whether a tag's recorded data signal is smoothly changing (false) or composed of discrete "steps" (true).
This property only affects interpolated data retrieval not data collection or storage.
|
| TimeResolution |
The timestamp resolution for data sample storage.
|
| TimeStampType |
Determines the source of data samples times during data collection.
TimeStampDeterminedByType.Source applies time stamps directly from data source.
While TimeStampDeterminedByType.Collector applies time stamps by the collector based on the host PC clock.
|
| UserDefinedTypeName |
The name of the user defined type that this tag is asociated to. This applies only when the type of the tag is a MultiField Type.
|
| UTCBias |
The timezone bias in minutes for tag data samples as an offset from UTC.
|
| WriteSecurityGroup |
A security group name controlling writing of tag data.
|
