BatchEventFilter Property

General info

Label

Event Filter

Description

Configure how events are filtered prior to consideration in the BPR.

Data type

UInt64

Default value

1 (syslib.model.flags.BatchEventFilter.TIMESTAMP)

Type

FlagGroup

Code

12981

Symbolic name

MODEL_PROP_BATCHEVENTFILTER

Lua access code

syslib.model.properties.BatchEventFilter

Available since

1.80

Parent properties: BatchEventGroups

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.

Flags

Flag group: BatchEventFilter

Name	Label	Tooltip
TIMESTAMP	Timestamp Filter	Include Events which occured between start and end of the Batch, Operation, Phase or Step.
IPCEVENT	IPC Events	Only include IPC Events.
CUSTOMWILDCARDS	Custom Filter Wildcards	Allow the use of wildcard in the custom filter.

Name

Label

Tooltip

TIMESTAMP

Timestamp Filter

Include Events which occured between start and end of the Batch, Operation, Phase or Step.

IPCEVENT

IPC Events

Only include IPC Events.

CUSTOMWILDCARDS

Custom Filter Wildcards

Allow the use of wildcard in the custom filter.

Examples

Read from or write to the BatchEventFilter property.

Lua
C#

-- Read from the BatchEventFilter
syslib.getvalue("<OBJECT FULL PATH>.BatchData.BatchEventGroups.BatchEventFilter")

-- Write to the BatchEventFilter
syslib.setvalue("<OBJECT FULL PATH>.BatchData.BatchEventGroups.BatchEventFilter",
    syslib.model.flags.BatchEventFilter.TIMESTAMP)

TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

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

A switch-like function of the flags.

function get_flag_name(mask)
    local _bef = syslib.model.flags.BatchEventFilter
    if mask & _bef.TIMESTAMP == _bef.TIMESTAMP then return 'TIMESTAMP'
    elseif mask & _bef.IPCEVENT == _bef.IPCEVENT then return 'IPCEVENT'
    elseif mask & _bef.CUSTOMWILDCARDS == _bef.CUSTOMWILDCARDS then return 'CUSTOMWILDCARDS'
    end
end
return get_flag_name(syslib.model.flags.BatchEventFilter.TIMESTAMP)