ALM auditing

This section describes how ALM auditing works.

Enable or disable ALM auditing

Use the ENABLE_AUDIT site parameter to enable or disable ALM auditing.

For details about configuring site parameters, see Set configuration parameters.

Back to top

What to log and where logs are stored

The following table describes which actions are logged by ALM and where they are logged.

Action Where the log is stored Notes

User operations that include:

  • Creating or deleting user
  • Editing user details
  • Adding users to projects
  • Removing users from projects
  • Adding and removing admin permission
  • Deactivating and activating users
  • Adding users to user groups
  • Ending user's project sessions
  • Ending user sessions
  • Creating or deleting user groups
  • Changing user password
  • Authenticating login username and password
  • API Key creation failures

In the AUDIT_LOG file

 
Who cleared history and when In the AUDIT_LOG database table  
Changes to test steps (both design steps and run steps) In the AUDIT_PROPERTIES and AUDIT_LOG database tables

To enable the auditing for test steps:

Caution: We recommend that you do not enable the auditing for test steps unless it is necessary, as it generates a large amount of auditing data, especially for run steps.

Both old and new groups for a user when its membership is changed In the AUDIT_LOG file  
Add fields to store the current user, the current project session ID, and the current user session ID In the AUDIT_LOG file  
IP addresses for all users connected to ALM In the AUDIT_LOG file  
Changes to workflow scripts In the AUDIT_LOG file  
Entity relations In the AUDIT_PROPERTIES and AUDIT_LOG database tables  

Changes to site parameter values

In the AUDIT_LOG file  
Move items to Recycle Bin and restore items In the AUDIT_LOG database table For details about Recycle Bin, see Recycle Bin.
Customizations on project entities and requirement types In the AUDIT_LOG file For details about customizations, see Customize project entities and Customize requirement types.

Back to top

Configure auditing

You can configure the following for ALM auditing:

Keep audit log for specified categories You can use the AUDIT_LOG_FILTER parameter to keep audit log only for specified categories.
Store last login and logout time ALM stores user's last login and logout time if the ENABLE_AUDIT_LOGIN_LOGOUT_TIME parameter is set to Y.

For details, see Set configuration parameters.

Back to top

AUDIT_LOG file location

By default, the AUDIT_LOG file is stored in the {ALM_deployment_folder}\log directory.

You can use the AUDIT_LOG_PATH parameter to specify a different location for the log file. In the new location, the log file is renamed AUDIT_LOG_<machine_name>.

For details about setting site parameter, see Set configuration parameters.

Back to top