Fix Configuring Jobs documentation - customer selection workflow

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>
This commit is contained in:
Ivo Oskamp 2026-02-08 13:23:54 +01:00
parent 5700f795e4
commit 8121af485d
2 changed files with 102 additions and 18 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

View File

@ -74,17 +74,42 @@
<ol>
<li>Navigate to <strong>Inbox</strong> in the main menu</li>
<li>Find a backup report email in the inbox list</li>
<li>Click on the email to view its details</li>
<li>In the <strong>Customer</strong> field, select or enter the customer name
<ul>
<li>If the customer exists, select it from the dropdown</li>
<li>If the customer is new, type the name and it will be created automatically</li>
</ul>
</li>
<li>Click the <strong>Approve job</strong> button (enabled once a customer is selected)</li>
<li>Click on the email to view its details in a modal dialog</li>
</ol>
<p>The system will:</p>
<figure>
<img src="{{ url_for('static', filename='images/documentation/approve-job.png') }}"
alt="Inbox Email Detail - Approve Job" />
<figcaption>Figure 1: Inbox email detail showing backup report information and customer selection field</figcaption>
</figure>
<h3>Selecting a Customer</h3>
<p>In the email detail modal, you'll see a <strong>Customer</strong> field with "Select customer" placeholder text. This field has autocomplete functionality:</p>
<ol>
<li>Click on the <strong>Customer</strong> field</li>
<li>Start typing part of the customer name (you can type any part, not just the beginning)
<ul>
<li>Example: typing "toso" will find "Contoso"</li>
<li>The autocomplete searches across the entire customer name</li>
</ul>
</li>
<li>Select the correct customer from the dropdown suggestions</li>
</ol>
<div class="doc-callout doc-callout-warning">
<strong>⚠️ Customer Must Exist First:</strong><br>
You <strong>cannot create new customers</strong> from the Inbox. Customers must be created on the <strong>Customers</strong> page before approving jobs. If the customer doesn't exist yet, cancel the dialog, create the customer first, then return to approve the job.
</div>
<h3>Approving the Job</h3>
<p>Once you've selected a customer:</p>
<ol>
<li>Click the <strong>Approve job</strong> button (blue button at the bottom left)</li>
<li>The system will:
<ul>
<li>Create a new backup job linked to the selected customer</li>
<li>Apply the Mail Parser's configuration automatically</li>
@ -92,12 +117,71 @@
<li>Remove the email from the Inbox</li>
<li>Make the run available in Run Checks for review</li>
</ul>
</li>
</ol>
<div class="doc-callout doc-callout-tip">
<strong>💡 Customer Selection:</strong><br>
The <strong>Approve job</strong> button is only enabled when a customer is selected. If you type a new customer name, it will be created automatically when you approve the job.
<strong>💡 Workflow Best Practice:</strong><br>
The <strong>Approve job</strong> button is only enabled when a customer is selected. Create customers on the Customers page first, then approve jobs from the Inbox. This ensures proper customer naming and prevents duplicates.
</div>
<h2>Email Detail Information</h2>
<p>When you click on an email in the Inbox, a detail modal displays the parsed backup report information:</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>From</strong></td>
<td>Email sender address</td>
</tr>
<tr>
<td><strong>Backup</strong></td>
<td>Detected backup software (e.g., Veeam, Acronis)</td>
</tr>
<tr>
<td><strong>Type</strong></td>
<td>Backup type (e.g., Configuration Job, Full, Incremental)</td>
</tr>
<tr>
<td><strong>Job</strong></td>
<td>Parsed job name from the email</td>
</tr>
<tr>
<td><strong>Overall</strong></td>
<td>Backup result (Success, Failed, Warning)</td>
</tr>
<tr>
<td><strong>Customer</strong></td>
<td>Customer selection field (autocomplete)</td>
</tr>
<tr>
<td><strong>Received</strong></td>
<td>Date and time the email was received</td>
</tr>
<tr>
<td><strong>Parsed</strong></td>
<td>Date and time the email was parsed</td>
</tr>
</tbody>
</table>
<p>The <strong>Details</strong> panel on the right shows the parsed backup report content, including:</p>
<ul>
<li>Success/failure status (green or red header)</li>
<li>Backup start time, end time, and duration</li>
<li>Data size, backup size, and compression ratio</li>
<li>Detailed catalog information (if available)</li>
<li>Version information (e.g., "Veeam Backup & Replication 12.3.2.4165")</li>
</ul>
<h2>What Mail Parsers Configure</h2>
<p>When you approve a job, the Mail Parser automatically determines the following job configuration:</p>