Skip to main content
Version: 3.10.0

Audit

This file explains how to activate/deactivate the audit feature (users' modifications tracing) and how to customize it.

Prerequisite​

Knowledge to have:​

The audit feature is actively using the Audit.NET library

Overview​

The audit feature, by default, stores the modifications (and the user who has done these modifications) done on entity objects in a dedicated Events table of the default database.

Activation/Deactivation​

  • to activate/deactivate the feature modify the "IsActive" property in the following part of the bianetconfig file:
  "AuditConfiguration": {
    "IsActive": true,
    "ConnectionStringName": "ProjectDatabase"      
  }

Configuration and Customizing:​

  • In the Domain project the entities class to be audited shall be tag by
    /// <summary>
    /// The user entity.
    /// </summary>
    [AuditInclude]
    public class User : VersionedTable, IEntity<int>
  • If you want to ignore change on a field you can use before the filed the tag [AuditIgnore]

        /// <summary>
        /// Gets or sets the last login date.
        /// </summary>
        [AuditIgnore]
        public DateTime? LastLoginDate { get; set; }
  • By default all audited table change are log in the table "AuditLog"
  • Except User that is log in UserAudit table

The usage of a dedicated table simplify the history of change in a user interface. If you need it for other tables :

  • To add your custom Audit table that inherit of AuditEntity and with all the field you want to log. Ex :
    /// <summary>
    /// The user entity.
    /// </summary>
    public class UserAudit : AuditEntity, IEntity<int>
    {
        /// <summary>
        /// Gets or sets the id.
        /// </summary>
        public int AuditId { get; set; }

        /// <summary>
        /// Gets or sets the id.
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// Gets or sets the first name.
        /// </summary>
        public string FirstName { get; set; }

        /// <summary>
        /// Gets or sets the last name.
        /// </summary>
        public string LastName { get; set; }

        /// <summary>
        /// Gets or sets the login.
        /// </summary>
        public string Login { get; set; }

        /// <summary>
        /// Gets or sets the domain.
        /// </summary>
        public string Domain { get; set; }
    }
  • customize the ..Infrastructure.Data/Features/AuditFeature to map the entity with the custom audit table. change the code in "AuditTypeMapper"
        .AuditTypeMapper(type => AuditTypeMapper(type))

...

        private static Type AuditTypeMapper(Type type)
        {
            switch (type.Name)
            {
                case "User":
                    return typeof(UserAudit);
                case "MyEntity":
                    return typeof(MyEntityAudit);
                default:
                    return typeof(AuditLog);
            }
        }