Using Audit Profiles

Using Auditing

Audit Profiles cause Ignition to record details about specific events that occurred. Audit Profiles are simple to set-up, and immediately start to record events. By default, only tag writes, SQL UPDATE, SQL INSERT, and SQL DELETE statements are recorded. This allows you to keep track of which user wrote to which tag, or modified which table. Furthermore, a time-stamp is recorded, so you can easily track the changes and outline and order of events.

To create an audit log

  1. Go to the Configure section of the Gateway.

  2. Choose Security > Auditing from the menu on the left.

  3. The Audit Profiles page is displayed.

  4. Click the Create a new Audit Profile link.

  5. Select Database and click Next.

  6. Enter the Name of the audit log and the Retention time.

  7. Under the Database Settings, select the Database where the table will be stored, select the Auto Create check box, and enter the desired Table Name.

  8. Click Create New Audit Profile.

Once some changes have been made to a tag or a database table, Ignition will begin recording.

images/download/attachments/6035100/audit_events_table.PNG

Auditing Project Events

Project can be assigned to an Audit Profile. Once configured, Ignition will track changes made to the designer, as well as keep track of when users logged in or logged out of a client. Additionally, the hostname of the computer used will be recorded.

To assign an Audit Profile to a project

  1. Go to the Designer, open the project that you want to enable auditing on, and go to Project > Properties.

  2. Go to the General section, select the Enable Auditing check box, and select the Audit Profile from the drop-down menu. If the new audit profile does not show up, click Refresh.

  3. Click OK.

  4. Save your Project.

images/download/attachments/6035100/audit_events_table_project.PNG

Audit Table Definition

The following table describes the audit table as it exist in the database:

Column Name
Description

AUDIT_EVENTS_ID

The id of the row.

ACTION

Brief description of the action.

ACTION_TARGET

The target of the action.

ACTION_VALUE

The value acted upon the action target.

ACTOR

The logged in user when the action occurred or a description of the system that generated the action.

ACTOR_HOST

The host computer where the action occurred.

EVENT_TIMESTAMP

The time when the action occurred.

ORIGINATING_CONTEXT

A numerical description of the origin of the originating system. gateway = 1, designer = 2, client = 4

ORIGINATING_SYSTEM

The name of the project or system where this action occurred.

STATUS_CODE

The OPC quality code where 192 signifies success. 0 signifies bad or failure.

Custom Auditing

The Audit Table is simply a database table, so custom events can be logged to the table. This is commonly done through scripting events. In most cases, users will log certain button presses and event values by adding just several lines of code.

In This Section ...