CustomTimeSeriesRetention Property

General info

Label

Retention Period

Description

The retention period for the particular custom data store, a value of <null> will set it to unlimited retention.

Data type

Int32

Default value

3650

Min value

1

Max value

36500

Type

Regular

Code

12065

Symbolic name

MODEL_PROP_CUSTOMTIMESERIESRETENTION

Lua access code

syslib.model.properties.CustomTimeSeriesRetention

Available since

1.62

Parent properties: CustomTimeSeriesStore | CustomTimeSeriesStore2

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.
PROP_NULLABLE	This Property can have no value.

Examples

Read from or write to the CustomTimeSeriesRetention property.

Lua
C#

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

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