BatchTrackerBackfillMode Property

General info

Label

Mode

Description

Mode of operation. Set to running in order to start the backfill operation.

Data type

UInt32

Default value

1 (syslib.model.codes.BatchTrackerBackfillMode.BFM_CONFIGURATION)

Type

CodingGroup

Code

12437

Symbolic name

MODEL_PROP_BATCHTRACKERBACKFILLMODE

Lua access code

syslib.model.properties.BatchTrackerBackfillMode

Available since

1.72
Parent classes

BatchTrackerBackfill

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.

Codings

Coding group: BatchTrackerBackfillMode

Name Code Label Tooltip

BFM_CONFIGURATION

1

Configuration

Use this setting to configure start time and end time.

BFM_RUNNING

2

Running

This setting will start the operation.

Examples

Read from or write to the BatchTrackerBackfillMode property.

  • Lua

  • C#

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

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

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

A switch-like function of the codings.

function get_coding_name(code)
    local _btbm = syslib.model.codes.BatchTrackerBackfillMode
    if _btbm.BFM_CONFIGURATION==code then return 'BFM_CONFIGURATION'
    elseif _btbm.BFM_RUNNING==code then return 'BFM_RUNNING'
    end
end
return get_coding_name(syslib.model.codes.BatchTrackerBackfillMode.BFM_CONFIGURATION)