Change History Module Documentation

Module Overview (Technical)
Module Overview (Commercial/Business)
Module Overview (End User/Administrator)
Change Fields Reference
Common Scenarios & Examples
Limitations & Important Notes
Troubleshooting Tips
Glossary

---

1. Module Overview (Technical)

What Is Change History?

Change History is a configuration change tracking module that records all modifications to system configuration. Unlike Audit Logs (which tracks all activity including logins), Change History focuses specifically on CREATE, UPDATE, and DELETE operations, storing the actual data changes (before/after values).

Architecture

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│                 Change History Architecture                     │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Configuration Change                                           │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Any Module (Extensions, Gateways, Routes, etc.)   │   │
│  │                                                          │   │
│  │  Before:                          After:                 │   │
│  │  ├─ Name: "John Doe"              ├─ Name: "Jane Doe"   │   │
│  │  ├─ Number: 1001                  ├─ Number: 1001       │   │
│  │  └─ Enabled: true                 └─ Enabled: false     │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Logged with old/new values                             │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        public.change_history                             │   │
│  │                                                          │   │
│  │  | action | resource | user | old_values | new_values | │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Displayed in Viewer                                     │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Change History Page                               │   │
│  │                                                          │   │
│  │  ┌─────────────────────────────────────────────────────┐ │   │
│  │  │Time   │Action │Resource│User │ Changes            │ │   │
│  │  ├───────┼───────┼────────┼─────┼────────────────────┤ │   │
│  │  │10:30  │UPDATE │extensn │admin│ Name: John→Jane    │ │   │
│  │  │       │       │        │     │ Enabled: true→false│ │   │
│  │  └─────────────────────────────────────────────────────┘ │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

Table	Purpose
`public.change_history`	Configuration change records

Key Files

File	Description
`modules/changeHistory/`	Frontend module
`modules/changeHistory/api/changeHistoryApi.ts`	API calls
`modules/changeHistory/types/changeHistory.types.ts`	Type definitions

---

2. Module Overview (Commercial/Business)

Business Value

Change History provides configuration visibility:

Without Change History	With Change History
Unknown who changed what	Full attribution
Lost previous settings	Before/after values
Can't undo changes	Reference old values
No change documentation	Complete record

Use Cases

Configuration Recovery

- Find previous settings

- Reference old values

Troubleshooting

- "What changed?"

- Identify breaking changes

Accountability

- Who made the change

- When it was changed

Auditing

- Review configuration changes

- Compliance documentation

Feature Highlights

Feature	Benefit
Before/After	See exact changes
User Attribution	Know who changed
Resource Tracking	What was modified
Date Filtering	Find by time
User Filtering	Find by person
Action Filtering	Create/Update/Delete

---

3. Module Overview (End User/Administrator)

What Can You Do?

View all configuration changes
See before and after values
Filter by date range
Filter by action type
Filter by resource type
Filter by user
Search across changes

Change History Interface

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Change History                                     │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Filters:                                                       │
│  ├─ Range: [Today ▼]                                           │
│  ├─ Actions: [All Actions ▼]                                   │
│  ├─ Resource: [                    ]                           │
│  ├─ User: [All Users ▼]                                        │
│  └─ [🔄 Refresh] [Clear Filters]                               │
│                                                                 │
│  🔍 [Search by action, resource, or user...              ]     │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Time     │Action │Resource  │Res ID│ User  │Changes      │  │
│  ├──────────┼───────┼──────────┼──────┼───────┼─────────────┤  │
│  │ 10:30    │Update │extension │ 123  │ admin │ [View ▼]    │  │
│  │          │       │          │      │       │ Name: J→J   │  │
│  │          │       │          │      │       │ Ena: T→F    │  │
│  │ 10:28    │Create │user      │ 456  │ admin │ [View ▼]    │  │
│  │ 10:25    │Delete │gateway   │ 789  │ super │ [View ▼]    │  │
│  │ 10:20    │Update │queue     │ 101  │ admin │ [View ▼]    │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
│  Showing 1-25 of 567 records                                    │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Change Details View

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Change Details                                     │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Resource: extension #123                                       │
│  Action: UPDATE                                                 │
│  User: admin@company.com                                        │
│  Date: 2026-01-16 10:30:45                                     │
│  IP: 192.168.1.100                                             │
│                                                                 │
│  ┌─────────────────────────────────────────────────────────────┐│
│  │ Field              │ Old Value      │ New Value           ││
│  ├────────────────────┼────────────────┼─────────────────────┤│
│  │ effective_name     │ John Doe       │ Jane Doe            ││
│  │ enabled            │ true           │ false               ││
│  │ forward_enabled    │ false          │ true                ││
│  │ forward_destination│ (empty)        │ 1002                ││
│  └─────────────────────────────────────────────────────────────┘│
│                                                                 │
│  [Close]                                                        │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP

View Changes: Click "View Changes" to see old/new values side-by-side.

TIP

Recovery: Use before values to restore previous configuration.

NOTE

Data Changes Only: Login/logout not tracked here (see Audit Logs).

---

4. Change Fields Reference

Display Columns

Column	Description
ID	Unique change ID
Timestamp	When change occurred
Action	Create/Update/Delete
Resource	Type of object
Resource ID	Specific record ID
User	Who made the change
IP Address	Source IP
Changes	View details button

Action Types

Action	Description
Create	New record created (new values only)
Update	Record modified (old + new values)
Delete	Record removed (old values only)

Change Details

Field	Description
Field Name	What was changed
Old Value	Previous value
New Value	Current value

---

5. Common Scenarios & Examples

Scenario 1: Find What Changed on Extension

Filter Resource by "extension"
Search for extension number
View change history
Click "View Changes" for details

Scenario 2: Recover Old Setting

Find the UPDATE record
View Changes
Note the Old Value
Manually restore if needed

Scenario 3: Investigate Breaking Change

Set date range to when issue started
Filter by relevant resource type
Review recent changes
Identify problematic change

Scenario 4: User Change Audit

Filter by specific User
Set date range
Review all their changes
Export if needed

---

6. Limitations & Important Notes

Technical Notes

NOTE

Configuration Only: Tracks data changes, not logins/access.

NOTE

Read-Only: History cannot be modified.

WARNING

Sensitive Data: Old values may contain passwords (masked).

Comparison: Change History vs Audit Logs

Feature	Change History	Audit Logs
Focus	Data changes	All activity
Actions	Create/Update/Delete	All actions + Login
Values	Before/After stored	Metadata only
Purpose	Config recovery	Compliance

Best Practices

Review Regularly: Check for unexpected changes
Filter Smart: Use resource type to narrow results
Document Rollbacks: Record manual reversions
Archive Important: Export critical change records
Use for Recovery: Reference old values carefully

---

7. Troubleshooting Tips

Common Issues

Symptom	Possible Cause	Solution
No records	Too restrictive filter	Clear filters
Missing change	Not tracked resource	Some resources may not be tracked
Values masked	Sensitive fields	Passwords intentionally hidden
Slow loading	Large date range	Reduce date range
No old values	CREATE action	Creates only have new values

Diagnostic SQL

Recent configuration changes:

Sql

SELECT 
  timestamp,
  action,
  resource,
  resource_id,
  user_email,
  old_values,
  new_values
FROM public.change_history
ORDER BY timestamp DESC
LIMIT 50;

Changes by resource type:

Sql

SELECT 
  resource,
  action,
  COUNT(*) as count
FROM public.change_history
WHERE timestamp >= NOW() - INTERVAL '7 days'
GROUP BY resource, action
ORDER BY count DESC;

---

8. Glossary

Term	Definition
Change	Single configuration modification
Old Value	Previous field value
New Value	Current field value
Resource	Type of configuration object
Resource ID	Specific record identifier
Diff	Difference between old/new

---

Lua Script Status ℹ️

No Lua Handler Required

Component	Status
Change History	ℹ️ Backend-logged - recorded by API when data changes

Change History is a frontend reporting module. Change logging is performed automatically by the backend when configuration changes are made via the API. No Lua handlers are used.

---

Documentation last updated: January 2026

Change History Module Documentation

Table of Contents

1. Module Overview (Technical)

What Is Change History?

Architecture

Key Tables

Key Files

2. Module Overview (Commercial/Business)

Business Value

Use Cases

Feature Highlights

3. Module Overview (End User/Administrator)

What Can You Do?

Change History Interface

Change Details View

Quick Tips

4. Change Fields Reference

Display Columns

Action Types

Change Details

5. Common Scenarios & Examples

Scenario 1: Find What Changed on Extension

Scenario 2: Recover Old Setting

Scenario 3: Investigate Breaking Change

Scenario 4: User Change Audit

6. Limitations & Important Notes

Technical Notes

Comparison: Change History vs Audit Logs

Best Practices

7. Troubleshooting Tips

Common Issues

Diagnostic SQL

8. Glossary

Lua Script Status ℹ️

No Lua Handler Required