Summary

This article covers the functionality and configuration of the Audit Log report. The audit log is a comprehensive event logging tool / report. It can be used to record the smallest change on the account, or any process such as billing events for example. You can record contact name changes, the cancelling of a package, the date and time when a user logs in and changes his or her password etc. The logging is very in-depth and configurable.  Care should be considered in selecting what actions / processes are critical to your operations for tracking purposes.

Logs are stored indefinitely, if you wish to archive and purge old logs based on your organizations standards/requirements you can do so via SQL query. It is recommended you keep at least 3 months of logging in the EngageIP database and archive audit logs for at least one year on a separate system.

Configuring the Audit Log

1. Click on the Setup tab of the main owner (i.e.: admin)

2. Under the Configuration heading click Audit Setting

   

3. Click on the Object name to load the Object Setting page

   • Note: An object is data or a process in EngageIP that you want to see any changes to in the system, changes include adding, deleting, updating by any other process in EngageIP whether by a user or something such as the automated billing processes

4. Check off the User Audit checkbox

   • Enabling/disabling multiple objects at once - The 'Bulk Save' option on the Audit Setting page will allow you to enable logging for all objects listed on the previous screen. To filter out certain objects use the "View" option, explained here)

5. Click Save

   • Note: changes may take up to 2 minutes to take effect

6. Log out and log back in

7. Update a field on an account according to the objects you have selected to audit going forward

8. Review the audit log to see your actions

9. You can then sort, filter, print, export as normal with any report in EngageIP

Viewing the Audit Log Report

1. Load the Reports page

2. Under the Owner Reports heading click Audit Log

3. You should then be presented with a list report similar to all other reports in EngageIP. You can then sort, filter, print, and export the report as needed

   

Some items to note:

• The report lists the data before the change and after the change if it is able. In the case of adding new data, the before data is blank

• The report lists the object which initiated the change, its ID and the exact date and time of the event

Sample Usage

This example covers how to track when payment method information is created or deleted, for info on how to add/edit/delete payment methods see the KB article: Managing Payment Methods on an Account

Step 1: ensure user auditing is enabled for the UserPaymentMethod object

1. Log in as a user with rights to view/edit the Setup tab, Audit Setting, Reports tab and audit log (List & Edit Role permissions need to be enabled for AuditLogOwnerReport & AuditSetting)

2. Load the Admin account and click on the Setup link

3. Under the Configuration heading click Audit Setting

4. Click on the Object heading to filter the list

   

5. Enter 'PaymentMethod' in the Filter text box and press enter to filter the Audit Setting list

   

6. The UserPaymentMethod object tracks events related to Payment Method (cash, check, credit card) configuration on accounts, by default this object is enabled to Audit (User Audit=yes). If this setting has been disabled then you will need to enable it to track payment method changes (click on the object name 'UserPaymentMethod' and then on the Audit Setting edit page that loads check the 'User Audit' checkbox)
   

Step 2: review events in the owner audit log

1. Load the Reports page

2. Under Owner Reports click on Audit Log

3. The log will show details when payment method details are added (Note: you can filter by fields such as 'Object', 'Actor User', 'User' to quickly find the activity you are looking for)
   

Add Credit Card Payment Method Sample:

The log shows:

• the date of the event

• the Object that is affected (in this case UserPaymentMethod)

• the Property that is being referenced/modified

• the Type of activity (create, update, delete)

• what the value was changed From (blank = no previous value)

• what the value is changed To

• the EngageIP Actor (the EngageIP User who performed the action on the object)

• the User the object was referenced/modified on (i.e. in this example TEST user's Payment Method was created)

Edit Credit Card Payment Method Details Sample:

The sample below shows an update to the Credit Card payment method expiry date for the account 'TEST' by the User 'Admin'

Delete Credit Card Payment Method Sample:

See Also

• For information on other reports available in EngageIP see the Reports Listing and Descriptions article