Umgang mit Optionswerten

comments Kommentare deaktiviert für Umgang mit Optionswerten
By , 15. Mai 2015

Hallo,
heute befasse ich mich mit dem Thema „Umgang mit Optionswerten“. Es gibt kaum eine Anwendung die ohne Optionen auskommt. Sei es ein bestimmtes Verzeichnis oder bestimmte Werte oder Zustände.
Per Zufall bin ich heute auf eine Sache gestoßen in Verbindung mit Arrays: Ich wollte die in der gespeicherten Tabelle in ein Array laden um auf sie zugreifen zu können. Aber ein Element eines Arrays lässt sich nur über den Index abrufen, nicht über einen aussagekräftigen Namen.
Also hab ich mal herumgetüftelt, und schließlich doch eine sehr brauchbare Lösung gefunden.
Meine Tabelle hat 6 Optionsfelder. Ich erstelle also zuerst einen Öffentlichen Enum mit den Feldnamen:

Public Enum ltOption
    sportjahr = 0
    old_sportjahr = 1
    vereinsname = 2
    vereinsNummer = 3
    adminpassword = 4
    usestartgeld = 5
End Enum

Als nächstes benötigen wird 2 Variablen:

Public myOptions(5) As Variant
Private FieldNameArr As Variant

Zum Setzen der Optionswerte und zum Auslesen benötigen wird Get/Let Properties:

Public Property Get Settings(cOption As ltOption) As Variant
    Settings = myOptions(cOption)
End Property

Public Property Let Settings(cOption As ltOption, vValue As Variant)
    myOptions(cOption) = vValue
    CurrentDb.Execute "Update tabOptionen set " & FieldNameArr(cOption) & " = " & OptionDataType(vValue, cOption)
End Property

Read more »

Audit Trail – oder wie protokoliert man Datenänderungen

comments Kommentare deaktiviert für Audit Trail – oder wie protokoliert man Datenänderungen
By , 11. Mai 2015


Hallo,
das Thema heute handelt von der Protokollierung von Datensatzänderungen auf Formularbasis, der Fachbegriff dazu lautet Audit Trail. Datensatzänderungen in einer Abfrage oder direkt in einer Tabelle können in Access Jet nicht überwacht werden. Deshalb ist dem Anwender der Zugriff auf beide zu verwehren mit verschiedenen Techniken.

 
 

1. Definition und Motivation top

Laut Gabler Wirtschaftslexikon dient ein Audit Trail einerseits der „Prüfung bzw. Überwachung der Handelnden und ihrer Aktivitäten, anderseits kann dadurch im Schadensfall bzw. zwecks Aufdeckung doloser Handlungen die Handlungsfolge rückverfolgt und auch eine System- bzw. Datenwiederherstellung vereinfacht werden. So sind gezielte Prüf- und Korrekturmöglichkeiten von fehlerhaften bzw. inkriminierten Benutzereingaben möglich“

Für uns in der EDV heruntergebrochen dient ein Audit Trail zur Prüfung bzw. Überwachung von Dateneingaben, -Änderungen bzw. -Löschungen um z.b. im Fall eines Schadens die Datenintegrität wieder herzustellen oder auch bei juristischen Auseinandersetzungen Beweise für Fehleingaben (oder eben nicht) zu besitzen.

Die Motivation zur Durchführung des Audit Trails können sehr unterschiedlich sein. Z.B. zur Überwachung einzelner Arbeitsplätze wo gehäuft Fehleingaben im EDV-System vorgefallen sind, oder auch um Datenanalyse durchführen zu können, und nicht zuletzt auch zur Einhaltung der Datenintegrität.
Aber bei aller Liebe zur Technik, ein Audit Trail darf kein Selbstzweck sein, denn es bindet Ressourcen im Unternehmen und kostet somit reales Geld – eventuelle rechtliche Fragen jetzt mal ausgeschlossen.

In diesem Beitrag möchte ich aber nur auf die Technik dazu eingehen, denn das interessiert wohl die meisten Leser.
Fangen wir an beim Formular. Die zu überwachenden Steuerelemente sind im Wesentlichen TextBox, ComboBox, ListBox, CheckBox, Optionsfeld und Umschaltfläche. Um diese zu Überwachen müssen die Steuerelemente an eine Datenquelle, z.B. Abfrage oder Tabelle, gebunden sein.
 
 

2. Verwendete Formular-Ereignisse top

BeforeUpdate: Dieses Ereignis tritt ein, wenn nach einer Datenänderung der Datensatz gewechselt wird, oder wenn z.B. durch klicken der Focus in ein Unterformular gesetzt wird. Zur Datensatzänderung zählt hier neben der Änderung auch die Neuanlage. Beide unterscheidet man wie folgt:

Private Sub form_BeforeUpdate(Cancel As Integer)
    If Me.NewRecord Then
        MsgBox "NeuerDatensatz"
    Else
        MsgBox "Datensatzänderung"
    End If
End Sub

Delete: Dieses Ereignis tritt ein, wenn ein Datensatz gelöscht wurde. Dieses Ereignis verwenden wir um die Löschung zu protokollieren:

Private Sub form_Delete(Cancel As Integer)
    'Audit Trail Delete
End Sub

AfterDelConfirm: Dieses Ereignis tritt ein, wenn – bei aktivierter Option „Datensatzänderungen“ – ein Datensatz gelöscht wird und bei dem folgenden Bestätigungsdialog entweder der Löschung zugestimmt wird oder diese abgebrochen wird. Diese Option befindet sich unter Access-Optionen/Clienteinstellungen/Bestätigen. Das Event liefert einen Status, mithilfe man unterscheidet ob der Löschvorgang abgebrochen wurde:

Private Sub form_AfterDelConfirm(Status As Integer)
    If Status <> acDeleteOK Then MsgBox "Datensatz wurde gelöscht"
End Sub

Die Aktivierungsreihenfolge der Ereignisse ist: Delete, AfterDelConfirm.
Doch wozu benötigen wir AfterDelConfirm wenn im Ereignis Delete bereits das Löschen protokolliert wurde? Nun, es könnte sein, dass der Nutzer im Bestätigungsdialog das Löschen rückgängig macht, dann müssen wir dafür sorgen dass die Log-Datei bereinigt wird, denn es steht ja das Löschen bereits drin.

Das waren die Ereignisse (Events), welche wir für das Audit Trail benötigen. Was im wesentlichen noch fehlt ist eine Funktion die die Log schreibt, und eine Funktion die ggf. die Log bereinigt.
Jetzt gehen wir aber nicht hin und „müllen“ unsere Formularmodule mit redundantem Code zu, sondern machen das ganz elegant per Klassenmodul, wo wir auch die Events der Formulare abbilden werden.
Der interessierte Leser weiss ja, dass ich auf OOP abfahre und alles möglichst Objektorientiert programmiere.
 
 

3. Implementierung im Formular top

Zuerst benötigen wir eine Referenzierung auf die Klasse um davon ein Objekt ableiten zu können:

Dim myAudit As clsAuditTrail
Private Sub Form_Load()
    Set myAudit = New clsAuditTrail
    Set myAudit.FormObj = Me
End Sub

Private Sub Form_Unload(Cancel As Integer)
    Set myAudit = Nothing
End Sub

Es wird ein Objekt erstellt „myAudit“, und die Eigenschaft „FormObj“ mit dem Formular-Objekt des aktuellen Formulares belegt.
Verwenden Sie Unterformulare? Dann können Sie auch dort das Audit Trail einsetzen, indem sie das Formular öffnen und dort obigen Code hinein kopieren. Nicht vergessen die Marke für die zu überwachenden Datenfelder zu setzen. Wenn Sie allerdings innerhalb des Unterformular-Steuerelementes eine Abfrage oder Tabelle einsetzen, dann können Sie keine Änderungen protokollieren da weder Abfragen noch Tabellen Eventhandler besitzen.
 
 

4. Funktionsweise der Klasse top

Werfen wir mal einen kurzen Blick in die Klasse.
Um nun innerhalb der Klasse auf die oben genannten Formular-Ereignisse reagieren zu können, muss zuerst das Form-Object übernommen und in einer Variablen gespeichert werden, und danach die Eventhandler definiert werden:

Public Property Set FormObj(ByRef FRM_ As Access.Form)
    Set m_frm = FRM_
    m_IdFieldName = getIDField(FRM_)
    m_frm.BeforeUpdate = "[Event Procedure]"
    m_frm.OnDelete = "[Event Procedure]"
    m_frm.AfterDelConfirm = "[Event Procedure]"
End Property

In der Variable m_IdFieldName wird der Name des Formulars gespeichert, da dieser an späterer Stelle benötigt wird. Die Eventhandler werden auf einfachste Weise definiert, indem man dem möglichen Ereignis den Textstring „[Event Procedure]“ zuweist. Ohne diese Zuweisung werden keine Events gefeuert.
Die Programmierung der Formular-Ereignisse in der Klasse geschieht auf identische Weise wie im Formular, nur haben wir hier nicht das Form-Object sondern seinen Stellvertreter m_frm.
Ein Beispiel:

Private Sub m_frm_AfterDelConfirm(Status As Integer)
    If Status <> acDeleteOK Then Call DataRedoDelete
End Sub

Verwendet man innerhalb der Formulare ebenfalls die gleichen Eventhandler, so ist zu bedenken dass immer zuerst der Eventhandler des Formulars feuert, und dann erst der in der Klasse. Das kann funktionierten, kann aber auch zu problemen führen.

Kommen wir nun zum eigentlichen Protokollieren. Dieser Algorithmus ist eigentlich ziemlich einfach.
Man prüft alle Steuerelemente des Formulars in einer Schleife ob die Eigenschaft Value <> der Eigenschaft OldValue ist. Trift dies zu hat man eine Datensatzänderung. Da nur Steuerelemente die Eigenschaft Value haben, die auch einen Steuerelementinhalt besitzen, ist es ratsam einfach alle zu überwachenden Steuerelemente mit einer Marke auszustatten. Ich habe im Beispiel als Marke den Text Audit verwendet.

Da man nicht nur die Änderung sondern auch Wer Wann und Wo geändert hat, benötigen wir dazu noch ein paar Werte. Die Vaiable lngInsertedID wird benötigt, um beim Löschen die ID des eingefügten Datensatzes in der Log zu behalten. Wird das Löschen nämlich abgebrochen werden wir anhand dieser Variable den zu entfernenden Datensatz aus der Log identifizieren.

Private Sub DataChanges()
    Dim CTL As Control
    Dim lngInsertedID As Long

    dtmCurrentDateTime = Now()
    strUserName = Environ("USERNAME")
    Select Case UserAction
    Case "EDIT"
        For Each CTL In m_frm.Controls
            If CTL.Tag = "Audit" Then
                If Nz(CTL.Value) <> Nz(CTL.OldValue) Then
                    WriteEditLog CTL
                End If
            End If
        Next CTL
    Case Else
        lngInsertedID = WriteNewDeleteLog
        If UserAction = "DELETE" Then lastIdentifier = lngInsertedID
    End Select
End Sub

Die Prozedur WriteEditLog übernimmt das Steuerelement-Objekt CTL, welches sich geändert hat. Aus diesem Objekt erhalten wir die Werte für Value, OldValue und ControlSource, also der Name des Tabellenfeldes das an dieses Control gebunden ist:

Private Sub WriteEditLog(ByRef CTL_ As Access.Control)
    Dim strSQL As String
    strSQL = "Insert into tblAuditTrailLog (AuditTime, UserName, FormName, FieldName, ActionType, RecordID, OldValue, NewValue) Values (" & _
             "'" & dtmCurrentDateTime & "', " & _
             "'" & strUserName & "', " & _
             "'" & m_frm.Name & "', " & _
             "'" & CTL_.ControlSource & "', " & _
             "'" & UserAction & "', " & _
             "'" & m_frm.Controls(m_IdFieldName).Value & "', " & _
             "'" & CTL_.OldValue & "', " & _
             "'" & CTL_.Value & "' " & _
             ")"
    CurrentProject.Connection.Execute strSQL
End Sub

Bei der Löschung / Neuanlage ist es ähnlich, nur benötigen wir dort die Felder AuditTime, UserName, FormName, ActionType, RecordID. Was zum Schluss noch fehlt sind ein paar Properties, Hilfsfunktionen und Variablendeklarationen.

 
 

5. Setup und Initialisierung top

Was noch fehlt ist ein Setup, welches beim erstmaligen Verwenden der Klasse die Log-Tabelle für das Audit Trail anlegt.
Um diese Tabellenerstellungs-Abfrage nur 1-mal auszuführen, muss geprüft werden ob die Tabelle bereits existiert. Dazu greifen wir per Dlookup() auf die System-Tabelle MSysObjects zu, in der alle angelegten Access-Objekte gespeichert werden. Ausgeführt wird das beim Klassen-Ereignis „Initialize“:

Private Sub Class_Initialize()
    Dim strSQL As String
    strSQL = "Create Table tblAuditTrailLog (" & _
             "ID COUNTER CONSTRAINT ID PRIMARY KEY, " & _
             "AuditTime date, " & _
             "UserName Text, " & _
             "FormName Text, " & _
             "FieldName Text, " & _
             "ActionType Text, " & _
             "RecordID Text, " & _
             "OldValue Text, " & _
             "NewValue Text" & _
             ")"
    If Not AuditTabExists Then
        CurrentProject.Connection.Execute strSQL
    End If
End Sub

In der Variable strSQL wird die Tabellenerstellungs-Abfrage zusammengestellt. Man beachte dass ein AutoWert-Feld als COUNTER CONSTRAINT definiert wird. Die Funktion AuditTabExists prüft in MSysObjects ob bereits ein Eintrag mit Namen „tblAuditTrailLog“ vorhanden ist, falls nicht wird die Tabelle erstellt.

 
 

6. Die Klasse clsAuditTrail top

Die fertige Klasse clsAuditTrail sieht nun so aus:

Option Explicit
Option Compare Text

' ================================================
' Code by Andreas Vogt Email: info@accessblog.de
' ================================================

Private WithEvents m_frm As Form

Private m_Identifier As Long
Private m_IdFieldName As String
Private m_UserAction As String
Private m_AuditTabExists As Boolean

Private dtmCurrentDateTime As Date
Private strUserName As String

Public Property Set FormObj(ByRef FRM_ As Access.Form)
    Set m_frm = FRM_
    m_IdFieldName = getIDField(FRM_)
    m_frm.BeforeUpdate = "[Event Procedure]"
    m_frm.AfterUpdate = "[Event Procedure]"
    m_frm.OnDelete = "[Event Procedure]"
    m_frm.AfterDelConfirm = "[Event Procedure]"
End Property

Private Property Get AuditTabExists() As Boolean
    If Not m_AuditTabExists Then
        m_AuditTabExists = IsNull(DLookup("[Name]", "MSysObjects", "[Name] = 'tblAuditTrailLog' AND (Type = 1 Or Type = 6)")) = False
    End If
    AuditTabExists = m_AuditTabExists
End Property

Private Property Get UserAction() As String
    UserAction = m_UserAction
End Property

Private Property Let UserAction(ByVal UserAction_ As String)
    m_UserAction = UserAction_
End Property

Private Property Get lastIdentifier() As Long
    lastIdentifier = m_Identifier
End Property

Private Property Let lastIdentifier(ByVal lastident As Long)
    m_Identifier = lastident
End Property

Private Sub Class_Initialize()
    Dim strSQL As String
    strSQL = "Create Table tblAuditTrailLog (" & _
             "ID COUNTER CONSTRAINT ID PRIMARY KEY, " & _
             "AuditTime date, " & _
             "UserName Text, " & _
             "FormName Text, " & _
             "FieldName Text, " & _
             "ActionType Text, " & _
             "RecordID Text, " & _
             "OldValue Text, " & _
             "NewValue Text" & _
             ")"
    If Not AuditTabExists Then
        CurrentProject.Connection.Execute strSQL
    End If
End Sub

Private Sub Class_Terminate()
    Set m_frm = Nothing
End Sub

Private Sub m_frm_Delete(Cancel As Integer)
    UserAction = "DELETE"
    DataChanges
End Sub

Private Sub m_frm_AfterDelConfirm(Status As Integer)
    If Status <> acDeleteOK Then Call DataRedoDelete
End Sub

Private Sub m_frm_BeforeUpdate(Cancel As Integer)
    If m_frm.NewRecord Then
        UserAction = "NEW"
        DataChanges
    Else
        UserAction = "EDIT"
        DataChanges
    End If
End Sub

Private Sub DataChanges()
    Dim CTL As Control
    Dim lngInsertedID As Long

    dtmCurrentDateTime = Now()
    strUserName = Environ("USERNAME")
    Select Case UserAction
    Case "EDIT"
        For Each CTL In m_frm.Controls
            If CTL.Tag = "Audit" Then
                If Nz(CTL.Value) <> Nz(CTL.OldValue) Then
                    WriteEditLog CTL
                End If
            End If
        Next CTL
    Case Else
        lngInsertedID = WriteNewDeleteLog
        If UserAction = "DELETE" Then lastIdentifier = lngInsertedID
    End Select
End Sub

Private Sub WriteEditLog(ByRef CTL_ As Access.Control)
    Dim strSQL As String
    strSQL = "Insert into tblAuditTrailLog (AuditTime, UserName, FormName, FieldName, ActionType, RecordID, OldValue, NewValue) Values (" & _
             "'" & dtmCurrentDateTime & "', " & _
             "'" & strUserName & "', " & _
             "'" & m_frm.Name & "', " & _
             "'" & CTL_.ControlSource & "', " & _
             "'" & UserAction & "', " & _
             "'" & m_frm.Controls(m_IdFieldName).Value & "', " & _
             "'" & CTL_.OldValue & "', " & _
             "'" & CTL_.Value & "' " & _
             ")"
    CurrentProject.Connection.Execute strSQL
    
End Sub

Private Function WriteNewDeleteLog() As Long
    Dim strSQL As String
    Dim RecordsAffected As Long
    Dim cnn As New ADODB.Connection
    Dim rstTemp As ADODB.Recordset

    strSQL = "Insert into tblAuditTrailLog (AuditTime, UserName, FormName, ActionType, RecordID) Values (" & _
             "'" & dtmCurrentDateTime & "', " & _
             "'" & strUserName & "', " & _
             "'" & m_frm.Name & "', " & _
             "'" & UserAction & "', " & _
             "'" & m_frm.Recordset.Fields(m_IdFieldName).Value & "')"
    Set cnn = CurrentProject.Connection
    cnn.Execute strSQL, RecordsAffected
    If RecordsAffected > 0 Then
        Set rstTemp = cnn.Execute("SELECT @@IDENTITY")
        WriteNewDeleteLog = rstTemp(0)
        rstTemp.Close
    End If

    Set rstTemp = Nothing
    Set cnn = Nothing
End Function

Private Sub DataRedoDelete()
    Dim rstTemp As ADODB.Recordset

    Set rstTemp = New ADODB.Recordset
    With rstTemp
        .Open "SELECT * FROM tblAuditTrailLog", CurrentProject.Connection, adOpenDynamic, adLockOptimistic
        .Find "ID = " & lastIdentifier
        If Not .EOF Then
            .Delete
        End If
    End With

    rstTemp.Close
    Set rstTemp = Nothing
End Sub

Private Function getIDField(FRM_ As Access.Form) As String
    Dim i As Long
    With FRM_.Recordset
        For i = 0 To .Fields.Count - 1
            If .Fields(i).Type = 4 Then
                getIDField = .Fields(i).Name
                Exit For
            End If
        Next i
    End With
End Function

Bis dahin
© 2015 Andreas Vogt

OfficeFolders theme by Themocracy