Setting and Using Audit Trail

Back to Security Management Main Page 

Table of Contents

Navigating to Audit Trail Settings

FOUNDATION > SECURITY MANAGEMENT > SET UP AUDIT TRAIL

What are Audit Trail Settings?

Audit Trail Settings define the rules governing Audit Trail logging in the System which monitors changes performed on System entries. Through Audit Trail Settings, the entities and fields that should be monitored can be selected. Only one 'Active' instance of Audit Trail Settings per Entity can be configured in the System. Audit Trail Settings can only be applied on predefined CRM.COM entities, either through the UI or Web API and during the execution on any of the following processes:

  • Modifying
  • Deleting
  • Removing information 

The logging of an Audit Trail can be applied to a block of information or to components of that block. e.g., for the Contact Information Entity, the complete address block or only specific components of the address (e.g Address/District) can be monitored. When an address block is monitored, every time the address is modified, added or deleted, an entry will be added to the Audit Trail. When the district is monitored, an Audit Trail entry will be added when the district of an already defined address is updated.

  • Navigate to Audit Trail Settings and explore existing entries via the Summary page.  
  • Click on the link (Name or Number) of the entry of your interest to enter the Data Entry page and see more detail. 
  • Use the Actions Menu to create a NEW Audit Trail Setting, modify (EDIT) or DELETE  an existing one.  
  • Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Audit Trail Setting.

View the Audit Trail Entities Table for a complete list of the entities that can be monitored using the Audit Trail and the Attributes Table for a comprehensive description of the Audit Trail Settings fields. Check the Validations & Restrictions Table below for a list of available Actions when working with Audit Trail Settings, including each Action's related validations and restrictions.

Audit Trail

Audit Trail Entities

Main Entities

Batch Processes Run Definitions

Configuration Entities

Entity Types & Definitions

  • Contact Information
  • Jobs
  • Activities
  • Communications
  • Service Requests
  • Segments
  • Accounts Receivable
  • Financial Transactions
  • Products
  • Installed Items
  • Reward Schemes
  • Reward Offers
  • Reward Participants
  • Resource Plans
  • Resource Requests
  • Ad Hoc Discounts
  • Access Tokens AVAILABLE FROM CRM.COM R12.0.0
  • Notification Processes Run Definitions
  • Billing Processes Run Definitions
  • Subscription Processes Run Definitions
  • Provisioning Processes Run Definitions
  • Rewards Processes Run Definitions 
  • Voucher Processes Run Definitions
  • Conax Contego Provisioning Provider
  • Panaccess Cable View Provisioning Provider
  • Warehouses
  • Communities
  • Groups
  • Units
  • Users
  • Communities Collaboration
  • Groups Collaboration
  • Communication Centre Definitions
  • Contact Information Definitions
  • Communication Definitions
  • Activity Types
  • Job Types
  • Notification Types
  • Subscription Definitions
  • Subscription Types
  • Normal Billing Run Definitions
  • Prepaid Billing Run Definitions
  • Billing Term Definitions
  • Accounts Receivable Definitions
  • Financial Transaction Definitions
  • Financial Transaction Types
  • Wallet Definitions
  • Wallet Transaction Types
  • Voucher Definitions
  • Voucher Types
  • Reward Definitions
  • Reward Offer Types
  • Product Types
  • Inventory Management Definitions
  • Warehouse Types
  • Resource Scheduling Definitions
  • Additive Discount Definitions

 

Validations & Restrictions

ActionValidationsRestrictions
Create
  • Mandatory fields must be defined.
  • Only one 'Active' Audit Trail per Entity can exist in the System at a time.
  • Not Applicable
Edit
  • Mandatory Fields must be defined.
  • Only one 'Active' Audit Trail per Entity can exist in the System at a time.
  • Entity cannot be changed once the Audit Trail is saved.

Attributes

An * indicates a field is mandatory.

Name

Description

Main Information
Entity*The entity that the Audit Trail will be applied on. The entities which can be monitored by the Audit Trail mechanism are listed in the Audit Trailed Entities.
State*The state of the specific Audit Trail Settings instance, which can be 'Active' or 'Inactive'.
Only one 'Active' instance can exist per Entity.
Monitored Fields
Information to be monitored

A list of all fields related to the selected Entity that can be monitored, with the option to set them as Active or not.
At least one field should be activated if the Audit Trail Settings State is 'Active'.

Either activate or deactivate specific fields by using the respective checkbox or 'Activate All' and 'Deactivate All' by using respective links.

Log Information
Log DetailsThe standard set of Log Details information available in all entities.

 

Viewing Audit Trail

Once Audit Trailed Entities are established, it will be possible to monitor their modifications directly from the entry's Data Entry page.

  1. Navigate to the Summary Page of the Entity whose Audit Trail should be monitored.
  2. From the Summary Page search and click on the entry that should be monitored, to go to its Data Entry page.
  3. Click on the AUDIT LOG button located at the top-right corner of the page.
    AUDIT LOG BUTTON 
  4. The Audit Log modal will open providing information on the modified fields and their changes.AUDIT LOG CHANGES 

 

View Understanding Security Management for business examples related to Audit Trail.