AuditTrailStrategy Property

General info

Label

Audit Trail Strategy

Description

Types of actions that will be audited.

Data type

UInt64

Default value

0

Type

FlagGroup

Code

13123

Symbolic name

MODEL_PROP_AUDITTRAILSTRATEGY

Lua access code

syslib.model.properties.AuditTrailStrategy

Available since

1.84

Parent properties: GeneralAuditTrail

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: AuditTrailTypes

Name	Label	Tooltip
CONFIG_CHANGE	Config Change	Changes of the configuration of objects.
EXT_WRITE	External Write	Write to an external item.
DATASTORE_PURGE	Datastore Purge	Automatic deletion of content in MongoDB datastores by the system.
CONNECTION	Connection	Attempts to create/close communication channels between Core and other inmation components will be audited.
COMPONENT_LAUNCH	Component Launch	Launch/shutdown of an inmation component.
COMPONENT_UPDATE	Component Update	Update of an inmation component.
FILE_TRANSFER	File Transfer	File transfer between components.

Name

Label

Tooltip

CONFIG_CHANGE

Config Change

Changes of the configuration of objects.

EXT_WRITE

External Write

Write to an external item.

DATASTORE_PURGE

Datastore Purge

Automatic deletion of content in MongoDB datastores by the system.

CONNECTION

Connection

Attempts to create/close communication channels between Core and other inmation components will be audited.

COMPONENT_LAUNCH

Component Launch

Launch/shutdown of an inmation component.

COMPONENT_UPDATE

Component Update

Update of an inmation component.

FILE_TRANSFER

File Transfer

File transfer between components.

Examples

Read from or write to the AuditTrailStrategy property.

Lua
C#

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

-- Write to the AuditTrailStrategy
syslib.setvalue("<OBJECT FULL PATH>.GeneralAuditTrail.AuditTrailStrategy",
    syslib.model.flags.AuditTrailTypes.CONFIG_CHANGE)

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

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

A switch-like function of the flags.

function get_flag_name(mask)
    local _att = syslib.model.flags.AuditTrailTypes
    if mask & _att.CONFIG_CHANGE == _att.CONFIG_CHANGE then return 'CONFIG_CHANGE'
    elseif mask & _att.EXT_WRITE == _att.EXT_WRITE then return 'EXT_WRITE'
    elseif mask & _att.DATASTORE_PURGE == _att.DATASTORE_PURGE then return 'DATASTORE_PURGE'
    elseif mask & _att.CONNECTION == _att.CONNECTION then return 'CONNECTION'
    elseif mask & _att.COMPONENT_LAUNCH == _att.COMPONENT_LAUNCH then return 'COMPONENT_LAUNCH'
    elseif mask & _att.COMPONENT_UPDATE == _att.COMPONENT_UPDATE then return 'COMPONENT_UPDATE'
    elseif mask & _att.FILE_TRANSFER == _att.FILE_TRANSFER then return 'FILE_TRANSFER'
    end
end
return get_flag_name(syslib.model.flags.AuditTrailTypes.CONFIG_CHANGE)