Audit Event API

The AdapTable Audit Log enables Audit information to be published to 4 different Audit Destinations.

One Audit Destination is Event - set via Audit Options.

The Audit Event API is used to subscribe to these event Audit events.

Subscribing to Audit Events

Subscription to Audit Events is the same as for all Adaptable Events which use the standard FDC3 Context Data Specification.

Consequently, in order to access the audit data, you will need to drill down to the auditLogEventArgs.data[0].id property (see Adaptable Events Overview for full details).

const auditLogEntry: AuditLogEntry = auditLogEventArgs.data[0].id
tip

As an alternative you can use the getAuditLogEntryFromEventArgs utility function (used below)

The way to listen to the Audit Event is as follows:

adaptableApi.auditEventApi.on('AuditCellEdited', eventArgs => {
// listen to audit event as required
const entry: AuditLogEntry = api.auditEventApi.getAuditLogEntryFromEventArgs(eventArgs);
const details: DataChangedDetails = entry.data_change_details;
}
);

Audit Events

AdapTable publishes 4 Audit Events that users can subscribe to as needed.

tip

These Audit Events closely match the availble Audit Triggers

Audit EventWhen Fired
AuditStateChangedThe Internal or User state of the Application has changed
AuditFunctionAppliedAn AdapTable Function has been run
AuditCellEditedA cell in the grid has been edited by the user
AuditTickingDataUpdatedData in the grid changes as result of external action
important

These events are only fired if the Audit Log has been configured with the property auditAsEvent set to true in Audit Options.

AuditStateChanged

This is fired when the Audit Log trigger for the Audit Event is either User State Change or Internal State Change, i.e. when either the Internal or User state sections of AdapTable have chagned.

note

Given there can be many changes in AdapTable this can be very verbose

AuditFunctionApplied

This is fired when the Audit Log trigger for the Audit Event is Function Applied.

AuditCellEdited

This is fired when the Audit Log trigger for the Audit Event is Cell Edit, caused by the end-user making a direct edit in AdapTable.

AuditTickingDataUpdated

This is fired when the Audit Log trigger for the Audit Event is Ticking Data Edit, caused by the data in AdapTable ticking or changing other than as a result of direct user edit.

More Information