start portlet menu bar

HCLSoftware: Fueling the Digital+ Economy

Display portlet menu
end portlet menu bar
Select Page

In many industries, Audit is a crucial part to maintain accuracy and tracking of all changes to the records.  AuditTrail feature in HCL Compass can fulfill this requirement as it helps in tracking the changes in different record types when they are created or changed. After you enable a record type with the AuditTrail package, all changes to records of that type will be audited.  

How to apply AuditTrail package? 

  1. Launch HCL Compass Designer 
  2. Connect to the schema repository

AuditTrail package feature in HCL Compass

3. Right click on schema version and click on apply packages

AuditTrail package feature in HCL Compass

4. Select  AuditTrail package 

AuditTrail package feature in HCL Compass

5. Select the record types you want to enable for.

AuditTrail package feature in HCL Compass

6. Click on Finish to install the package 

7. Once it gets installed successfully, check-in the latest schema version and upgrade the user DB

AuditTrail package feature in HCL Compass

How to track changes in AuditTrail for a record? 

  1. Login to HCL Compass Web 
  2. Create New defect and fill the details 
  3. Save the record 
  4. You will see Audit Trail tab that displays the audit trail for the record. 

AuditTrail package feature in HCL Compass

The information it stores by default is 

  • User identity as user name and login 
  • Database schema version that was used to describe the record  as Schema Rev 
  • Time of change 
  • Action and state 
  • Changed fields 

Note: It contains no editable fields so it cannot be altered. 

This is how the records types can be audited whenever they are created or modified 

We can also customize and configure the audit trail to: 

  1. remove certain fields from auditing 
  2. change format what the audit trail looks like
  3. customize to only audit certain records.

We will see how to remove certain fields from auditing: 

  1. You can add global hook as below to disable audit for any field. In below example we are disabling auditing for Owner field. 

AuditTrail package feature in HCL Compass2. Checkin the schema and upgrade user database 

3. Login to compass web 

4. Change Owner field and Description field 

5. Save the record 

6. You will see that Owner field changes are not captured but Description field changes are.

Before disabling auditing for Owner field: 

AuditTrail package feature in HCL Compass

After disabling auditing for Owner field: 

AuditTrail package feature in HCL Compass

In this way we can disable auditing for specific fields. For details about customization please refer link:  AuditTrail extensions 


Comment wrap
Secure DevOps | August 30, 2022
HCL Compass - Configuring secure connection on Compass Web with SSL communication
Compass Secure Web Client enables you to access your applications and data from any remote location without compromising the security of your data.
Secure DevOps | May 25, 2022
A step-by-step guide to install HCL Compass on your system with valid login credentials login into the repository.
Secure DevOps | May 19, 2022
Learn with a step-by-step guide for installing and setting up HCL compass with REST - server (trial version).