User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Queries an audit profile for audit history. Returns the results as a dataset.

A description of the returned dataset can be found on the Ignition Database Table Reference page. 

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.util.queryAuditLog(auditProfileName, [startDate], [endDate], [actorFilter], [actionFilter], [targetFilter], [valueFilter], [systemFilter], [contextFilter])

  • Parameters

String auditProfileName - The name of the audit profile to pull the history from. 

Date startDate - The earliest audit event to return. If omitted, the current time - 8 hours will be used. [optional]

Date endDate - The latest audit event to return. If omitted, the current time will be used. [optional]

String actorFilter - A filter string used to restrict the results by actor. [optional]

String actionFilter - A filter string used to restrict the results by action. [optional]

String targetFilter - A filter string used to restrict the results by target. [optional]

String valueFilter - A filter string used to restrict the results by value. [optional]

String systemFilter - A filter string used to restrict the results by system. [optional]

Integer contextFilter - A bitmask used to restrict the results by context. 0x01 = Gateway, 0x02 = Designer, 0x04 = Client. [optional]

  • Returns

Dataset - A dataset with the audit events from the specified profile that match the filter arguments.

  • Scope

    Gateway


Syntax

system.util.queryAuditLog([auditProfileName], [startDate], [endDate], [actorFilter], [actionFilter], [targetFilter], [valueFilter], [systemFilter], [contextFilter])

  • Parameters

String auditProfileName - The name of the audit profile to pull the history from. [optional] (Note that the project must have an Audit Profile configured in Project Properties. Otherwise this parameter is mandatory)

Date startDate - The earliest audit event to return. If omitted, the current time - 8 hours will be used. [optional]

Date endDate - The latest audit event to return. If omitted, the current time will be used. [optional]

String actorFilter - A filter string used to restrict the results by actor. [optional]

String actionFilter - A filter string used to restrict the results by action. [optional]

String targetFilter - A filter string used to restrict the results by target. [optional]

String valueFilter - A filter string used to restrict the results by value. [optional]

String systemFilter - A filter string used to restrict the results by system. [optional]

Integer contextFilter - A bitmask used to restrict the results by context. 0x01 = Gateway, 0x02 = Designer, 0x04 = Client. [optional]

  • Returns

Dataset - A dataset with the audit events from the specified profile that match the filter arguments.

  • Scope

    Perspective Session, Vision Client


Code Examples
# This script queries an audit log, checks to see if a user john made any tag writes in the last 8 hours
# (since the startDate parameter is omitted), and writes the results to a table.
data = system.util.queryAuditLog(auditProfileName='AuditLog', actorFilter='john', actionFilter='tag write')
 
event.source.parent.getComponent("Table").data = data
Keywords

system util queryAuditLog, util.queryAuditLog