Remove fabricated parser management features from Mail Parsing docs
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>
This commit is contained in:
parent
8bbdb86f79
commit
258aff8ffb
@ -43,7 +43,7 @@
|
|||||||
<p>To see all available parsers:</p>
|
<p>To see all available parsers:</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>Navigate to <strong>Settings</strong> → <strong>Parsers</strong> (Admin only)</li>
|
<li>Navigate to the <strong>Parsers</strong> page in the main navigation menu (Admin only)</li>
|
||||||
<li>The parsers page shows a table with all parsers and their configuration</li>
|
<li>The parsers page shows a table with all parsers and their configuration</li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
@ -79,13 +79,14 @@
|
|||||||
<td><strong>Order</strong></td>
|
<td><strong>Order</strong></td>
|
||||||
<td>Evaluation order (lower numbers are checked first)</td>
|
<td>Evaluation order (lower numbers are checked first)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td><strong>Enabled</strong></td>
|
|
||||||
<td>Checkbox to enable/disable this parser</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
<div class="doc-callout doc-callout-info">
|
||||||
|
<strong>💡 Read-Only Parser List:</strong><br>
|
||||||
|
The Parsers page is for viewing parser information only. Parsers cannot be enabled, disabled, or modified through the UI. Parser management is handled by the BackupChecks developer.
|
||||||
|
</div>
|
||||||
|
|
||||||
<h2>Match Criteria</h2>
|
<h2>Match Criteria</h2>
|
||||||
|
|
||||||
<p>Parsers use <strong>match criteria</strong> to determine if an email matches their expected format. Common criteria include:</p>
|
<p>Parsers use <strong>match criteria</strong> to determine if an email matches their expected format. Common criteria include:</p>
|
||||||
@ -173,8 +174,8 @@
|
|||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<div class="doc-callout doc-callout-info">
|
<div class="doc-callout doc-callout-info">
|
||||||
<strong>💡 Custom Parsers:</strong><br>
|
<strong>💡 Requesting New Parsers:</strong><br>
|
||||||
If your backup software is not listed, you can request a custom parser or create one yourself if you have Python development skills. Parser code is located in <code>backend/app/parsers/</code>.
|
If your backup software is not listed, contact BackupChecks support to request a new parser. Provide sample emails (.eml files) to help the developer create the parser. Parsers can only be created by the BackupChecks developer.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<h2>Parser Execution Order</h2>
|
<h2>Parser Execution Order</h2>
|
||||||
@ -216,30 +217,6 @@
|
|||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<h2>Enabling and Disabling Parsers</h2>
|
|
||||||
|
|
||||||
<p>You can enable or disable individual parsers without deleting them. This is useful when:</p>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>You temporarily don't need emails from a specific backup software</li>
|
|
||||||
<li>A parser is matching emails incorrectly (disable it while troubleshooting)</li>
|
|
||||||
<li>You're testing a new parser (disable the old one to force the new one to match)</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h3>How to Disable a Parser</h3>
|
|
||||||
|
|
||||||
<ol>
|
|
||||||
<li>Navigate to <strong>Settings</strong> → <strong>Parsers</strong></li>
|
|
||||||
<li>Find the parser you want to disable</li>
|
|
||||||
<li>Uncheck the <strong>Enabled</strong> checkbox</li>
|
|
||||||
<li>The parser will no longer be evaluated for new emails</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
<div class="doc-callout doc-callout-warning">
|
|
||||||
<strong>⚠️ Impact of Disabling:</strong><br>
|
|
||||||
Disabling a parser affects <strong>future email parsing</strong> only. Already-parsed emails are not affected. If you disable a parser, emails that would have matched it will remain unparsed (blank backup software and job name).
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<h2>Re-parsing Emails</h2>
|
<h2>Re-parsing Emails</h2>
|
||||||
|
|
||||||
<p>If parsing fails or produces incorrect results, you can re-parse emails after fixing the issue.</p>
|
<p>If parsing fails or produces incorrect results, you can re-parse emails after fixing the issue.</p>
|
||||||
@ -247,17 +224,19 @@
|
|||||||
<h3>When to Re-parse</h3>
|
<h3>When to Re-parse</h3>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>A parser was disabled when the email was imported</li>
|
<li>A new parser was added by the developer for previously unsupported software</li>
|
||||||
<li>A new parser was added for previously unsupported software</li>
|
<li>Parser code was updated by the developer to fix a bug or improve extraction</li>
|
||||||
<li>Parser code was updated to fix a bug</li>
|
<li>Parser match criteria were adjusted by the developer</li>
|
||||||
<li>Match criteria were adjusted</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>How to Re-parse</h3>
|
<h3>How to Re-parse</h3>
|
||||||
|
|
||||||
|
<p>Re-parsing is only available for all inbox emails at once:</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li><strong>Single email:</strong> Open the email detail modal in the inbox and click <strong>Re-parse</strong></li>
|
<li>Navigate to the <strong>Inbox</strong> page</li>
|
||||||
<li><strong>All inbox emails:</strong> Click <strong>Re-parse all</strong> at the top of the inbox page</li>
|
<li>Click the <strong>Re-parse all</strong> button at the top of the page</li>
|
||||||
|
<li>All emails in the inbox will be re-processed by all available parsers</li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<div class="doc-callout doc-callout-tip">
|
<div class="doc-callout doc-callout-tip">
|
||||||
@ -308,11 +287,15 @@
|
|||||||
<p>If an email shows blank <strong>Backup software</strong> or <strong>Job name</strong>:</p>
|
<p>If an email shows blank <strong>Backup software</strong> or <strong>Job name</strong>:</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>Check if a parser exists for this backup software in <strong>Settings</strong> → <strong>Parsers</strong></li>
|
<li>Check if a parser exists for this backup software on the <strong>Parsers</strong> page (Admin only)</li>
|
||||||
<li>If no parser exists, you'll need to create or request one</li>
|
<li>If no parser exists, contact support to request a new parser (provide sample .eml files)</li>
|
||||||
<li>If a parser exists, check that it's <strong>enabled</strong></li>
|
<li>If a parser exists but the email wasn't parsed:
|
||||||
<li>Verify the email format matches the parser's expected format (sender, subject, body structure)</li>
|
<ul>
|
||||||
<li>Check parser order - a different parser may be matching first</li>
|
<li>Verify the email format matches the parser's expected format (check sender, subject patterns on Parsers page)</li>
|
||||||
|
<li>The email may have a different format than the parser expects</li>
|
||||||
|
<li>Contact support with the .eml file to investigate</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<h3>Incorrect Parsing Results</h3>
|
<h3>Incorrect Parsing Results</h3>
|
||||||
@ -320,10 +303,9 @@
|
|||||||
<p>If parsing produces wrong job names or objects:</p>
|
<p>If parsing produces wrong job names or objects:</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>Verify the email format hasn't changed (backup software update may change email templates)</li>
|
<li>Verify the email format hasn't changed (backup software update may have changed email templates)</li>
|
||||||
<li>Check if the wrong parser is matching (disable it temporarily to test)</li>
|
<li>Contact support with sample .eml files to investigate the parsing issue</li>
|
||||||
<li>Review parser match criteria - may be too broad and matching unintended emails</li>
|
<li>The parser may need to be updated to handle the new email format</li>
|
||||||
<li>Contact support or review parser code to identify the issue</li>
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<h3>Partial Parsing</h3>
|
<h3>Partial Parsing</h3>
|
||||||
@ -347,19 +329,14 @@
|
|||||||
<li><strong>No AI inference:</strong> Parsers use pattern matching, not AI. They cannot interpret freeform text or adapt to unexpected formats</li>
|
<li><strong>No AI inference:</strong> Parsers use pattern matching, not AI. They cannot interpret freeform text or adapt to unexpected formats</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<div class="doc-callout doc-callout-info">
|
|
||||||
<strong>💡 Future Enhancement:</strong><br>
|
|
||||||
AI-powered parsing (using LLMs to interpret backup emails) is being considered for future versions to handle more diverse email formats without custom parsers.
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<h2>Best Practices</h2>
|
<h2>Best Practices</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><strong>Don't customize backup email templates:</strong> Use default email formats from your backup software for best parsing results</li>
|
<li><strong>Don't customize backup email templates:</strong> Use default email formats from your backup software for best parsing results</li>
|
||||||
<li><strong>Test new parsers:</strong> When adding a custom parser, test it on multiple sample emails before enabling it</li>
|
<li><strong>Monitor unparsed emails:</strong> Regularly check the inbox for emails with blank backup software fields</li>
|
||||||
<li><strong>Monitor unparsed emails:</strong> Regularly check for emails with blank backup software fields</li>
|
<li><strong>Report parsing issues promptly:</strong> If emails aren't parsing correctly, contact support immediately with .eml samples</li>
|
||||||
<li><strong>Keep parsers enabled:</strong> Only disable parsers when necessary - it's better to have too many than too few</li>
|
<li><strong>Re-parse after parser updates:</strong> After the developer adds or updates parsers, use "Re-parse all" on the inbox page to process existing emails</li>
|
||||||
<li><strong>Re-parse after updates:</strong> If you update parser code or add new parsers, re-parse existing inbox emails</li>
|
<li><strong>Keep email formats consistent:</strong> Avoid updating backup software email notification settings, as changes may break existing parsers</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2>Next Steps</h2>
|
<h2>Next Steps</h2>
|
||||||
|
|||||||
@ -8,7 +8,7 @@ This file documents all changes made to this project via Claude Code.
|
|||||||
- Completed Mail & Import documentation section (4 pages):
|
- Completed Mail & Import documentation section (4 pages):
|
||||||
- **Mail Import Setup**: Microsoft Graph API configuration with enhanced security (Azure AD app registration, start with Mail.Read only, Application Access Policy to restrict access to one mailbox via Exchange PowerShell, add Mail.ReadWrite after testing), two-step save workflow clarification (same "Save settings" button clicked twice - once for credentials to enable folder browsing, then again for complete configuration), automatic folder browser popup (no manual path entry), test configuration, troubleshooting (authentication errors, folder not found, no emails imported), advanced configuration (email retention, multiple mailboxes), comprehensive security best practices including principle of least privilege, note about planned UI improvement to make two-step save workflow more obvious
|
- **Mail Import Setup**: Microsoft Graph API configuration with enhanced security (Azure AD app registration, start with Mail.Read only, Application Access Policy to restrict access to one mailbox via Exchange PowerShell, add Mail.ReadWrite after testing), two-step save workflow clarification (same "Save settings" button clicked twice - once for credentials to enable folder browsing, then again for complete configuration), automatic folder browser popup (no manual path entry), test configuration, troubleshooting (authentication errors, folder not found, no emails imported), advanced configuration (email retention, multiple mailboxes), comprehensive security best practices including principle of least privilege, note about planned UI improvement to make two-step save workflow more obvious
|
||||||
- **Inbox Management**: Inbox overview and workflow (inbox shows ONLY unapproved emails - approved emails immediately disappear), table columns explanation (EML column shows download link, not checkmark), viewing email details with screenshot (approve-job.png), email detail modal TWO-COLUMN layout (left: metadata + action buttons + parsed objects, right: email body iframe), action buttons (Approve, Delete, Download .eml - NO Re-parse in modal), approving emails (customer selection ONLY - job name is READ-ONLY and cannot be edited), what happens after approval (email disappears from inbox, future emails auto-approved and never appear in inbox), re-parsing emails (ONLY "Re-parse all" button on inbox page - no individual re-parse), deleting emails (single and bulk delete, soft delete viewable on "Deleted Mails" page for Admins only), downloading .eml files, common workflows (new customer setup, troubleshooting unparsed emails - parsers can ONLY be created by developer, cleaning spam), best practices (verify parsed job names before approval - cannot edit during approval), removed Inbox Filters section (not in planning)
|
- **Inbox Management**: Inbox overview and workflow (inbox shows ONLY unapproved emails - approved emails immediately disappear), table columns explanation (EML column shows download link, not checkmark), viewing email details with screenshot (approve-job.png), email detail modal TWO-COLUMN layout (left: metadata + action buttons + parsed objects, right: email body iframe), action buttons (Approve, Delete, Download .eml - NO Re-parse in modal), approving emails (customer selection ONLY - job name is READ-ONLY and cannot be edited), what happens after approval (email disappears from inbox, future emails auto-approved and never appear in inbox), re-parsing emails (ONLY "Re-parse all" button on inbox page - no individual re-parse), deleting emails (single and bulk delete, soft delete viewable on "Deleted Mails" page for Admins only), downloading .eml files, common workflows (new customer setup, troubleshooting unparsed emails - parsers can ONLY be created by developer, cleaning spam), best practices (verify parsed job names before approval - cannot edit during approval), removed Inbox Filters section (not in planning)
|
||||||
- **Mail Parsing**: Parsing overview and workflow (retrieval, preprocessing, parser selection, matching, parsing, storage), parsers (viewing available parsers, parser information), match criteria (sender, subject, body match), supported backup software (Veeam, Synology, NAKIVO, Boxafe, Panel3, QNAP, Syncovery, 3CX, RDrive, NTFS Auditing), parser execution order, enabling/disabling parsers, re-parsing emails, parsing workflow example, troubleshooting parsing issues, parser limitations, best practices
|
- **Mail Parsing**: Parsing overview and workflow (retrieval, preprocessing, parser selection, matching, parsing, storage), parsers (viewing on separate "Parsers" page - Admin only, NOT in Settings), parser information table (removed non-existent "Enabled" column, added callout that parser list is read-only), match criteria (sender, subject, body match), supported backup software (Veeam, Synology, NAKIVO, Boxafe, Panel3, QNAP, Syncovery, 3CX, RDrive, NTFS Auditing), parser execution order, REMOVED entire "Enabling and Disabling Parsers" section (feature doesn't exist!), re-parsing emails (ONLY "Re-parse all" available, no individual re-parse), parsing workflow example, troubleshooting parsing issues (contact support - users cannot enable/disable/modify parsers), parser limitations, REMOVED "AI-powered parsing" future enhancement (not in planning, completely fabricated), best practices (removed references to testing/enabling parsers - users cannot manage parsers)
|
||||||
- **Auto-Import Configuration**: Auto-import overview and features, enabling auto-import, import interval configuration (5/15/30/60 minutes), batch size explanation, how auto-import works (timer, check settings, authenticate, fetch, parse, auto-approve, move, log, persist, wait), auto-approval logic and conditions, when auto-approval fails, manual import (triggering, batch size 1-50), import settings summary table, monitoring import activity (audit log, inbox page, jobs/daily jobs), troubleshooting (auto-import not running, emails not auto-approved, import errors), best practices, advanced configuration (disabling temporarily, EML retention, high-volume environments)
|
- **Auto-Import Configuration**: Auto-import overview and features, enabling auto-import, import interval configuration (5/15/30/60 minutes), batch size explanation, how auto-import works (timer, check settings, authenticate, fetch, parse, auto-approve, move, log, persist, wait), auto-approval logic and conditions, when auto-approval fails, manual import (triggering, batch size 1-50), import settings summary table, monitoring import activity (audit log, inbox page, jobs/daily jobs), troubleshooting (auto-import not running, emails not auto-approved, import errors), best practices, advanced configuration (disabling temporarily, EML retention, high-volume environments)
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user