Audit Specific Operations

• Jan 21, 2021
• 3 minutes to read

You can instruct Audit Trail Module not to log particular operations. Handle the CustomizeAuditOperationTypeFilter event, check the current operation type, and set the SaveAuditOperation argument to false. The following example shows how to exclude the ObjectChanged and ObjectCreated records from the audit log.

In a Cross-Platform Module

File: MySolution.Module\MySolutionModule.cs (MySolutionModule.vb).

C#

using DevExpress.Persistent.AuditTrail;
using static DevExpress.Persistent.AuditTrail.AuditTrailService;
// ...
public sealed partial class MySolutionModule : ModuleBase { 
    public override void Setup(XafApplication application) {
        base.Setup(application); 
        AuditTrailService.Instance.CustomizeAuditOperationTypeFilter += 
            new EventHandler<CustomAuditOperationTypeFilterEventArgs>(Instance_CustomizeAuditOperationTypeFilter);  
        //...  
    }  
    private static void Instance_CustomizeAuditOperationTypeFilter(object sender, CustomAuditOperationTypeFilterEventArgs e) {  
        if(e.AuditOperationType == AuditOperationType.ObjectChanged || 
            e.AuditOperationType == AuditOperationType.ObjectCreated) {
            e.SaveAuditOperation = false;
        }
    }
    // ...
}  

VB.NET

Imports DevExpress.Persistent.AuditTrail
Imports DevExpress.Persistent.AuditTrail.AuditTrailService
' ...
Partial Public NotInheritable Class MainDemoModule
    Inherits ModuleBase
    Public Overrides Sub Setup(ByVal application As XafApplication)
        MyBase.Setup(application)
        Dim winApplication As New MySolutionWinApplication() 
        AddHandler AuditTrailService.Instance.CustomizeAuditOperationTypeFilter,
            AddressOf Instance_CustomizeAuditOperationTypeFilter
        ' ...
    End Sub
    Private Sub Instance_CustomizeAuditOperationTypeFilter(ByVal sender As Object, 
        ByVal e As CustomAuditOperationTypeFilterEventArgs) 
        If e.AuditOperationType = AuditOperationType.ObjectChanged _
        OrElse e.AuditOperationType = AuditOperationType.ObjectCreated Then 
            e.SaveAuditOperation = False 
        End If 
    End Sub
    ' ...
End Class 

In a WinForms Application

File: Program.cs (Program.vb).

C#

using DevExpress.Persistent.AuditTrail;
using static DevExpress.Persistent.AuditTrail.AuditTrailService;
// ...
public class Program {  
    public static void Main() {  
        //...  
        MySolutionWinApplication winApplication = new MySolutionWinApplication();  
        AuditTrailService.Instance.CustomizeAuditOperationTypeFilter += 
            new EventHandler<CustomAuditOperationTypeFilterEventArgs>(Instance_CustomizeAuditOperationTypeFilter);  
        //...  
    }  
    private static void Instance_CustomizeAuditOperationTypeFilter(object sender, CustomAuditOperationTypeFilterEventArgs e) {  
        if(e.AuditOperationType == AuditOperationType.ObjectChanged || 
            e.AuditOperationType == AuditOperationType.ObjectCreated) {
            e.SaveAuditOperation = false;
        }
    }
    // ...
}  

VB.NET

Imports DevExpress.Persistent.AuditTrail
Imports DevExpress.Persistent.AuditTrail.AuditTrailService
' ...
Public Class Program 
    Public Shared Sub Main(ByVal arguments() As String)
        ' ...
        Dim winApplication As New MySolutionWinApplication() 
        AddHandler AuditTrailService.Instance.CustomizeAuditOperationTypeFilter,
            AddressOf Instance_CustomizeAuditOperationTypeFilter
        ' ...
    End Sub
    Private Sub Instance_CustomizeAuditOperationTypeFilter(ByVal sender As Object, 
        ByVal e As CustomAuditOperationTypeFilterEventArgs) 
        If e.AuditOperationType = AuditOperationType.ObjectChanged _
        OrElse e.AuditOperationType = AuditOperationType.ObjectCreated Then 
            e.SaveAuditOperation = False 
        End If 
    End Sub
    ' ...
End Class 

In an ASP.NET Application

File: Global.asax.cs (Global.asax.vb).

C#

using DevExpress.Persistent.AuditTrail;
using static DevExpress.Persistent.AuditTrail.AuditTrailService;
// ...
public class Global : System.Web.HttpApplication {
    protected void Session_Start(object sender, EventArgs e) {
        //...  
        WebApplication.SetInstance(Session, new MySolutionWebApplication());  
        AuditTrailService.Instance.CustomizeAuditOperationTypeFilter += 
            new EventHandler<CustomAuditOperationTypeFilterEventArgs>(Instance_CustomizeAuditOperationTypeFilter);  
        //...  
    }  
    private static void Instance_CustomizeAuditOperationTypeFilter(object sender, CustomAuditOperationTypeFilterEventArgs e) {  
        if(e.AuditOperationType == AuditOperationType.ObjectChanged || 
            e.AuditOperationType == AuditOperationType.ObjectCreated) {
            e.SaveAuditOperation = false;
        }
    }
    // ...
} 

VB.NET

Imports DevExpress.Persistent.AuditTrail
Imports DevExpress.Persistent.AuditTrail.AuditTrailService
' ...
Public Class [Global]
    Inherits System.Web.HttpApplication
    ' ...
    Protected Sub Session_Start(ByVal sender As Object, ByVal e As EventArgs)
        WebApplication.SetInstance(Session, New MySolutionWebApplication())
        AddHandler AuditTrailService.Instance.CustomizeAuditOperationTypeFilter, AddressOf Instance_CustomizeAuditOperationTypeFilter
        ' ...
    End Sub
    Private Sub Instance_CustomizeAuditOperationTypeFilter(ByVal sender As Object, 
        ByVal e As CustomAuditOperationTypeFilterEventArgs) 
        If e.AuditOperationType = AuditOperationType.ObjectChanged _
        OrElse e.AuditOperationType = AuditOperationType.ObjectCreated Then 
            e.SaveAuditOperation = False 
        End If 
    End Sub
    ' ...
End Class

In a Blazor Application

File: Program.cs.

C#

using DevExpress.Persistent.AuditTrail;
using static DevExpress.Persistent.AuditTrail.AuditTrailService;
// ...
public class Program {  
    public static void Main() {  
        //...    
        AuditTrailService.Instance.CustomizeAuditOperationTypeFilter += 
            new EventHandler<CustomAuditOperationTypeFilterEventArgs>(Instance_CustomizeAuditOperationTypeFilter);  
        CreateHostBuilder(args).Build().Run();
    }  
    private static void Instance_CustomizeAuditOperationTypeFilter(object sender, CustomAuditOperationTypeFilterEventArgs e) {  
        if(e.AuditOperationType == AuditOperationType.ObjectChanged || 
            e.AuditOperationType == AuditOperationType.ObjectCreated) {
            e.SaveAuditOperation = false;
        }
    }
    // ...
}