Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue

Find out how to set up Audit Trail Entities

What does this section cover?

Table of Contents
minLevel2

What is Audit Trail?

Audit trail is used to monitor the changes of information which is considered as important.  Audit trail settings provides the ability to select which entities and which fields should be monitored. Only one instance of active audit trail settings per each entity can be configured in the system and it can only be applied on predefined CRM.COM entities.

Audit trail settings are applied, either through the UI or Web API, during the execution on any of the following processes, being applied on entities or fields which are monitored by Audit Trail:

  • Modifying
  • Deleting
  • Removing information 

In addition Audit trail can be applied to a block of information or to components of that block. For example, for the Contact information entity you can monitor the addresses of the contact, You have the option to monitor the whole address block or you have the option to only monitor specific components of the address, i.e., Address/District.

When you select to monitor the address block then every time that an address is modified, added or deleted then a record will be added in the audit trail. When you select to monitor the district, when you update the district of an already defined address, then an audit trail record will be added.

Audit Trail Entities

Audit Trail can only be applied on the following predefined Transactional CRM.COM entities:

Main Entities

  • 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

Batch Processes Run Definitions

  • Notification Processes Run Definitions
  • Billing Processes Run Definitions
  • Subscription Processes Run Definitions
  • Provisioning Processes Run Definitions
  • Rewards Processes Run Definitions 
  • Voucher Processes Run Definitions

Configuration Entities

  • Conax Contego Provisioning Provider
  • Panaccess Cable View Provisioning Provider
  • Warehouses
  • Communities
  • Groups
  • Units
  • Users
  • Communities Collaboration
  • Groups Collaboration

Entity Types & Definitions

    • 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

Creating, Editing & Deleting Validations & Restrictions

Action
Validations
Restrictions
General
  • Only one Active Audit Trail per Entity should exist in the system at any given time
  • Not applicable
Save
  • Mandatory Fields:
    • Entity
    • State
  • Not applicable
Create
  • Not applicable
  • Not applicable
Edit
  • Not applicable
  • "Entity" cannot be edited once the Audit Trail is saved
Delete
  • Not applicable
  • Not applicable

Audit Trail attributes 

Name

Description

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 audit trail settings instance, which can be active or inactive. Only one active instance can exists per each entity
Information to be monitoredA list of all fields related to the selected entity that can be monitored, with the ability to enable or disable them. At least one field should be enabled if the audit trail settings instance is active

Defining your own Audit Trail tailored to your company's needs

  1. Navigate to FOUNDATION > SECURITY MANAGEMENT > SET UP AUDIT TRAIL
  2. Search for the Audit Trail or click on NEW to create a new one
  3. MAIN INFORMATION

    1. Provide the required information
      1. Entity
      2. State 
        Audit Trail - Main Information

  4. MONITORED FIELDS

    1. Select the fields to be monitored by Audit Trail OR click on ACTIVATE ALL to activate all the fields at once
      Audit Trail - Entities

  5. From the Action Menu click on SAVE
  6. LOG INFORMATION

    Include Page
    Log Information - Global
    Log Information - Global

     

Viewing Audit Trail

Once you have set up your Audit Trailed Entities every time that a change is performed on them you will have the option to see the change directly from the Data Entry page of the record that has been modified.

  1. Navigate to the page of the entity that you would like to check Audit Trail
  2. From the summary page search and click on the record you would like to check to go to the Data Entry page
  3. Click on the AUDIT LOG button located at the top right corner of the page
    Image Added 
  4. The Audit Log modal will open providing information with the fields that have changed and the changes on them
    AUDIT LOG CHANGESImage Added 

 

Note

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

Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
excerpttrue
labelssecurity-management-basics-r7,security-management-advanced-r7,security-management-admin-r7

Panel
namegrey

Popular Labels

Popular Labels
spaceKeyV4Manual
styleheatmap