Viewing the Audit Log

CDB records audit events related to ingestion and import on the Import > Audit Log. Workbench generates an entry in the Packages Audit Log for each package import that was processed and reprocessed. Workbench generates an entry in the Import Approvals Audit Log when a package is approved or rejected. You can filter the audit log by Source and Loaded Date Range.

The Ingestion Audit Log is a new feature in the 21R3 release (December 2021). The Audit Log records events starting at the time of the 21R3 release.

Prerequisites

Users with the standard CDMS Data Manager, CDMS Lead Data Manager, and CDMS Super User study roles can perform the actions described below by default. If your vault uses custom Study Roles, your role must grant the following permissions:

Type Permission Label Controls
Functional Permission Workbench Tab

Ability to access and use the Data Workbench application, via the Workbench tab

Functional Permission View Import

Ability to access the Import page

If your Study contains restricted data, you must have the Restricted Data Access permission to view it.

Learn more about Study Roles.


Access the Audit Log

You can access the audit log from the Import area of CDB. You can navigate to the Import area from the Navigation Drawer () or, after you select your Study, from the Study menu () on the Studies page.

Once you’ve entered the Import area, click Audit Log in the header to open that subtab.

Audit log subtab

Log Types

There are two log types: Packages and Import Approvals. Packages logs the import of packages into Workbench. Import Approvals logs events related to the approval and rejection of modified third party data packages.

You can switch between the two log types using the Log Types drop-down.

Packages Audit Log Columns

The Packages Audit Log has the following columns:

Column Description
Study The Name (Study Number) of the Study
Source The Name of the Source
Package The File Name of the Package
Load Completion The date and time the import package was loaded
Loaded By The Name of the user who loaded the package
Transform Start The date and time that transformation started for the package.
Transform Completion The date and time the import package was transformed
Import Start The date and time that import started for the package.
Import Completion The date and time the import package was imported
Date Applied The date and time the import package was applied

Import Approvals Audit Log Columns

The Import Approvals Audit Log has the following columns:

Column Description
Study The Name (Study Number) of the Study
Source The Name of the Source
Package The File Name of the Package
Load Completion The date and time the import package was loaded
Loaded By The Name of the user who loaded the package
Decision The decision on the package, either Approved or Rejected.
Decision By The Name of the user who reviewed the package.
Decision Date The date that the decision was made for the package.
Reason The reason that the reviewer provided when approving or rejecting the package.

Filter the Audit Log

You can filter the audit log by Source and Loaded Date Range (up to 90 day range).

By default, the Source filter is set to All and the Loaded Date Range filter is set to the current day. The audit log is sorted by Import Date in descending order.

To filter the audit log:

  1. Navigate to Import > Audit Log.
  2. Select a Source.
    Source Filter
  3. Select or enter a Start Date for Loaded Date Range.
    Start Date selection
  4. Select or enter an End Date.
    End Date selection
  5. Click Apply. Workbench applies your filters.

Download the Audit Log

You can download the audit log as a CSV file. The CSV lists entries sorted by Import Date in descending order.

To download the audit log:

  1. Navigate to Import > Audit Log.
  2. Click Download.
    Download button
  3. Save the CSV file (“{Study_Name}-Ingestion_Audit_Trail-{DateTime}.csv”) and open it in a viewer of your choosing.