SkipHistory Property

General info

Label

Skip History

Description

If this Option is set no historical data will be transmitted to the sink. Only near time, up-to-date values will be streamed.

Data type

Boolean

Default value

false

Type

Regular

Code

5205

Symbolic name

MODEL_PROP_SKIPHISTORY

Lua access code

syslib.model.properties.SkipHistory

Available since

1.44
Parent classes

HistoryController

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 SkipHistory property.

  • Lua

  • C#

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

-- Write to the SkipHistory
syslib.setvalue("<OBJECT FULL PATH>.SkipHistory", 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 SkipHistory
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.SkipHistory"));
// Write to the SkipHistory
Result result = sli.WriteValue(sc, new WriteItem(true, "<OBJECT FULL PATH>.SkipHistory"));