Skip to content

Audit Log: A User Guide

What is the Audit Log?

CrowdFiber's Audit Log provides a chronological record of activity regarding the creation, update, or deletion of records in several areas of the CrowdFiber platform.

Audit Log records are created during a logged-in user's/API's interaction with the CrowdFiber platform.

Data Stored in the Audit Log

Audit Log records are identified by Models and Operations.

  • Models: the type of record that was created, updated, or deleted/destroyed.
    • Addresses
    • Address Connections: the relationship between an address and a contact record, order record, or address list
    • Address Searches/Leads
    • Companies
    • Contacts
    • Deals
    • Markup Edits: the changes to the HTML or CSS of your website
    • Orders
    • Quotes
    • Terms: requests that are manually sent to a customer by an Admin User (post-registration) and accepted during the registration process
    • Users
    • Zones
  • Operations: the creation, update, or deletion of records.
    • Create: the creation of a new record
    • Update: the edit of an existing record
    • Destroy: the deletion of a record

How to Read an Audit Log Record

The Audit Log contains the following columns of information:

Screenshot_of_Audit_Logs___index.jpg

  • ID
    • A unique ID for the Audit Log record.
  • Date/Time
    • The precise day and time the creation, update or deletion/destruction of a record occurred.
  • Operation
    • The name and email of the user who created, updated, or deleted a record.
    • The type of operation performed (Create, Update, Destroy).
    • The unique ID of the record that was affected in this operation.
  • Changes Made
    • The record that was affected and the data that existed in this record before and after the change was made.
      • For a Create event, the "before" data is always displayed as two quotation marks with no text in between the quotation, because no data existed before the record was created.
      • For an Update event, the "before" and "after" data consists of the data that existed in the record before the update occurred and the new data that exists in the record after the update.
      • For a Deleted event, "before" and "after" data is typically the same (while the record has been destroyed, the data that existed before the deletion is typically the same after the deletion).

Here is an example Audit Log entry:

screen_shot_2020_01_24_at_3_54_43_pm.png

This record reveals that:

  • On January 24 at 4:54 pm
  • User John Doe with email johndoe@gmail.com updated an order record (the order record with Order ID #69)
  • The Contracted status of this order was changed from "Not Contracted" (false) to "Contracted" (true).

User Data Not Stored in the Audit Log

There are some situations when Created, Updated or Destroy operations will be added to the Audit Log, but the user's email will not exist within the Audit Log record. These situations are as follows:

  • API activity: all Create, Update or Destroy operations that occur via API activity will not display user information, because no user was "logged in" when performing this operation.
  • New customer address searches: all Create operations that occur from your website visitors' address searches will not display user information, because no user was "logged in" when performing this operation.
  • Lead creation: when an anonymous (not logged in) visitor starts a registration a Lead record is created; however, this operation will not display user information, because no user was "logged in" when performing this operation.