Statistics Property

General info

Label

Statistics

Description

The object will output statistics in form of a historizing variable tree.

Data type

Boolean

Default value

true

Type

Regular

Code

4164

Symbolic name

MODEL_PROP_STATISTICS

Lua access code

syslib.model.properties.Statistics

Available since

1.40

Parent classes: BatchRecord | CloudSinkItem | DBSinkItem | HistoryController | HistorySinkItem | HistoryTransporter

Parent properties: BatchTrackerOptions | HtmTransporterConfiguration | SinkConfiguration | TransporterConfiguration

Attributes

Name	Tooltip
PROP_CONFIGURABLE	The property is configurable and can be changed with DataStudio and the various inmation APIs.
PROP_VISIBLE	The property is visible in DataStudio and can be read by the inmation APIs.
PROP_HAS_DEFAULT	The property has a default value as standard.

Examples

Read from or write to the Statistics property.

Lua
C#

-- Read from the Statistics
syslib.getvalue("<OBJECT FULL PATH>.HtmTransporterConfiguration.Statistics")

-- Write to the Statistics
syslib.setvalue("<OBJECT FULL PATH>.HtmTransporterConfiguration.Statistics", true)

TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the Statistics
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.HtmTransporterConfiguration.Statistics"));
// Write to the Statistics
Result result = sli.WriteValue(sc, new WriteItem(true, "<OBJECT FULL PATH>.HtmTransporterConfiguration.Statistics"));