Fax Viewer Module Documentation

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

---

1. Module Overview (Technical)

What Is Fax Viewer?

Fax Viewer is a log viewing interface that displays all inbound and outbound fax transmissions. It provides searchable access to fax history, status information, and the ability to view or download fax documents.

Architecture

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│                    Fax Viewer Architecture                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Admin Panel                                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        FaxViewerPage.tsx                                 │   │
│  │                                                          │   │
│  │  ┌─────────────────────────────────────────────────────┐ │   │
│  │  │ Date       │ Dir   │ Device │ Remote   │ Pages │ Status│ │   │
│  │  ├─────────────────────────────────────────────────────┤ │   │
│  │  │ 2026-01-16 │ ← IN  │ Main   │ +1555123 │  3    │ ✓    │ │   │
│  │  │ 2026-01-16 │ → OUT │ Sales  │ +1555456 │  2    │ ✓    │ │   │
│  │  │ 2026-01-15 │ ← IN  │ Main   │ +1555789 │  1    │ ✗    │ │   │
│  │  └─────────────────────────────────────────────────────┘ │   │
│  │                                                          │   │
│  │  [View] [Download] [Delete]                              │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ API Query                                               │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Backend API                                       │   │
│  │                                                          │   │
│  │  SELECT * FROM public.fax_logs                           │   │
│  │  WHERE domain_id = ?                                     │   │
│  │  ORDER BY created_at DESC                                │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

Table	Purpose
`public.fax_logs`	Fax transmission history
`public.fax_devices`	Device reference

Key Files

File	Description
`modules/faxViewer/FaxViewerPage.tsx`	Main viewer page
`modules/faxViewer/api/faxViewerApi.ts`	API calls
`modules/faxViewer/hooks/useFaxLogs.ts`	Data hook

---

2. Module Overview (Commercial/Business)

Business Value

Fax Viewer provides complete fax history:

Without Fax Viewer	With Fax Viewer
No transmission history	Full audit trail
Unknown status	Success/failure visible
No document access	View/download documents
Manual tracking	Searchable logs

Use Cases

Audit Trail

- Track all fax activity

- Compliance documentation

Troubleshooting

- Identify failed transmissions

- Review error messages

Document Retrieval

- Find past faxes

- Download for records

Status Monitoring

- Check delivery status

- Confirm receipt

Feature Highlights

Feature	Benefit
Search	Find faxes quickly
Direction Filter	Inbound/Outbound
Status Display	Success/Failed
Document View	Preview faxes
Download	Save to local
Delete	Clean up history

---

3. Module Overview (End User/Administrator)

What Can You Do?

View all fax transmissions
Search by number or caller ID
Filter by direction
View document content
Download fax files
Delete old logs

Fax Viewer Interface

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Fax Viewer                                         │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  🔍 [Search faxes by number or caller ID...        ]           │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Date        │ Dir      │ Device   │ Remote     │Pgs│Status│  │
│  ├─────────────┼──────────┼──────────┼────────────┼───┼──────┤  │
│  │ 01/16 10:30 │ Received │ Main Fax │+15551234567│ 3 │  ✓   │  │
│  │ 01/16 09:15 │ Sent     │ Sales    │+15559876543│ 2 │  ✓   │  │
│  │ 01/15 16:45 │ Received │ Main Fax │+15555551234│ 1 │  ✗   │  │
│  │ 01/15 14:20 │ Sent     │ Support  │+15557771234│ 4 │  ✓   │  │
│  │ 01/15 11:00 │ Received │ Main Fax │+15558881234│ 2 │  ✓   │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
│  Row Actions: [👁️ View] [⬇️ Download] [🗑️ Delete]               │
│                                                                 │
│  Showing 1-10 of 156 faxes                                      │
│  [< Previous] [Next >]                                          │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP

Search: Search by phone number or remote caller ID.

TIP

Download PDF: Successfully received faxes can be downloaded as PDF.

CAUTION

Delete: Deleting a log removes the document permanently.

---

4. Log Fields Reference

Display Columns

Column	Description
Date	Transmission date/time
Direction	Received (inbound) or Sent (outbound)
Device	Fax device used
Remote	Remote fax number
Pages	Number of pages
Status	Success or Failed
Size	File size

Direction Types

Direction	Icon	Description
Received	←	Inbound fax
Sent	→	Outbound fax

Status Types

Status	Description
Success	Transmission completed
Failed	Transmission failed

Available Actions

Action	Description
View	Open fax document
Download	Save file locally
Delete	Remove log and file

---

5. Common Scenarios & Examples

Scenario 1: Find Recent Fax

Open Fax Viewer
Look at recent entries
Click View to preview
Download if needed

Scenario 2: Search for Specific Sender

Enter phone number in search
Results filter automatically
View matching faxes

Scenario 3: Check Failed Transmissions

Look for failed status entries
Review error details
Retry if outbound

Scenario 4: Archive Faxes

Download important faxes
Save to local storage
Delete from system

---

6. Limitations & Important Notes

Technical Notes

NOTE

Read-Only Logs: This module views logs only. Sending is done via Send Fax module.

NOTE

File Storage: Documents stored on server filesystem.

WARNING

Delete Permanent: Deleting removes both log and document file.

Best Practices

Regular Review: Check for failed transmissions
Archive Important: Download critical faxes
Clean Up: Delete old unnecessary logs
Search Smart: Use full phone numbers

---

7. Troubleshooting Tips

Common Issues

Symptom	Possible Cause	Solution
No logs shown	No fax activity	Wait for fax transmissions
View fails	File deleted	File may have been cleaned up
Download fails	File missing	Check storage path
Search no results	Wrong format	Try full number with country code

Diagnostic SQL

View recent fax logs:

Sql

SELECT 
  fl.direction,
  fl.remote_number,
  fl.pages,
  fl.success,
  fl.result_text,
  fl.file_path,
  fd.name as device_name,
  fl.created_at
FROM public.fax_logs fl
JOIN public.fax_devices fd ON fl.fax_device_id = fd.id
WHERE fl.domain_id = [domain_id]
ORDER BY fl.created_at DESC
LIMIT 20;

Count by status:

Sql

SELECT 
  success,
  COUNT(*) as count
FROM public.fax_logs
WHERE domain_id = [domain_id]
GROUP BY success;

---

8. Glossary

Term	Definition
Fax Log	Record of fax transmission
Inbound	Received fax
Outbound	Sent fax
Remote Number	Other party's fax number
Pages	Document page count
TIFF	Fax document format

---

Lua Script Status ℹ️

No Lua Handler Required

Component	Status
Fax Viewer	ℹ️ Frontend-only module - reads from `public.fax_logs` via API

Fax Viewer is a React-based frontend module. Logs are queried via the backend API. No Lua handlers are used - fax logging is done by fax_receive.lua and fax_send.lua.

---

Documentation last updated: January 2026