Feature #12130

Add new archival description audit log

Added by Mike Cantelon over 1 year ago. Updated 4 months ago.

Status:VerifiedStart date:03/29/2018
Priority:MediumDue date:
Assignee:Dan Gillean% Done:

0%

Category:Information objectEstimated time:107.00 hours
Target version:Release 2.5.0
Google Code Legacy ID: Tested version:
Sponsored:Yes Requires documentation:

Description

This feature will add auditing capabilities to AtoM, to track the creation and modification of archival descriptions over time, and associate those changes with specific AtoM users.

Goal

To allow any authenticated user to view a history of all changes made to an archival description and who made the changes. Also allow administrators to view the history of all archival descriptions edited by a particular user.

Proposed functionality

  1. Track all changes to an archival description
  2. Add a “User action type” taxonomy with default terms “creation” and “modification” to categorize update action. The taxonomy terms will be locked so they can not be deleted from the system.
  3. An administrator can toggle audit log on or off in the Administration settings.
  4. When audit logging is turned off, no user actions will be logged to database
  5. When an authenticated user edits an archival description, and action logging is turned on, the action type (creation, modification), user name, user id, and timestamp will be logged to the database when the description is saved.
  6. An administrator can delete a user that has audit log entries. When the user account is deleted, the “user_id” column in the database will be set to “null”, but the “user name” (e.g. “Jane Doe”) will be retained.
  7. Any authenticated user can navigate to an archival description view page and see a “View modification history” link in the “more” menu. # The “View modification history” link will be hidden if logging is turned off in the administrator settings.
  8. Clicking the “View modification history” will load a new “Description modification history” view page with a paginated table showing a history of all changes (unlimited) made to a description.
  9. An administrator can navigate to a user view page and see a “View editing history” link. Non-administrative users can not view user account information, except for their own account.
  10. An authenticated user can click the “Profile” to view their own user account. On their user account view page they can see the “View editing history” link. This only allows them to view their own editing history.
  11. When a user or administrator clicks the “View editing history” link, a new “User edit history” page will be loaded with a paginated table showing a history of all archival description changes they have made.
  12. An administrator can navigate to the “Description updates” page to view all descriptions created or modified between the selected date range. When audit logging is turned on in the admin settings, make the following changes to the the current “Description updates” report:
    Switch to using the new archival description editing log to show all description modifications (now it only shows the latest modification)
    1. Add a “user” column to the report to show which user modified the description
    2. Update search options to allow filter results by user
  13. An administrator can import a CSV or XML file to create or update archival descriptions and any changes will be recorded in the audit log. When the “audit logging” administration setting is “on” then:
    1. Set “username” to default value “created by import” for new archival descriptions added by the import.
    2. Set “username” to default value “modified by import” for archival descriptions updated by the import.

The View modification history page's table will include the following columns:

  • date and time of the change,
  • name of the user that made the change,
  • type of change (creation, modification).

The User edit history page's table will include the following columns:

  • date and time of the change,
  • title of the archival description that was changed, with a hyperlink to load the edited description’s view page
  • type of change (creation, modification).

Limitations

  1. An “update” action will be logged every time the description is saved, without any check to confirm that description data has actually been altered.
  2. The date and time of all audit log entries will be displayed in the timezone of the AtoM system. AtoM does not maintain a record of the timezone of individual users.
  3. Archival description deletions will not be recorded or displayed in the audit log because AtoM does not currently retain any information about deleted records.

Development tasks associated with this feature

  1. Add new system taxonomy terms
  2. Add admin setting to toggle audit feature 'on' or 'off'
  3. Add new database table to contain audit data
  4. Record audit info when an archival description is created or modified
  5. Add a link to "View modification history” link in the “more” menu on the archival description view page
  6. Create new “Description modification history” view page linked to from "View modification history" link
  7. Add a user "View editing history" page that will detail all changes by a specific user. This page is linked to from the user profile page
  8. Modifications to Description Updates page
  9. Modification to CSV and XML Import process

History

#2 Updated by Dan Gillean over 1 year ago

  • Subject changed from Archival description audit log to Add new archival description audit log
  • Description updated (diff)

#3 Updated by Dan Gillean over 1 year ago

  • Sponsored changed from No to Yes
  • Requires documentation set to Yes

#4 Updated by Mike Cantelon about 1 year ago

  • Status changed from New to QA/Review
  • Assignee changed from Mike Cantelon to Michelle Curran

#6 Updated by Dan Gillean 4 months ago

  • Assignee changed from Michelle Curran to Dan Gillean

#7 Updated by Dan Gillean 4 months ago

  • Status changed from QA/Review to Verified

#8 Updated by Dan Gillean 4 months ago

  • Requires documentation deleted (Yes)

Also available in: Atom PDF