Fix Approved Jobs documentation based on actual UI

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>
This commit is contained in:
Ivo Oskamp 2026-02-08 13:39:01 +01:00
parent c671a606bd
commit ecba3de50b
2 changed files with 41 additions and 72 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

View File

@ -48,32 +48,16 @@
<td>Customer name (jobs are grouped by customer)</td> <td>Customer name (jobs are grouped by customer)</td>
</tr> </tr>
<tr> <tr>
<td><strong>Job Name</strong></td> <td><strong>Backup</strong></td>
<td>Backup job name (clickable to view details)</td> <td>Detected backup software (e.g., Veeam, Synology, Acronis)</td>
</tr> </tr>
<tr> <tr>
<td><strong>Backup Software</strong></td> <td><strong>Type</strong></td>
<td>Detected backup software (e.g., Veeam, Acronis, Windows Server Backup)</td> <td>Backup type (e.g., Configuration Job, Hyperbackup, Full, Incremental)</td>
</tr> </tr>
<tr> <tr>
<td><strong>Backup Type</strong></td> <td><strong>Job name</strong></td>
<td>Type of backup (e.g., Full, Incremental, Differential)</td> <td>Backup job name</td>
</tr>
<tr>
<td><strong>Last Run</strong></td>
<td>Date and time of the most recent backup run</td>
</tr>
<tr>
<td><strong>Status</strong></td>
<td>Status of the most recent run (Success, Failed, Warning)</td>
</tr>
<tr>
<td><strong>Schedule</strong></td>
<td>Learned schedule (e.g., "Daily", "Weekly: Mon, Wed, Fri", "Monthly: 1st")</td>
</tr>
<tr>
<td><strong>Actions</strong></td>
<td>Edit, Archive, Delete buttons</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -90,36 +74,57 @@
<ol> <ol>
<li>Navigate to the <strong>Jobs</strong> page</li> <li>Navigate to the <strong>Jobs</strong> page</li>
<li>Find the job in the list</li> <li>Find the job in the list</li>
<li>Click on the <strong>job name</strong></li> <li>Click anywhere on the job row (not just the job name)</li>
<li>The job details page will open</li>
</ol> </ol>
<figure>
<img src="{{ url_for('static', filename='images/documentation/job-details.png') }}"
alt="Job Details Page" />
<figcaption>Figure 1: Job details page showing job information, learned schedule, and job history</figcaption>
</figure>
<p>The job detail page shows:</p> <p>The job detail page shows:</p>
<ul> <ul>
<li><strong>Job Information:</strong> <li><strong>Job Information:</strong>
<ul> <ul>
<li>Customer name</li> <li><strong>Customer:</strong> Customer name</li>
<li>Job name</li> <li><strong>Backup:</strong> Backup software (e.g., Synology, Veeam)</li>
<li>Backup software and type</li> <li><strong>Type:</strong> Backup type (e.g., Hyperbackup, Configuration Job)</li>
<li>Active/archived status</li> <li><strong>Job name:</strong> Name of the backup job</li>
<li><strong>Tickets:</strong> Open and total ticket count (e.g., "0 open / 1 total")</li>
<li><strong>Remarks:</strong> Open and total remark count (e.g., "0 open / 0 total")</li>
</ul> </ul>
</li> </li>
<li><strong>Email Matching Patterns:</strong> <li><strong>Schedule (inferred):</strong>
<ul> <ul>
<li>Sender email pattern (used to match incoming emails)</li> <li>Table showing expected run days and times in 15-minute blocks</li>
<li>Subject pattern (used to match incoming emails)</li> <li>Example: Mon-Sun with 20:00 time slots</li>
<li>Only shown if schedule has been learned</li>
</ul> </ul>
</li> </li>
<li><strong>Schedule Information:</strong> <li><strong>Action Buttons:</strong>
<ul> <ul>
<li>Learned schedule (if available)</li> <li><strong>Archive:</strong> Archive the job (gray button)</li>
<li>Expected run days/times</li> <li><strong>Delete job:</strong> Permanently delete the job (red button)</li>
</ul> </ul>
</li> </li>
<li><strong>Recent Backup Runs:</strong> <li><strong>Job History:</strong>
<ul> <ul>
<li>List of recent backup runs with dates and statuses</li> <li>Table of recent backup runs with columns:
<li>Clickable to view run details</li> <ul>
<li><strong>Day run:</strong> Day of the week</li>
<li><strong>Run time:</strong> Date and time of the backup</li>
<li><strong>Status:</strong> Success/Failed indicator (green dot for success)</li>
<li><strong>Tickets:</strong> Linked ticket numbers (if any)</li>
<li><strong>Remarks:</strong> Associated remarks</li>
<li><strong>Override:</strong> Override status</li>
<li><strong>Reviewed by:</strong> Username who reviewed the run</li>
<li><strong>Reviewed at:</strong> Date and time of review</li>
</ul>
</li>
<li>Runs are clickable to view full run details</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -138,42 +143,6 @@
You <strong>cannot edit</strong> job properties like customer assignment, job name, or parser-determined fields (backup software, backup type, sender pattern, subject pattern) through the job detail page. All job configuration is determined when the job is approved from the Inbox. You <strong>cannot edit</strong> job properties like customer assignment, job name, or parser-determined fields (backup software, backup type, sender pattern, subject pattern) through the job detail page. All job configuration is determined when the job is approved from the Inbox.
</div> </div>
<h2>Job Status Indicators</h2>
<p>Jobs display different status indicators based on their most recent backup run:</p>
<table>
<thead>
<tr>
<th>Status</th>
<th>Color</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Success</strong></td>
<td>Green</td>
<td>Most recent backup completed successfully</td>
</tr>
<tr>
<td><strong>Failed</strong></td>
<td>Red</td>
<td>Most recent backup failed</td>
</tr>
<tr>
<td><strong>Warning</strong></td>
<td>Yellow/Orange</td>
<td>Backup completed with warnings</td>
</tr>
<tr>
<td><strong>No Runs</strong></td>
<td>Gray</td>
<td>Job approved but no backup runs received yet</td>
</tr>
</tbody>
</table>
<h2>Archiving Jobs</h2> <h2>Archiving Jobs</h2>
<p>When a backup job is no longer active (e.g., server decommissioned, backup solution changed), you can archive it to declutter operational views.</p> <p>When a backup job is no longer active (e.g., server decommissioned, backup solution changed), you can archive it to declutter operational views.</p>