EventRetention Property

General info

Label

Retention Time

Description

The maximum age of data in the archive. A value of 0 will set it to unlimited retention.

Data type

UInt32

Default value

3650

Min value

0

Max value

36500

Type

Regular

Code

12154

Symbolic name

MODEL_PROP_EVENTRETENTION

Lua access code

syslib.model.properties.EventRetention

Available since

1.64
Parent classes

EventStreamDataStore

Parent properties

CustomEventStore

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.
PROP_UNIT The property has an engineering unit.
PROP_HAS_LOLIMIT The property has a low limit.
PROP_HAS_HILIMIT The property has a high limit.

Examples

Read from or write to the EventRetention property.

  • Lua

  • C#

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

-- Write to the EventRetention
syslib.setvalue("<OBJECT FULL PATH>.CustomEventStore.EventRetention", 3650)
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

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