citrus-cms/resources/views/guide/document-history.md

# Document History User Guide

## What is Document History?

Document History is a tracking system that keeps a complete record of what happens to your PDF files and documents. It's like a logbook that shows who uploaded, moved, downloaded, or archived any document in the system, along with when these actions happened.

## Why is Document History Important?

### Quality Control Benefits
- **Track Changes**: See exactly when a document was updated
- **Audit Trail**: Full record of who did what and when
- **Version Control**: Know which version of a document was active at any time
- **Compliance**: Meet regulatory requirements for document tracking

### Practical Benefits
- **Find Lost Files**: Locate documents that were moved or archived
- **Accountability**: Know who made changes to critical documents
- **Recovery**: Retrieve older versions if needed
- **Planning**: Understand document update patterns

## How to Access Document History

### From Data Tables
1. **Find a PDF column** in any data table (reports, test results, etc.)
2. **Right-click** on any cell in that column
3. Look for the **"📋 Document History"** option in the menu
4. **Click** on it to open the history window

### What Columns Show History?
The system automatically detects PDF-related columns:
- Columns with "download" in the name
- Columns with "file" in the name
- Columns with "pdf" in the name
- Columns with "document" in the name
- Columns with "report" in the name
- Technology certificate columns

## Understanding the History Display

### The History Table
When you open Document History, you'll see a table with these columns:

**ID**: Unique record number for each action

**User**: Name of the person who performed the action

**Action**: What was done to the file:
- 🟢 **Upload**: New file was added to the system
- 🔵 **Download**: Someone downloaded the file
- 🟡 **Archive**: File was moved to archive storage
- 🔴 **Delete**: File was removed from the system

**File Name**: The actual name of the document

**Size**: How large the file is (in KB or MB)

**From**: Where the file was moved from (if applicable)

**To**: Where the file was moved to (if applicable)

**Date & Time**: Exactly when the action occurred

**Notes**: Additional information about what happened

**Actions**: Buttons to view or download the file

### Example History Records
```
User: John Smith
Action: Upload (🟢)
File: WPS-001-Rev02.pdf
Date: 15/01/2025 14:30
Notes: New file uploaded to server

User: Jane Doe  
Action: Archive (🟡)
File: WPS-001-Rev01.pdf
Date: 15/01/2025 14:31
Notes: File replaced with new version and archived
```

## Using the Action Buttons

### View Button (👁️)
- **Purpose**: Look at the document without downloading it
- **How it works**: Opens the PDF in a popup window
- **When to use**: Quick review, checking content, verification

### Download Button (⬇️)
- **Purpose**: Save a copy of the file to your computer
- **How it works**: Starts automatic download
- **When to use**: Need to work with the file offline, share with others

## Common Use Cases

### Finding the Latest Version
**Problem**: "I need the most recent version of this drawing"
**Solution**: 
1. Open Document History for that drawing column
2. Look at the top record (most recent)
3. Check if it's an "Upload" action
4. Use the View or Download button

### Recovering Archived Files
**Problem**: "A file disappeared from the system"
**Solution**:
1. Open Document History for that location
2. Look for "Archive" actions
3. Find the archived file in the history
4. Use Download button to get the file back

### Audit Trail
**Problem**: "Who updated this document last month?"
**Solution**:
1. Open Document History
2. Look at the Date & Time column
3. Find actions from last month
4. Check the User column to see who made changes

### Version Comparison
**Problem**: "What changed between versions?"
**Solution**:
1. Open Document History
2. Find both versions you want to compare
3. Download both using the Download buttons
4. Compare them offline

## Understanding File Movement

### Upload Process
When someone uploads a new file:
1. **New File**: Creates an "Upload" record
2. **Existing File**: 
   - Old file gets "Archive" record
   - New file gets "Upload" record
   - Old file moved to Archive folder with timestamp

### Archive Structure
Archived files are organized like this:
```
Archive/
├── Original_Folder/
│   └── File_Name_Folder/
│       ├── file_name_2025_01_15_14_30_25.pdf
│       └── file_name_2025_01_16_09_15_42.pdf
```

## Search and Filter Features

### Built-in Search
- **Search Box**: Type any text to find matching records
- **Column Filters**: Click column headers to filter by specific values
- **Date Filters**: Filter by date ranges

### Search Tips
- Search by **file name** to find all versions
- Search by **user name** to see someone's activities  
- Search by **action type** to see only uploads or downloads
- Use **date filters** to focus on specific time periods

## Best Practices

### For Regular Users
1. **Check History First**: Before asking "where's my file?", check the history
2. **Use Proper Names**: When uploading, use clear, descriptive file names
3. **Add Notes**: Some systems allow adding notes - use them to explain changes

### For Supervisors
1. **Regular Reviews**: Check document history during audits
2. **Monitor Activity**: Look for unusual patterns or missing updates
3. **Version Control**: Ensure old versions are properly archived

### For Quality Managers
1. **Audit Compliance**: Use history records for regulatory compliance
2. **Change Control**: Track document revision processes
3. **Training Records**: Monitor who accesses which documents

## Troubleshooting

### "No History Found"
**Possible Causes**:
- File was never uploaded through the system
- Looking at wrong column/location
- File was uploaded before history tracking started

**Solutions**:
- Check other related columns
- Contact system administrator
- Look for manual records

### "Download Not Working"
**Possible Causes**:
- File was moved or deleted from storage
- Network connectivity issues
- Browser blocking downloads

**Solutions**:
- Try different browser
- Check internet connection
- Contact IT support

### "History Shows Wrong Information"
**Possible Causes**:
- System time settings incorrect
- User account mixup
- Data entry error

**Solutions**:
- Report to system administrator
- Cross-check with other records
- Document the discrepancy

## Security and Permissions

### Who Can See History?
- **Read Permission**: View document history
- **Full Control**: View history + perform actions
- **Admin**: All access + system management

### Data Privacy
- All actions are logged with user identification
- Timestamps are permanent and cannot be changed
- History records are kept for audit purposes

## Getting Help

### When to Contact Support
- History showing incorrect information
- Unable to download archived files
- Need help understanding specific records
- System not tracking actions properly

### What Information to Provide
- Specific file name or document
- Date range of the issue
- What you were trying to do
- Any error messages received

## Tips for Efficiency

### Quick Actions
- **Right-click directly** on file cells for instant history
- **Use search** instead of scrolling through long lists
- **Bookmark important** document locations

### Regular Monitoring
- **Weekly reviews** of important document areas
- **Monthly audits** of archive activities
- **Quarterly reports** on document update patterns

## Summary

Document History provides complete transparency into your document management system. By tracking every upload, download, archive, and deletion, it ensures you always know what happened to your files and when. Use it regularly to maintain control over your documentation and meet quality compliance requirements.

Remember: Document History is not just a record-keeping tool - it's your safety net for document management and a powerful tool for maintaining quality control in your projects.