codebeamer Audit Trail
It is available from codeBeamer 9.2.0 version.
codeBeamer Audit is a tool for System Administrators to analyze and finally export the following user interactions:
- User logins, logouts (including system logouts)
- Work Item or Artifact modification actions (create, update, delete)
- Permission changes (Trackers, Tracker fields, Roles, User Groups)
Audit tool can be accessible on System Admin page
Click to Audit link to start it.
Audit Configuration setup
Audit is enabled by default but it is also configurable using general.xml:
All enabled Audit Events are stored into Audit log after successful configuration, but this configuration also available under the Audit menu item.
Using the System Admin configuration page changes are not persisted into general.xml, so if the codeBeamer will be restarted then the general.xml settings will be used.
Automatic Audit Log Remover Job
We created a Audit Remover Job which deletes the old User Login and Work Item Modification Action Audit entries. Audit removal is also configurable which defines that how long we would like to keep these audit records:
- minimum: 30 days
- maximum: 365 days
- default is 180 days
The older records will be automatically deleted
If you want to keep these Audit information over a year you have to make a backup from the database periodically or export Audit information into PDF or Excel.
Users can list and export three types of custom filterable Audit Records.
Each tab contains export functionality as well, using them users can export the whole result to PDF or Excel with these icons:
Login History Audit
We can find login/logout time of users on this tab.
There is a search panel where we can filter the result:
Search parameters:
- Users parameter contains usernames
- Event Types parameter contains the selected events: User Login, User Logout, User System Logout
- Login range parameter contains the selected date interval (it cannot be greater than one year)
The search result contains the audit records. We can see the following columns:
- User contains the username and a photo from the user if it is uploaded. the username is a link to the current user page.
- Event Type contains the event
- Created at contains the login or logout date.
Example result:
Work Item Modification Action Audit
We can find create, update or delete actions for artifacts and work items.
There is a search panel where we can filter the result:
Search parameters:
- Users parameter contains usernames
- Projects parameter contains project names
- Trackers parameter contains tracker names
- Event Types parameter contains the selected events:
- Work Item Create, Work Item Delete, Work Item Remove, Work Item Restore, Work Item Update
- Artifact Create, Artifact Delete, Artifact Remove, Artifact Restore, Artifact Update
- Created at range parameter contains the selected date interval (it cannot be greater than one year)
The search result contains the audit records. We can see the following columns:
- User contains the username and a photo from the user if it is uploaded. the username is a link to the current user page.
- Work Item contains the name of the item. The name is a link to the corresponding item.
- Event Type contains the event
- Project contains the project if it is available. The name is a link to the corresponding project.
- Tracker contains the tracker if it is available. The name is a link to the corresponding tracker.
- Changes contains a link to the diff viewer if it is available. Diff viewer can be available for work items.
- Created at contains the action date.
Example result:
We can use diff viewer to see the changes between work item revisions. Click to the Show changes link to open.
Example of User Story diff:
Permissions Change Audit
We can find create, update or delete permissions for trackers, tracker fields, roles or user groups.
There is a search panel where we can filter the result:
Search parameters:
- Users parameter contains usernames
- Projects parameter contains project names
- Trackers parameter contains tracker names
- Event Types parameter contains the selected events: Artifact Permission Create, Artifact Permission Delete, Artifact Permission Update
- Created at range parameter contains the selected date interval (it cannot be greater than one year)
The search result contains the audit records. We can see the following columns:
- User contains the username and a photo from the user if it is uploaded. the username is a link to the current user page.
- Work Item contains the name of the item. The name is a link to the corresponding item.
- Event Type contains the event
- Project contains the project if it is available. The name is a link to the corresponding project.
- Tracker contains the tracker if it is available. The name is a link to the corresponding tracker.
- Changes contains a link to the diff viewer if it is available. Diff viewer can be available for work items.
- Created at contains the action date.
Example result:
We can use diff viewer to see the changes. Click to the Show changes link to open.
Example diff for adding new User to a Group:
Example diff of tracker permission change: