Click here to Skip to main content
12,627,377 members (44,723 online)
Click here to Skip to main content
Add your own
alternative version

Stats

377.9K views
4.5K downloads
112 bookmarked
Posted

Implementing Audit Trail using Entity Framework Part -1

, 27 Mar 2009 CPOL
Rate this:
Please Sign up or sign in to vote.
Implementing Audit Trail using Entity Framework's caching entries

Introduction

Entity framework keeps track for those entire objects and relationships which have been deleted, added and modified in the container. EF keeps the state of the object and holds the necessary change-information and all these track information for each object or relationship resides as “objectStateEntry”. Using “ObjectStateManager” one can access all these change-information like object-state (added/modified/deleted), modified properties, original and current values and can easily do audit trail for those objects. To get the Rollback feature from that audit trail we have to consider some issues. We have to maintain the order of entity graph while insertion and deletion. That means root entity has been inserted before the children and during deletion we have to make it reverse. The most important issue is that we have to make sure that audit trail entry will be inserted according this order.

So now I am going to talk about audit trail implementation that’s capable to rollback to a certain period. To make such implementation I am going to use the Entity framework’s caching Management that is called as “ObjectStateManager”.Using this Manager I will be capable to find out the object that is currently changed or added or deleted and resides in EF cache as Object state entry. In part 1, I just going to talk about creating audit trail objects using the object state entry. In Second Part I will talk about roll back feature of this audit trial.

Using the Code

First I make table audit trail in database

DataBaseDbAudit.JPG

For this table, I am going to make an Entity set in my conceptual level as

dbAuditEF.JPG

In Entity Framework, to save my all changes into Db we have call “Context.SaveChanges()” and This Context is a container that has been inherited from “ObjectContext” Class.To create the Audit trail Objects for each “Modified/Added/Deleted”I am going to catch the event-

Context.SavingChanges +=new EventHandler(Context_SavingChanges);

In sample program I have done it with writing partial class -

public partial class AdventureWorksEntities
{ partial void OnContextCreated()
{
    this.SavingChanges += new EventHandler(AdventureWorksEntities_SavingChanges);
}

void AdventureWorksEntities_SavingChanges(object sender, EventArgs e)
{

So in my “AdventureWorksEntities_SavingChanges” method I am going to create all “dbaudit” objects those are going to save in DB.Here its takes each entry from EF cache of state- Added or Deleted or Modified and call a factory method to produce audit trail object.

public partial class AdventureWorksEntities
{
    public string UserName { get; set; }
    List<DBAudit> auditTrailList = new List<DBAudit>();

    public enum AuditActions
    {
        I,
        U,
        D
    }

    partial void OnContextCreated()
    {
        this.SavingChanges += new EventHandler(AdventureWorksEntities_SavingChanges);
    }

    void AdventureWorksEntities_SavingChanges(object sender, EventArgs e)
    {
        IEnumerable<ObjectStateEntry> changes = 
            this.ObjectStateManager.GetObjectStateEntries(
            EntityState.Added | EntityState.Deleted | EntityState.Modified);
        foreach (ObjectStateEntry stateEntryEntity in changes)
        {
            if (!stateEntryEntity.IsRelationship &&
            stateEntryEntity.Entity != null &&
            !(stateEntryEntity.Entity is DBAudit))
            {//is a normal entry, not a relationship
                DBAudit audit = this.AuditTrailFactory(stateEntryEntity, UserName);
                auditTrailList.Add(audit);
            }
        }

        if (auditTrailList.Count > 0)
        {
            foreach (var audit in auditTrailList)
            {//add all audits 
                this.AddToDBAudit(audit);
            }
        }
    }

And here “AuditTrailFactory” is Factory method to create dbaudit object.Specially for Modify state it keeps the modified properties and serialized as XML.So using these field you can easily show the changes of modified object with doing any comparison of old and new data.

private DBAudit AuditTrailFactory(ObjectStateEntry entry, string UserName)
{
    DBAudit audit = new DBAudit();
    audit.AuditId = Guid.NewGuid().ToString();
    audit.RevisionStamp = DateTime.Now;
    audit.TableName = entry.EntitySet.Name;
    audit.UserName = UserName;

    if (entry.State == EntityState.Added)
    {//entry is Added 
        audit.NewData = GetEntryValueInString(entry, false);
        audit.Actions = AuditActions.I.ToString();
    }
    else if (entry.State == EntityState.Deleted)
    {//entry in deleted
        audit.OldData = GetEntryValueInString(entry, true);
        audit.Actions = AuditActions.D.ToString();
    }
    else
    {//entry is modified
        audit.OldData = GetEntryValueInString(entry, true);
        audit.NewData = GetEntryValueInString(entry, false);
        audit.Actions = AuditActions.U.ToString();

        IEnumerable<string> modifiedProperties = entry.GetModifiedProperties();
        //assing collection of mismatched Columns name as serialized string 
        audit.ChangedColumns = XMLSerializationHelper.XmlSerialize(
            modifiedProperties.ToArray());
    }

    return audit;
}

Here “GetEntryValueInString” is for creating XML text of Previous or modified object. In Entity Framework each entry hold all change defination.First I make a clone the current object.Using entry.GetModifiedProperties() I can get only modified properties of an object and Using “OriginalValues” and “CurrentValues” I can build myself the old data and new data.Factory has told me what that wants – old or new. At the End I have done XML serialized and return back XML string .

private string GetEntryValueInString(ObjectStateEntry entry, bool isOrginal)
{
    if (entry.Entity is EntityObject)
    {
        object target = CloneEntity((EntityObject)entry.Entity);
        foreach (string propName in entry.GetModifiedProperties())
        {
            object setterValue = null;
            if (isOrginal)
            {
                //Get orginal value 
                setterValue = entry.OriginalValues[propName];
            }
            else
            {
                //Get orginal value 
                setterValue = entry.CurrentValues[propName];
            }
            //Find property to update 
            PropertyInfo propInfo = target.GetType().GetProperty(propName);
            //update property with orgibal value 
            if (setterValue == DBNull.Value)
            {//
                setterValue = null;
            }
            propInfo.SetValue(target, setterValue, null);
        }//end foreach

        XmlSerializer formatter = new XmlSerializer(target.GetType());
        XDocument document = new XDocument();

        using (XmlWriter xmlWriter = document.CreateWriter())
        {
            formatter.Serialize(xmlWriter, target);
        }
        return document.Root.ToString();
    }
    return null;
}

To clone the entity I have used the method which I have found in MSDN forum Post (Thanx toPatrick Magee )-

public EntityObject CloneEntity(EntityObject obj)
{
    DataContractSerializer dcSer = new DataContractSerializer(obj.GetType());
    MemoryStream memoryStream = new MemoryStream();

    dcSer.WriteObject(memoryStream, obj);
    memoryStream.Position = 0;

    EntityObject newObject = (EntityObject)dcSer.ReadObject(memoryStream);
    return newObject;
}

That is all for Part-1 where I just create the Audit trail objects for each CUD operation.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Morshed Anwar
Team Leader PracticePRO Software Systems Inc
United States United States
"In my childhood, my uncle has shown me how to see the cloud in a close look and I understand that one can draw some elements of the Earth in the sky-canvas if he/she wants to. After that the cloud becomes closer to me and It teaches me one thing that, a deeper-look to something will give you some clues to draw your imagination. You can able to see that one which you have build-up in your mind.

Years past, I have started my career as a software engineer and has been looking for passion in my coding and development which I should be to enjoy my profession and has started asking myself- 'am I doing any engineering here?!' Is my code becoming that thing which I have designed in my mind? So to find that answer I have tried that old solution here... I have decided to come closer to my code and start analyzing them. And it is really working for me and at least it gives me the confidence that I can build something that I really want to. I can draw my thinking there through my code and can build-up my vision that I have designed in my mind. It also helps me to think out of the box, solve each problems by making blocks and make me careful on each steps." ----- says Morshed Anwar.

• Morshed's Technical Blog site: http://morshedanwar.wordpress.com/

• Morshed's Technical articles those are published in Codeproject site: http://www.codeproject.com/script/Articles/MemberArticles.aspx?amid=2992452

• Morshed's Linkedin profile: http://www.linkedin.com/in/morshedanwar

• Morshed's Facebook Profile : http://www.facebook.com/morshed.pulok

Beside all these Morshed like to do - photography and music. Here is Morshed's Flickr photos : http://www.flickr.com/photos/morshed_anwar/

You may also be interested in...

Pro
Pro

Comments and Discussions

 
GeneralRe: CloneEntity throwing Out-of-memory error Pin
Lee Keel21-Nov-12 12:01
memberLee Keel21-Nov-12 12:01 
GeneralRe: CloneEntity throwing Out-of-memory error Pin
Morshed Anwar21-Nov-12 12:11
memberMorshed Anwar21-Nov-12 12:11 
QuestionProblem with self-tracking entities Pin
Member 950081122-Oct-12 5:09
memberMember 950081122-Oct-12 5:09 
AnswerRe: Problem with self-tracking entities Pin
Morshed Anwar22-Oct-12 5:30
memberMorshed Anwar22-Oct-12 5:30 
GeneralRe: Problem with self-tracking entities Pin
Member 950081123-Oct-12 3:30
memberMember 950081123-Oct-12 3:30 
GeneralRe: Problem with self-tracking entities Pin
Morshed Anwar23-Oct-12 5:20
memberMorshed Anwar23-Oct-12 5:20 
QuestionRegarding master detail audit trail Pin
Tridip Bhattacharjee17-Oct-12 5:11
memberTridip Bhattacharjee17-Oct-12 5:11 
AnswerRe: Regarding master detail audit trail Pin
Morshed Anwar17-Oct-12 10:35
memberMorshed Anwar17-Oct-12 10:35 
Hey Tridip, First of all thanks to you for give me a chance to think on a scenario. In my current implementation, Off-course it will audit each changes separately. From my early thinking , I can tell you similar kind of master-detail idea while working one of my projects where I did master and detail table for Audit. There I have created a audit session by inserting a user information with time during user logged-in and after that all my audits(this article implementation) by that specific user will go into details table of Audit with reference of that master key .In my scenario One user can be logged in one workstation at a time. I know it is different from your scenario but you can apply this kind of master-detail audit idea while doing a request workflow...which means when you request product changes...you can insert in master table with some screen information or something like that and get a unique id to identify your request workflow ...and after that rest of the procedure will be same. It will help you to grouping you changes. In achieve this, You need to create and dispose your context(ObjectContext/Dbcontext) while handling a request...Which mean A Context will be created when request come to business layer end and Context will be alive till to save changes and after dispose on finish of request. Hope it helps Smile | :)
Md. Morshed Anwar | Senior Software Engineer
Adaptive Enterprise Limited
Blog: http://morshedanwar.wordpress.com/

GeneralRe: Regarding master detail audit trail Pin
Tridip Bhattacharjee17-Oct-12 21:10
memberTridip Bhattacharjee17-Oct-12 21:10 
SuggestionAudit trail for Entity Framework Code-first (DbContext) Pin
Morshed Anwar3-Oct-12 22:48
memberMorshed Anwar3-Oct-12 22:48 
QuestionGreat works, but it is not working with EntityDataSource. Pin
coderdest1-Aug-12 22:11
membercoderdest1-Aug-12 22:11 
AnswerRe: Great works, but it is not working with EntityDataSource. Pin
Morshed Anwar2-Aug-12 0:30
memberMorshed Anwar2-Aug-12 0:30 
QuestionDbContext Pin
mohammed927-Jul-12 0:30
membermohammed927-Jul-12 0:30 
GeneralRe: DbContext Pin
Morshed Anwar27-Jul-12 7:53
memberMorshed Anwar27-Jul-12 7:53 
AnswerRe: DbContext Pin
Morshed Anwar3-Oct-12 22:51
memberMorshed Anwar3-Oct-12 22:51 
GeneralMy vote of 5 Pin
Yugan_SA5-Jul-12 1:36
memberYugan_SA5-Jul-12 1:36 
QuestionOriginal Values not available for Self Tracking Entities Pin
Brett Dalldorf21-May-12 1:48
memberBrett Dalldorf21-May-12 1:48 
AnswerRe: Original Values not available for Self Tracking Entities Pin
Lipi Hardjono27-May-12 16:47
memberLipi Hardjono27-May-12 16:47 
GeneralRe: Original Values not available for Self Tracking Entities Pin
mark.deraeve13-Jun-12 21:20
membermark.deraeve13-Jun-12 21:20 
GeneralRe: Original Values not available for Self Tracking Entities Pin
Morshed Anwar23-Oct-12 5:31
memberMorshed Anwar23-Oct-12 5:31 
QuestionHow to preserve Old data in Audit Trail implementation via Entity Framework Pin
mittarah7-May-12 3:40
membermittarah7-May-12 3:40 
AnswerRe: How to preserve Old data in Audit Trail implementation via Entity Framework Pin
Morshed Anwar9-May-12 0:15
memberMorshed Anwar9-May-12 0:15 
SuggestionBrilliant Article! Just needs a bit of editing for a Context Template (See this post) Pin
Brett Dalldorf26-Apr-12 2:03
memberBrett Dalldorf26-Apr-12 2:03 
QuestionPrimary key still zero on added objects Pin
angelo carlt18-Nov-11 6:00
memberangelo carlt18-Nov-11 6:00 
AnswerRe: Primary key still zero on added objects Pin
mark.deraeve12-Apr-12 0:12
membermark.deraeve12-Apr-12 0:12 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.161205.3 | Last Updated 27 Mar 2009
Article Copyright 2009 by Morshed Anwar
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid