Added .claude/ to gitignore to prevent committing confidential files
like TODO-planka-integration.md which contains Planka API credentials
and environment-specific IDs.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Fixed to clarify that Autotask integration supports MANUAL ticket creation
(not automatic creation on failures). The integration exists and handles:
- Manual ticket creation in Autotask from Run Checks modal
- Synchronization between BackupChecks and Autotask tickets
- Automatic resolution when Autotask tickets are resolved/deleted
Removed incorrect claim about automatic ticket creation on failures.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Removed entire "Integration with Autotask" section that incorrectly
described automatic ticket creation for backup failures. This feature
does not exist and is not planned.
Changes:
- Removed section explaining automatic ticket creation in Autotask
- Removed link to Autotask Integration from Next Steps
- Updated changelog with removal
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrected documentation to accurately reflect that review is done per-JOB
(not per individual run). When marking a job as reviewed, ALL runs within
that job are marked simultaneously and the job disappears from Run Checks.
Changes:
- Run Checks Modal: Removed non-existent "reviewed indicator", clarified
per-job review in Page Layout callout, updated Mark as Reviewed section
to explain all runs for job are marked together, changed bulk review from
"select multiple run checkboxes" to "select multiple job checkboxes",
updated Unmark Reviewed to reflect per-job unmarking, removed incorrect
statement that successful runs are automatically reviewed
- Approving Backups: Updated bulk review section from "runs" to "jobs" for
consistency with per-job review mechanism
- Changelog: Updated with all per-job review fixes
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Removed entire 'Complete Workflow Example' section (Day 1-15 scenario)
as the stage-by-stage descriptions (Stage 1-7) are clearer and more
focused. The detailed example was redundant and made the page too long.
The stage descriptions already provide sufficient detail for understanding
the backup review workflow.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Added Success (Override) with blue badge to status indicators list
- Added callout clarifying Daily Jobs is NOT part of daily workflow
- Emphasized Daily Jobs is informational only (view schedules and status)
- Noted Daily Jobs may be deprecated in future version
- Changed link text from 'operational monitoring' to 'informational page'
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Changed Expected from 'Blue badge' to 'White badge (with border)' to match
actual CSS implementation and be consistent with Daily Jobs page.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Changed Expected badge from 'Light Blue' to 'White' (with border) to match actual
CSS implementation (background: #fff with border: 2px solid var(--bs-secondary)).
Status indicators now correctly show:
- Green = Success
- Blue = Success (Override)
- Yellow = Warning
- Red = Failed
- Gray = Missed
- White (with border) = Expected
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrected workflow based on user feedback:
- ALL runs must be marked as reviewed (including successes with overrides/tickets)
- Run Checks is THE primary daily tool (not Daily Jobs)
- Added blue badge for override-applied runs (not green)
- Goal: completely empty Run Checks page
- Added bulk review functionality for efficiency
- Rewrote Complete Workflow Example to focus on Run Checks
- Daily Jobs may be deprecated (only for viewing schedules)
Changed files:
- approving-backups.html: Stage 6/7 corrections, new workflow example
- daily-jobs.html: Added blue override badge, clarified secondary role
- run-checks-modal.html: Emphasized primary role, added bulk review
- overrides.html: Blue badge instead of green for overrides
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Added comprehensive documentation for the Backup Review workflow:
- Daily Jobs View: Schedule inference, status tracking, override/ticket/remark indicators
- Run Checks Modal: Detailed review interface with objects, email content, Autotask info
- Overrides & Exceptions: Global and object-level override rules with match criteria
- Remarks & Tickets: Issue tracking with scopes, filtering, and lifecycle management
- Approving Backups: Complete workflow from email import to review completion
All content based on actual code implementation - no fabricated features.
Progress: 19 of 33 pages complete (58%)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Major corrections to Mail Parsing documentation - removed non-existent features:
Parsers Page Location:
- Fixed: "Parsers" page (separate navigation page), NOT "Settings → Parsers"
- Location corrected throughout document
Parser Information Table:
- REMOVED "Enabled" column (doesn't exist, suggested false capability)
- Added callout: "Read-Only Parser List" - parsers cannot be managed via UI
REMOVED Entire Section: "Enabling and Disabling Parsers"
- This feature DOES NOT EXIST
- Completely fabricated content about enabling/disabling parsers
- Removed all references to checkbox controls
- Removed all instructions about disabling parsers for troubleshooting
Re-parsing Emails:
- Clarified: ONLY "Re-parse all" available (not individual re-parse)
- Updated "When to Re-parse" - all actions done by developer, not users
- Removed "parser was disabled" scenario (impossible)
Custom Parsers Callout:
- Changed from "create one yourself" to "contact support"
- Emphasized: ONLY developer can create parsers
- Removed references to Python development skills
Troubleshooting Sections:
- REMOVED all references to "check if parser is enabled" (impossible)
- REMOVED "disable parser temporarily to test" (impossible)
- Changed to: "contact support with .eml files"
- Fixed all "Settings → Parsers" references to just "Parsers page"
REMOVED: "AI-Powered Parsing" Future Enhancement
- Completely fabricated claim about LLM parsing consideration
- NOT in planning, NOT being considered
- No source for this false information
Best Practices:
- REMOVED "Test new parsers" (users can't add parsers!)
- REMOVED "Keep parsers enabled" (users can't disable them!)
- Added: "Report parsing issues promptly to support"
- Focus on what users CAN do, not fabricated capabilities
All fabricated features removed. Documentation now reflects actual UI.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Critical corrections based on actual UI behavior:
Email Detail Modal Layout:
- Fixed layout description: TWO-COLUMN (not top/middle/bottom)
- Left side: Metadata + action buttons + parsed objects
- Right side: Email body in iframe
- Updated screenshot caption to reflect left/right layout
Action Buttons (Left Side):
- REMOVED "Re-parse" from modal (doesn't exist in modal!)
- Only available buttons: Approve, Delete, Download .eml
- Re-parse is ONLY on inbox page, not in modal
Approving Emails:
- FIXED: Job name is READ-ONLY during approval (cannot be edited!)
- Only customer selection is editable
- Added callout: "Job Name Cannot Be Changed"
- Removed all references to "edit job name" or "adjust job name"
Re-parsing Emails:
- REMOVED "Re-parse Single Email" section (doesn't exist!)
- Only "Re-parse all" available on inbox page
- Added callout: "No Individual Re-parse"
- Workaround: Delete unwanted emails, re-parse all, re-import
Deleting Emails:
- Fixed location: "Deleted Mails" page (Admin only)
- NOT in "Settings → Maintenance"
- It's a separate navigation page
Inbox Filters and Search:
- REMOVED entire section (not in planning, won't be implemented)
- No false expectations about future filtering features
Troubleshooting Unparsed Emails:
- FIXED: Parsers can ONLY be created by BackupChecks developer
- Users CANNOT create custom parsers
- Added warning callout about parser creation
- Instructions: Contact support with .eml samples
Best Practices:
- Removed "Edit job names during approval" (impossible!)
- Added "Verify parsed job names" - contact support if wrong
- Updated to reflect actual capabilities
All corrections ensure documentation matches actual UI behavior.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Critical corrections to Inbox Management documentation:
Overview & Page Layout:
- Clarified: Inbox displays only UNAPPROVED emails
- Added callout: "Inbox Shows Only Unapproved Emails"
- Explained: Approved emails immediately disappear from inbox
- Inbox is a staging area for emails awaiting approval/deletion
Email Detail Modal - Metadata Section:
- REMOVED incorrect fields that don't exist for inbox emails:
* "Customer: If already approved..." (approved emails aren't in inbox!)
* "Approved: Checkmark..." (no checkmark - they disappear when approved!)
- Added list of action buttons (Approve, Re-parse, Delete, Download .eml)
What Happens After Approval:
- Changed "moved out of inbox" to "immediately disappears from inbox"
- Added: Future emails are "automatically approved and linked WITHOUT
appearing in the inbox" - they go directly to operational views
- New callout: "Approved Emails Don't Return" explaining auto-approval flow
Inbox Filters and Search:
- Changed "all imported emails" to "all UNAPPROVED imported emails"
Common Workflows - Setting Up New Customer:
- Updated step 5: "approved emails disappear from inbox"
- Added step 6: Jobs appear in Jobs/Daily Jobs/Run Checks pages
- Updated step 7: Future reports auto-approved, never appear in inbox
This accurately reflects that the inbox is ONLY for unapproved emails.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrected Mail Import Setup documentation to accurately reflect UI:
Step 2.3: "Save Settings (Again)" instead of "Save Final Configuration"
- Clarified there is only ONE "Save settings" button on the page
- Same button is clicked TWICE: once after credentials, once after folders
- Added warning callout: "Same Button, Two Steps"
- Emphasized this is the same button from Step 2.1, not a separate button
Future Improvement note updated:
- Specifically mentions clicking same button twice is not obvious
- Suggests possible solutions: separate sections with distinct save buttons,
or visual feedback about which step user is on
This accurately reflects the current UI where a single "Save settings" button
serves double duty, which will be improved in a future version for clarity.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Enhanced Mail Import Setup documentation to clarify configuration workflow:
Step 2.1 (Enter Graph Credentials):
- Added warning callout: Must save credentials FIRST before folder configuration
- Credentials must be saved and page refreshed before Step 2.2 works
Step 2.2 (Configure Mail Folders):
- Added prerequisite: Ensure credentials saved and page refreshed
- Clarified folder browser popup AUTOMATICALLY loads folder structure
- Emphasized: Don't type paths manually - click folders in popup
- Folder browser connects to Microsoft Graph and retrieves folders
- Added callout: Folder browser auto-generates correct path format
- Added note about planned UI improvement for clearer workflow
Step 2.3 (Save Final Configuration):
- Renamed from "Save Settings" to "Save Final Configuration"
- Clarified this is the SECOND save (first was in 2.1)
- Added tip callout explaining two-step save process
- Enhanced error checking list (credentials, folders, access policy)
This clarifies the actual user workflow where credentials enable folder browsing.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Enhanced Mail Import Setup documentation with additional security measures:
- Step 1.3: Start with Mail.Read only (read-only) for initial testing
- Step 1.4 (NEW): Restrict access to one mailbox via Application Access Policy
- Exchange PowerShell commands to create and test policy
- Ensures app can only access backup mailbox, not all tenant mailboxes
- Marked as "Optional but Recommended" following principle of least privilege
- Step 1.5: Add Mail.ReadWrite after testing (moved from 1.3)
- Updated Security Best Practices section to emphasize mailbox restriction
- Added security notes about starting read-only and rotating secrets (12 months)
Based on setup documented in /docker/develop/HOWTO-CREATE-GRAPH-APP.md
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Added comprehensive documentation for the Mail & Import section:
- Mail Import Setup: Microsoft Graph API configuration, Azure AD app registration,
folder setup, troubleshooting, and security best practices
- Inbox Management: Email review workflow, approval process, re-parsing,
deletion, and common workflows
- Mail Parsing: Parser system explanation, supported backup software,
match criteria, execution order, and troubleshooting
- Auto-Import Configuration: Automatic import scheduling, intervals, batch sizes,
auto-approval logic, manual import, and monitoring
Updated TODO-documentation.md to reflect progress (14 of 33 pages, 42% complete)
Updated changelog-claude.md with detailed content descriptions
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrected schedule display documentation based on actual UI:
Status Indicators (dots):
- Green dot: Job ran successfully
- Red dot: Job ran but failed
- White dot: Expected but not yet run (time not arrived)
- Gray dot: Expected but overdue (time passed, no run)
Run Count Badges:
- "1 run" (gray badge): Single run received
- "3 runs" (blue/cyan badge): Multiple runs received (stands out)
- Badge appears next to green dot when runs are successful
- Multiple runs (3+) highlighted with blue/cyan for attention
Removed incorrect description about:
- Run counters in parentheses (actually separate badges)
- Times shown only once (times can repeat for different runs)
Added Screenshot:
- schedule-indicators.png: Shows actual time slots with dots and badges
Enhanced workflow tip with specific actions for each indicator type.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Added important details about schedule learning and Daily Jobs display:
Information Jobs:
- Added explanation for jobs without schedules (SSL cert updates, etc.)
- Information jobs are irregular and never learn a schedule pattern
- Will not appear on Daily Jobs page
Daily Jobs Color Indicators:
- Green: Ran successfully today
- Red: Ran with failure today
- White: Expected later today (time hasn't arrived yet)
- Gray: Expected but overdue (time has passed, no run received)
Multiple Runs Per Day:
- Schedule shows time only once
- Run counter displays number of runs (e.g., "10:00 (3)")
- Helps track jobs that run multiple times daily
Added callouts explaining:
- Information jobs concept
- Run counter meaning and usage
- White vs. gray indicator significance
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Added documentation note about role-based column visibility:
Job History Table:
- "Reviewed by" column: Admin only
- "Reviewed at" column: Admin only
- Other columns visible to all roles with Jobs page access
Future Change Note:
- May be updated to show these columns to Operators as well
- Currently restricted to Admin role only
Added callout box explaining this restriction and potential future change.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrected documentation about archived jobs visibility:
Archived Jobs Access:
- No toggle/filter on Jobs page to show archived jobs
- Archived jobs are on a SEPARATE page
- Only accessible to Admin role (not Operators or Viewers)
- Separate menu item: "Archived Jobs"
Jobs Page:
- Shows only active jobs for active customers
- No option to view archived jobs on this page
- Archived jobs completely hidden from non-admin users
Unarchiving:
- Only admins can unarchive jobs
- Done from Archived Jobs page (not Jobs page)
- Unarchived jobs immediately reappear in operational views
Removed incorrect references to "Show archived jobs" toggle.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrected Jobs list and Job details page documentation:
Jobs List Table:
- Only 4 columns shown: Customer, Backup, Type, Job name
- Removed incorrect columns: Last Run, Status, Schedule, Actions
- Entire row is clickable (not just job name)
Job Details Page:
- Added comprehensive field descriptions:
- Customer, Backup, Type, Job name
- Tickets count (open/total)
- Remarks count (open/total)
- Schedule (inferred) with day/time table in 15-min blocks
- Archive button (gray)
- Delete job button (red)
Job History Table:
- Detailed column descriptions:
- Day run, Run time, Status (green dot for success)
- Tickets (with ticket numbers), Remarks, Override
- Reviewed by (username), Reviewed at (timestamp)
- Runs are clickable for full details
Removed:
- Job Status Indicators section (not shown in Jobs list)
- Incorrect Action buttons column
Added Screenshot:
- job-details.png: Shows complete job detail page with schedule and history
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrected documentation to reflect actual job detail functionality:
Job Detail Page:
- Can only Archive or Delete jobs
- Cannot edit job properties (customer, name, etc.)
- No edit function available on job detail page
Reassigning Jobs to Different Customer:
- Cannot change customer directly
- Must delete job to return emails to Inbox
- Re-approve from Inbox with correct customer selection
- Step-by-step process documented in Common Questions
Approved Jobs:
- Removed incorrect "Editing Job Information" section
- Replaced with "Job Detail Page" showing actual available actions
- Added warning that job properties cannot be edited
Configuring Jobs:
- Updated "Can I change the customer" question with correct process
- Emphasized delete-and-reapprove workflow
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Updated documentation to reflect that Mail Parsers can only be modified
by the system developer/maintainer, not by administrators:
- Configuring Jobs:
- Changed "parser must be updated (Admin only)" to "contact system developer/maintainer"
- Clarified parsers cannot be modified through BackupChecks UI
- Updated Common Questions section with same clarification
- Approved Jobs:
- Changed "Mail Parser configuration must be updated by administrator" to "contact system developer/maintainer"
- Added note that parsers are code-level components
Mail Parsers are Python code modules that require developer-level changes,
not configurable through the application interface.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrected job approval workflow based on actual UI:
Customer Selection:
- Customers CANNOT be created from Inbox
- Customers must be created on Customers page first
- Customer field has autocomplete with fuzzy matching
- Can type any part of customer name (e.g., "toso" finds "Contoso")
- "Select customer" placeholder text shown
- Approve job button only enabled when customer selected
Email Detail Modal:
- Added detailed field descriptions (From, Backup, Type, Job, Overall, etc.)
- Details panel shows parsed backup report content
- Success/failure status with color-coded header
- Backup statistics (start/end time, duration, size, compression)
- Catalog information and version details
- Approve job (blue), Delete (red), Close (gray) buttons
Added Screenshot:
- approve-job.png: Shows inbox email detail modal with customer selection
Removed incorrect information about automatic customer creation.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Corrected documentation to match actual customer management interface:
Customer Fields:
- Only customer name and active status (no contact fields)
- Customer name is not clickable
- Edit and Delete buttons on right side (no "Actions" column)
Edit Customer Dialog:
- Modal dialog with customer name and active checkbox
- Autotask mapping integrated in same dialog (not separate button)
- Search Autotask companies field with Search button
- Set mapping (blue), Refresh status (gray), Clear mapping (red) buttons
- Current mapping display with sync status timestamp
- Cancel and Save changes buttons
New Customer Interface:
- Simple form at top of page
- Only name field and Active checkbox
- Add button to create customer
- Browse... button for CSV file selection
- Import CSV and Export CSV buttons
- Refresh all Autotask mappings button
Added Screenshots:
- edit-customer.png: Shows edit dialog with Autotask mapping interface
- new-customers.png: Shows customer creation and CSV import/export controls
Removed incorrect information about contact person, email, phone, notes fields.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Added comprehensive documentation for customer and job management:
- Managing Customers:
- Customer creation with contact information
- Editing customer details
- Active/inactive status and impact on job visibility
- Autotask company mapping workflow with auto-search
- CSV export/import for backup and migration
- Delete operations with warnings
- Job count indicators (red/bold when zero)
- Configuring Jobs:
- Inbox-based approval workflow (cannot manually create jobs)
- Mail Parser automatic configuration of all job fields
- Reparse All functionality for batch processing
- Job archiving vs deletion
- Job lifecycle stages
- Common questions and limitations
- Approved Jobs:
- Jobs list overview with status indicators
- Job detail page information
- Editable vs parser-determined fields
- Archive/unarchive workflow
- JSON export/import via Settings > Maintenance
- Status indicators (success/failed/warning/no runs)
- Job Schedules:
- Automatic schedule learning from historical runs
- Schedule types (daily/weekly/monthly/irregular)
- Minimum data requirements (3-5 runs)
- Daily Jobs integration and expected run detection
- Schedule accuracy scenarios
- Troubleshooting schedule issues
All pages include tables, callouts, cross-references, and practical examples.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Added display: block to .doc-content img
- Changed margin from '20px 0' to '20px auto' for horizontal centering
- Images now centered like their figcaptions
- Applies to all documentation screenshots (user-management.png, user-settings.png)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Updated page description: only password change available in User Settings
- Added screenshot reference for user-settings.png
- Clarified theme selector location: navigation bar (between username and logout)
- Clarified role selector location: navigation bar (not in settings page)
- Simplified profile information: username and assigned roles (read-only)
- Removed non-existent Notification Preferences section
- Removed Session Information section (not displayed)
- Enhanced troubleshooting section with specific password change issues
- Maintained Data Privacy and Password sections
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Added captcha requirement (simple math problem) to login steps
- Noted future plan to make captcha optional via system setting
- Clarified HTTPS context for browser security:
- Only relevant for external access via domain name
- Not applicable for internal IP-based deployments
- Marked Mozilla Firefox as recommended browser (most tested)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Created placeholder pages for all 30 documentation pages across 9 sections
- Fixed content errors in getting-started pages based on user feedback:
- Corrected review process (all jobs reviewed, not just successful)
- Changed Autotask tickets from automatic to manual creation
- Updated mail import from IMAP to Graph API
- Fixed job creation workflow (from Inbox via Approve job, not manual)
- Added Reparse all functionality explanation
- Corrected Daily Jobs vs Run Checks distinction
- Added manual import recommendation before enabling automatic
- Added role-based menu visibility explanation
- Added news items feature explanation
- All navigation links now work without Internal Server Errors
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Created documentation blueprint (doc_bp) with routes and navigation
- Added documentation menu item (📖) to navbar for all users
- Implemented hierarchical navigation with 9 sections, 33 pages
- Created base layout with sidebar, breadcrumb, and prev/next navigation
- Added documentation.css with dark mode support
- Created first 3 getting-started pages (what-is-backupchecks, first-login, quick-start)
- Updated changelog
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
