Skip to main content
All docs
V23.2
.NET 6.0+

AuditTrailServiceBase Members

The base service that the Audit Trail Module uses to monitor object changes and log this information. In .NET Framework applications, you can use the static Instance property to access this service and customize its behavior. In .NET 6+ applications, use Dependency Injection to access this service.

Methods

Name Description
AddCustomAuditData(Session, AuditDataItem)
BeginObjectsAudit(Session, ObjectAuditingMode, Object[]) Starts auditing the specified objects according to auditingMode.
BeginObjectsAudit(Session, Object[]) Starts auditing the specified objects in Full object auditing mode.
BeginSessionAudit(Session, AuditTrailStrategy, ObjectAuditingMode) Starts auditing object changes made within the specified session.
BeginSessionAudit(Session, AuditTrailStrategy) Starts auditing object changes made within the specified session.
Dispose()
EndSessionAudit(Session) Stops auditing object changes made within the specified session.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetStrategy(Session) Gets the audit strategy for the specified session.
GetType() Gets the Type of the current instance. Inherited from Object.
IsSessionAudited(Session) Indicates whether the Audit Trail Module audits object changes within the specified session.
ListenToObjectSpace(XPObjectSpace)
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
SaveAuditData(Session) Saves AuditDataItem objects to the database. Call this method when you add custom audit data to the log.
SetXPDictionaries(IList<XPDictionary>)
SetXPDictionary(XPDictionary)
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
CustomCreateObjectAuditProcessorsFactory
CustomizeAuditOperationTypeFilter Occurs after a business object is changed and before the corresponding AuditDataItem object is saved.
CustomizeAuditTrailSettings This event is raised when an application’s setup is complete. Handle this event to use the default settings for the Audit Trail Module.
CustomizeSessionAuditingOptions For internal use.
QueryCurrentUserName Occurs before AuditDataItem objects are saved. Handle this event to get the current user name in applications that do not use the Security System.
SaveAuditTrailData Occurs before new AuditDataItem objects are saved to the database. Handle this event to configure how the Audit Trail Module saves information.
See Also