{% extends "documentation/base.html" %} {% block doc_content %}

Quick Start Checklist

Follow this checklist to set up your first customer and backup job in BackupChecks.

📝 Coming Soon: This page is under construction. Screenshots will be added in a future update.

Prerequisites

Before you begin, ensure you have:

Step 1: Configure Mail Import

  1. Navigate to Settings → Mail
  2. Enter your Microsoft Graph API details (Tenant ID, Client ID, Client Secret, Mailbox)
  3. Test the connection to verify the credentials are correct
  4. Go to Settings → Imports
  5. Click the Manual Import button to fetch emails from the mailbox
💡 Recommended Approach:
Automatic mail import is disabled by default. Start by using the manual import button to test if everything works correctly. Once you're satisfied that emails are being imported and processed as expected, you can enable automatic mail import in Settings → Mail. This way, the system will automatically fetch new emails at the configured interval.

Step 2: Add a Customer

  1. Go to Customers in the navigation menu
  2. Click New Customer
  3. Fill in the customer details (name, contact info)
  4. Save the customer
💡 Note:
On the Customers page, you'll see the number of jobs linked to each customer. If no jobs are configured yet, you'll see 0 displayed in red and bold.

Step 3: Create Your First Job from Inbox

Jobs are created directly from the Inbox by approving backup report emails. The system uses Mail Parsers to extract job details automatically, ensuring consistency.

  1. Go to Inbox in the navigation menu
  2. Find a backup report email from your customer
  3. Click on the email to view its details
  4. In the Customer field, enter or select the customer name you created in Step 2
  5. Click Approve job (this button is only enabled when a customer is selected)
⚠️ Important:
You cannot manually configure job variables. All job details (backup software, backup type, sender, subject patterns, etc.) are automatically determined by the Mail Parsers based on the email content. This ensures all jobs are created consistently.

Step 4: Process Similar Emails (Reparse All)

After approving your first job, you can automatically process other emails that match the same pattern:

  1. At the top of the Inbox page, click Reparse all
  2. The system will scan all inbox emails and link any that match your newly approved job
  3. Matched emails are automatically removed from the inbox and linked to the job
💡 Tip:
Use the Delete button on emails that are not backup reports. Deleted emails are moved to Deleted Mails (visible to admins only).

Step 5: Review Backup Runs

When a backup report email is processed, it creates a "run" in the system:

  1. Navigate to Run Checks in the navigation menu
  2. You should see the backup run(s) from your approved job
  3. Review each run (successful or failed) and mark it as reviewed
  4. The goal is to clear the Run Checks queue by reviewing all pending runs
💡 About Daily Jobs:
The Daily Jobs page shows jobs expected to run today based on learned schedules. It takes a few days for the system to learn a job's schedule pattern. Once learned, jobs will appear in Daily Jobs on their expected days. Individual runs always appear immediately in Run Checks regardless of schedule.

Understanding the Workflow

Here's a summary of how BackupChecks processes backup reports:

Step What Happens Where to See It
1. Email arrives Backup report is sent to monitored mailbox Not visible yet
2. Import runs System fetches email via Graph API Inbox (if no matching job exists)
3. Job created You approve the email and create a job Jobs page
4. Run created Email is parsed and a backup run is recorded Run Checks page
5. Schedule learned After several runs, system learns the schedule Daily Jobs page
6. Review Operator marks run as reviewed Run Checks queue is cleared

Next Steps

Now that you have your first job configured, you can:

{% endblock %}