Versions Compared

Key

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

Back to Security Management Main Page 

Excerpt
hiddentrue

Find out how to set up Audit Trail Entities

What does this section cover?

Learn to configure Audit Trail Settings

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to Audit Trail Settings

Info

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

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, being applied on entities or fields which are monitored by Audit Trail:

  • Modifying
  • Deleting
  • Removing information 

In addition Audit trail The logging of an Audit Trail can be applied to a block of information or to components of that block. For examplee.g., for the Contact information entity you can monitor the addresses of the contact, You have the option to monitor the whole Information Entity, the complete address block or you have the option to only monitor specific components of the address , i.(e., g Address/District) can be monitored. When you select to monitor the an address block then is monitored, every time that an the address is modified, added or deleted then a record , an entry will be added in to the audit trailAudit Trail. When you select to monitor the district is monitored, when you update an Audit Trail entry will be added when 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

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 TrailImage Added

Anchor
entities
entities
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
Batch Processes Run Definitions
  • Access Tokens
    Status
    colourBlue
    titleAvailable 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

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

 

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictionsGeneral
Create
  • Mandatory fields must be defined.
  • Only one 'Active' Audit Trail per Entity should can exist in the system System at any given a time.
  • Not applicableApplicable
SaveEdit
  • Mandatory Fields :
    • Entity
    • State
  • Not applicable
Create
  • Not applicable
  • Not applicable
Edit
  • Not applicable
  • "Entity" cannot be edited 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.

Anchor

Delete

attributes

Not applicable

attributes

  • Not applicable
Audit Trail attributes 

Attributes

An * indicates a field is mandatory.

Name

Description

Main Information
Entity*The entity that the audit trail Audit Trail will be applied on. The entities which can be monitored by the audit trail Audit Trail mechanism are listed in the Audit Trailed Entities.
State*The state of the audit trail settings specific Audit Trail Settings instance, which can be active or inactive. Only one active instance can exists per each entity'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

Entity that can be monitored, with the

ability to enable or disable them.

option to set them as Active or not.
At least one field should be

enabled

activated if the

audit trail settings instance is active

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

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

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

  • 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 - EntitiesImage Removed

  • From the Action Menu click on SAVE
  • LOG INFORMATION

    Include PageLog Information - GlobalLog Information - Global

     

    NoteVisit

    Audit Trail Settings State is 'Active'.

    Note

    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 BUTTONImage Added 
    4. The Audit Log modal will open providing information on the modified fields and their changes.AUDIT LOG CHANGESImage Added 

     

    Note

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

    Panel
    namegrey

    Related Areas

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

    Popular Labels

    spaceKey
    Panel
    namegrey
    Popular Labels

    Helpful Links

    Filter by label (Content by label)
    heatmap
    showLabelsfalse
    spacesV4Manualstyle
    showSpacefalse
    labelsglobal