TimeSeriesPurgeWhenIdle Property

General info

Label

Purge When Idle

Description

Inhibits purging when time-series data are being persisted.

Data type

Boolean

Default value

true

Type

Regular

Code

1134

Symbolic name

MODEL_PROP_TIMESERIESPURGEWHENIDLE

Lua access code

syslib.model.properties.TimeSeriesPurgeWhenIdle

Available since

1.0
Parent properties

TimeSeriesStoreTest

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

  • Lua

  • C#

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

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