Word Data Tag

Introduction

The Word Data Tag Word tag icon represents a 16-bit unsigned integer data tag with a range of 0 to 65535.

Configuration Properties

The Word Data Tag supports the configuration properties of the Data Point Tag plus these properties:

Property Type Version Description
NormalColor STRING 3.1 The value of the Color property when the tag is normal quality.
HistoricEnable BOOL 2.5 Whether the value of the tag is stored historically.
HistoricSignificantChange UINT 2.5 The amount the historic tag must change before a new value is stored historically.
HistoricSampleInterval TIME 2.5 The maximum interval between consecutive values recorded in the history.
HistoricSampleCount UDINT 2.5 The number of sample values to retain in the historian.

Dynamic Properties

The Word Data Tag supports the dynamic properties of the Data Point Tag plus these properties:

Property Type Description
Value UINT The current value of the tag
Color DWORD Indicates the state of the tag using color
IsForced BOOL Indicates whether the tag has been forced (true), or not forced (false)
UnforcedValue UINT The current value of the tag when this tag has been forced to a fixed value
UnforcedQuality INT The quality of the current value when this tag has been forced to a fixed value
UnforcedTimestamp DATE_AND_TIME The timestamp of the last update when this tag has been forced to a fixed value
UnforcedColor DWORD The color of the tag when this tag has been forced to a fixed value

Color Property

The Color property provides an indication of the state of the tag using color:

Tag StateConditionColor Value
The tag is forced IsForced = True The ForcedColor defined in the Database Root Tag
The quality is bad Quality < 192 The BadQualityColor defined in the Database Root Tag
Otherwise The NormalColor defined above.

TagErrorCode Property

When the Quality of the tag data is 'Bad', the TagErrorCode property indicates the reason for the error:

ErrorCodeDescription
0No error.
1The tag is not associated with a valid data source.
2The data source reference is valid, but the data source has a configuration error.
3The offset of the tag is outside the boundary of the data source.
4The data type is String, but the source value is not a valid word.
5There was an error converting the data.

Tag Commands

A tag command is an action you can trigger on a tag. The Word Data Tag supports these tag commands:

Tag Command Version Description
ForceValue 1.2 Overrides the tag to show a fixed constant value. If the tag value is from a data source, updates from the data source are placed in a set-aside area. Note: The override is applied to the tag in the Fernhill SCADA database, and not to the data source.
RemoveForce 1.2 Removes any override currently active on the the tag. The actual value from the data source is restored from the set-aside area. If there is no override currently active, RemoveForce has no effect.

Relationships to Other Tag Types

The Word Data Tag builds on the features of these tag types:

The Word Data Tag is used as a building block for these tag types:

Further Information

Core Tag

To learn about properties common to all tags.

Data Point Tag

To learn about other types of data tag.

Glossary

For the meaning of terms used in Fernhill SCADA.