Tracker

This context lets you access and manage a single tracker.

Unique Actions [?]

This action is used to edit Tracker properties.

Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier.

Action Type:

Configure

Common Actions [?]

Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status

Context States and Icons

Icon	Code	State
	0	Tracker is enabled
	1	Tracker is disabled

Advanced Information

Context Information

Context Type: tracker

Context Name: provided by user

Context Description: provided by user

Context Path: users.USER_NAME.trackers.TRACKER_NAME

Context Mask: users.*.trackers.*

Context Permissions: Observer

Public Variables (Properties) [?]

Common Variables: groupMembership (Group Membership)

Tracker Properties

See description of the variable and its fields here.

Variable Name:	childInfo
Records:	1
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
name	String	1 - 50 characters
description	String	1 - 50 characters
expression	String
enabled	Boolean
period	Long	Measured in milliseconds

Status Table

See description of the variable and its fields here.

Variable Name:	replication
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
description	String	One or more characters.
expression	String
color	Color	Nullable.
level	Integer

Statistics Properties

Settings of tracker's statistics channel. See statistics channel properties for field descriptions.

Variable Name:	statisticsProperties
Records:	1
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
statsEnabled	Boolean
expression	String
useKeyField	Boolean
keyField	String
nullValuesProcessing	Integer
outOfRangeValuesHandling	Integer
minValue	Float
maxValue	Float
storage	Integer
type	String
average	Boolean
minimum	Boolean
maximum	Boolean
total	Boolean
minutelyStats	Long
hourlyStats	Long
dailyStats	Long
weeklyStats	Long
monthlyStats	Long
yearlyStats	Long
step	Long
sff	Float

Tracker

This variable provides access to the current tracker value. If a non-zero History Storage Time is set in the tracker settings, changes of this variable are persisted in the database and may be used for building charts etc.

Variable Name:	tracker
Records:	1
Permissions:	Readable at Observer permission level

Record Format:

Field Name	Field Type	Notes
value	String	Current value of the tracker converted to a string.

Statistics

This variable a view of tracker statistics, i.e. aggregated data collected by tracker's statistical channel.

Variable Name:	statistics
Records:	0...unlimited
Permissions:	Readable at Observer permission level

Record Format: dynamic.

Public Functions [?]

This context has no public functions.

Public Events [?]

Common Events: info (Information)

Status Change

This event is fired when tracker state has been changed.

Event Name	statusChange
Permissions:	Accessible at Observer permission level
Records:	1

Record Format:

Field Name	Field Type	Notes
value	String	String representation of current tracker value.
status	String	Description of new tracker status.