An audit trail (also called audit log) is an immutable record that keeps track of administrative actions performed in the system, such as important changes to course completion or enrollment status. The Audit Trail report provides evidence of a sequence of activities that have affected specific operations, procedures, or events, and it is useful to allocate the appropriate accountability in case of incidents, specifically pertaining to compliance.
For further information about the new Audit Trail functionality, that is available on all platforms starting from March 2021, please refer to this article.
Activating the App
Activate the Audit Trail app as described in the Managing Apps & Features article of the Knowledge Base. The app is listed in the Docebo Additional Features tab.
Creating Audit Trail Reports
To create a report, access the Admin Menu, then press the Reports item in the E-Learning section. On the main Reports page, press the Create Custom Report button. In the pop-up box, provide a name for the report, then flag the option to create an Audit Trail report. Press Next.
Choose the users to include in the report, selecting them from the Users, Groups or Branch tab. The system can keep multiple selections among tabs. You can also run a report on all registered users, if necessary. Note that when you select users in an Audit Trail Report, you are selecting the administrative users who performed the specified action(s) instead of the acted upon users. For example, if you later choose the event User has been created (by administrator), you select the administrators who created the users and not the created users. Press Next to proceed. Select the courses you want to include in the report. You can choose specific courses or all the available courses.
Press Next and set the Event Date filter, allowing you to filter by date the events that will be shown in your Audit Trail report (and in its preview and export). The option to include events which occurred on any dates is the default for the filter, so if you don’t set any specific dates, all events will be shown in your report, without date restrictions. This filter is useful to speed up data extraction, which is essential when a large amount of data is taken into consideration by the report.
Then, on the same page of the report configuration, select the data you want to see in the report, browsing among different event categories:
- Power Users. Data regarding seat allocation and purchase.
- Courses. Data regarding changes and deletion of courses and sessions, training material, etc.
- Learning Plan. Data regarding the creation, update, or deletion of learning plans.
- Custom Reports. Data regarding the creation, deletion and publishing of reports.
- User Management. Data related to user creation, deletion, suspension, and management.
- Enrollments. Data regarding the courses where users have been enrolled or unenrolled.
- Subscription Plan, Bundle, Record and Seat Association. Retrieve data related to Subscription Plans.
- Theme Management. Data regarding the change of the theme of the platform. This event can be tracked for both single domains as well as subdomains created with the Extended Enterprise App.
- Query Report. Data regarding the actions made on reports by the Query Builder in order to manually create reports extracting data directly from the database. This functionality is available only on demand.
- Central Repository. Data related to the platform's Central Repository feature.
For a full list of events that can be used in the audit trail report, refer here.
Managing Audit Trail Reports
Once you've created an Audit Trail report, it will be listed on the main Reports page in your platform. A row dedicated to every report shows the report name, its author and creation date, the report visibility and whether the report is scheduled. Click on the magnifying glass icon at the end of the row to view the report, and on the download icon to export it in CSV, XLS or HTML format. From the ellipsis icon menu, you can schedule, edit or delete the report. By default, audit trail reports are private reports. Private reports are only visible to the owner of the report and to all Superadmins.
Events for the [GET] /manage/v1/trails API
For those using the [GET] /manage/v1/trails API for the Audit Trail app, refer to this document for a full list of events that can be included in the API.
Tips & Tricks
You should refrain from creating a single Audit trail report containing all the events. It's better to have a single report for each category and limit time period in order to ease readability and use of the report itself.