Documentation Index

Fetch the complete documentation index at: https://help.idibilling.com/llms.txt

Use this file to discover all available pages before exploring further.

IDI version 26.8 is now available.  Click here for details: IDI Updates.

Tracking Changes in the Audit Log

Prev Next

The Audit Log tracks when information is added, edited or deleted in the IDI platform. Finding records for specific changes that occurred can start from the Audit Log web module Search screen or sometimes right from the object itself that was changed.

What Changes Are Tracked


Changes made in the following modules are tracked in the Audit Log:

  • Admin Console

  • IDI Desktop  Client

  • Customer Care

  • Inventory

  • Orders

  • Tickets

Changes made directly in the following Web APIs are tracked in the Audit Log:

  • Balance

  • Customer Management

  • Inventory Management

  • Journal Service

  • Number Inventory Service

  • Order Placement

How Long Audit Logs Are Available


Audit Log information for changes made in the IDI platform is available for a period of one year.  Information older than one year is removed from the system on a periodic basis.

Tracking Security Logs


The location where Security information such as user administration, failed logon attempts and successful logons depends on which module the records originated from:

Security Audit Log (available in Security Web module)

  • Logons to web modules / web APIs

  • User Administration in Security

Audit Log

  • Logons to CostGuard Client / AdminConsole

  • User Administration in AdminConsole

Finding Audit Log Information


The Audit Log Search allows users to search across all the records in an environment.

The default search filters to display records from the last 30 days however you can specify additional criteria to help narrow down your search.

Object Type

The Object Type represents the nature of the item that you are searching for records about. There are numerous different types of objects in CostGuard that can have information added to it or updated however the four major types that are supported for filtering are Customers, Services, Features and Orders (Billing Order).

Object Key

The Object Key field become available if you select an Object Type to search by. What the Object Key field represents depends on the Object Type selected:

Object Type

Object Key

Customer

Account Number

Service

Service Number

Feature

Feature ID

Order

Order ID

User ID

The user who initiated the change. Updates made directly by your company via the Web APIs may show the web service user account that was used to make the change.

Application

Details the CostGuard component that executed the change.

Web Module / Web API Changes- the application represents the Web API that the change originated from. This is true whether the change was submitted via a web module or by directly calling the API.

CostGuard Client Changes – the Application is typically the back-end CostGuard Server service making the change. These are provided for system tracking and troubleshooting purposes and typical users may not be familiar with the components names that they see.

Operation

Details the Web API operation that was called to make the change. The values used match the operations documented in IDI’s Web API documentation guides.

Changes not made through a Web API interface ( and therefore have no operation value) will just repeat the value from the application field.

Audit Log Icons

C:\Users\mhol\AppData\Local\Temp\SNAGHTML4fe6549.PNG

The Audit Log icon appears on Customer Accounts, Services and Features. Clicking the icon will display a pre-filtered list of audit log records for the item being viewed. Unlike the Audit Log search there is no 30-day search restriction when viewing entries directly from an item.

Understanding Customer Audit Log Records


Sometimes it may not be apparent why some changes that impact an account get logged with an Object Type of ‘Customer’ and others do not.

Audit Log Records are tied to a customer when the change made was specifically to a property of the account. Account properties are things like account #, status or billing group and are typically what you see when you view ‘Account Details’ in Customer Care.

Creating items like Adjustments, Tickets or Journals will result in Audit Log records that are tied to those Object Types even when they are created for a specific account. Looking at a customer account a user can see all the Adjustments, Tickets or Journals that are tied to the account and therefore the existence of the item on the account itself serves as the ‘record’.