SafRetentionDays Property

General info

Label

Retention Time

Description

Retain Store and Forward data in the database for the specified amount of days, after it finally gets deleted.

Data type

Int32

Default value

100

Min value

1

Type

Regular

Code

681

Symbolic name

MODEL_PROP_SAFRETENTIONDAYS

Lua access code

syslib.model.properties.SafRetentionDays

Available since

1.0

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.

Examples

Read from or write to the SafRetentionDays property.

  • Lua

  • C#

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

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

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