AUDIT TRAIL -JÄRJESTELMÄN SUUNNITTELU JA KEHITYS ENTITY FRAMEWORKISSÄ

Abstract

Tässä opinnäytetyössä suunniteltiin ja kehitettiin järjestelmää, joka tallentaa kaikki tietokantaan tehdyt muutokset. Toiselta nimeltään tätä voisi kutsua Audit Trail (AT) -järjestelmäksi. Asiakkaana toimi energiatoimialan sähköisiin järjestelmiin, tietoanalytiikkaan ja BI-asiantuntemukseen erikoistunut Solteqin Utilities-liiketoimintayksikkö.

Opinnäytetyö aloitettiin tutustumalla käsitteeseen Audit Trail ja kuinka se tultaisiin toteuttamaan yrityksen olemassa oleviin järjestelmiin. Työn lähtökohtana oli suunnitella ja toteuttaa AT -ratkaisu, joka seuraisi muutoksia tietokantaan ja mahdollistaisi myös AT -tiedon tallennuksen, hakemisen ja näyttämisen käyttöliittymän kautta.

Asiakkaan ehdotuksesta AT -järjestelmä kehitettiin Entity Frameworkin (EF:n) sisälle seuraamaan ja tallentamaan seurattavan tietokannan muutoksia erilliseen AT -tietokantaan. AT -tietokantataulut toteutettiin omassa skeemassaan, jolla vältettiin erillisten tietokantamigraatioiden tarve muissa tietokantakonteksteissa. Audit-lokituksen ohjelmallinen toiminnallisuus kehitettiin mahdollisimman geneeriseksi ja modulaariseksi. Apuna käytettiin tarjolla olevia luokkakirjastoja ja toteutusluokkien abstrahointia, sekä hyväksi todettuja ohjelmointiarkkitehtuureja. Toteutusta Vertailtiin myös kolmannen osapuolen EF:n sisällä toimivaan AT -luokkakirjastoon.

Työn tuloksena asiakas sai AT -järjestelmän, joka seuraa EF:n sisällä tapahtuvia muutoksia tallentaen muutoshistorian ja tietokantatapahtuman tilan erilliseen tietokantaskeemaan. AT tiedot voidaan hakea käyttäjäystävällisen selainpohjaisen käyttöliittymän kautta haku- ja asemointiparametrien määrittämällä tavalla, käyttäen apuna kehitettyä tiedonhakukerrosta. Tämän lisäksi asiakas sai toteutuksen, joka käyttää apunaan kolmannen osapuolen luokkakirjastoa toteuttaakseen vastaavanlaisen toiminnallisuuden.

The purpose of this thesis was to design and develop an audit trail (AT) system that would track and log all the changes occurred in the underlying database. Utilities business unit of Solteq Corporation, the client, implements specialized digital solutions and offers data analytical services with Business Intelligence (BI) expertise for clients that operate mostly in energy industry.

The thesis work began by getting familiar with concept of audit trail and how AT system would be implemented in the client’s existing systems. The purpose was to design and implement an AT solution that could track and log the changes in the underlying database. The requirement was also to develop an easy way to retrieve tracked AT data from the browser based graphical user interface.

The client proposed that change tracking and logging of database changes would be developed within Entity Framework (EF). The database of the AT system was implemented in a separate schema in order to avoid distinct database migrations to the tracked databases. The logging of the AT system was developed as generic and modular as possible. Existing class libraries, abstraction and proven programming architecture patterns were used to achieve the demanded functionality. The solution was crosschecked against a third-party AT class library that also functions within EF.

As a result of this thesis, the client received an AT system that can automatically track changes within the premise of EF and store the changes and transaction states to a separate database schema. AT data can be retrieved from a user-friendly browser based UI with given search and positioning parameters using the developed services. The client also received a similar solution that implements a third-party AT class library in their system.