diff --git a/containers/backupchecks/src/static/images/documentation/edit-customer.png b/containers/backupchecks/src/static/images/documentation/edit-customer.png new file mode 100644 index 0000000..088dd42 Binary files /dev/null and b/containers/backupchecks/src/static/images/documentation/edit-customer.png differ diff --git a/containers/backupchecks/src/static/images/documentation/new-customers.png b/containers/backupchecks/src/static/images/documentation/new-customers.png new file mode 100644 index 0000000..b0cfb7b Binary files /dev/null and b/containers/backupchecks/src/static/images/documentation/new-customers.png differ diff --git a/containers/backupchecks/src/templates/documentation/customers-jobs/managing-customers.html b/containers/backupchecks/src/templates/documentation/customers-jobs/managing-customers.html index b32477c..382ac62 100644 --- a/containers/backupchecks/src/templates/documentation/customers-jobs/managing-customers.html +++ b/containers/backupchecks/src/templates/documentation/customers-jobs/managing-customers.html @@ -16,10 +16,11 @@

Accessing the Customers Page

@@ -46,7 +47,7 @@ Name - Customer name (clickable to view/edit details) + Customer name Jobs @@ -61,8 +62,8 @@ Checkbox indicating whether the customer account is active - Actions - Edit, Delete, and Autotask mapping buttons + Edit / Delete + Edit and Delete buttons on the right side of each row @@ -74,21 +75,22 @@

Creating a New Customer

+

The customer creation interface is located at the top of the Customers page.

+ +
+ New Customer Interface +
Figure 1: New customer creation interface with CSV import/export and Autotask refresh options
+
+

To create a new customer account:

  1. Navigate to the Customers page
    2. -
  2. Scroll down to the New Customer section
    3. -
  3. Fill in the following fields: - -
    4. -
  4. Click Create Customer
    5. +
  5. At the top, locate the "New customer name" field
    6. +
  6. Enter the customer name (required)
    7. +
  7. Check the Active checkbox if you want the customer to be active immediately (checked by default)
    8. +
  8. Click the Add button

The customer will be created and appear in the customer list immediately.

@@ -105,16 +107,36 @@
  1. Navigate to the Customers page
  2. Find the customer in the list
    3. -
  3. Click the Edit button (pencil icon) in the Actions column
    4. -
  4. Modify the customer details in the edit form
    5. -
  5. Click Save to apply changes
    6. +
  6. Click the Edit button on the right side of the customer row
    7. +
  7. An "Edit customer" dialog will open
-

All customer fields (name, contact person, email, phone, notes) can be updated at any time.

+
+ Edit Customer Dialog +
Figure 2: Edit customer dialog showing customer name, active status, and Autotask mapping interface
+
+ +

Editable Fields

+ +

In the Edit customer dialog, you can modify:

+ + + +

After making changes, click Save changes to apply them, or Cancel to discard.

+ +
+ 💡 Simple Customer Data:
+ BackupChecks keeps customer data simple - only name and active status. There are no separate fields for contact person, email, phone, or notes. The focus is on backup job management, not CRM functionality. +

Activating and Deactivating Customers

-

Customers can be marked as active or inactive using the checkbox in the Active column.

+

Customers can be marked as active or inactive using the Active checkbox in the Edit customer dialog or directly in the customer list.

Active Customers

@@ -139,6 +161,77 @@ When you deactivate a customer, all their backup jobs immediately disappear from operational views (Daily Jobs, Run Checks, Jobs list). This is useful for decluttering the interface when a customer is no longer active. Jobs are not deleted and can be reactivated by marking the customer as active again. +

Autotask Company Mapping

+ +

If Autotask integration is enabled, you can map customers to Autotask companies directly from the Edit customer dialog. This allows BackupChecks to create tickets in the correct Autotask company.

+ +

Viewing Current Mapping

+ +

In the Edit customer dialog, the Autotask mapping section shows:

+ + + +

Searching for Autotask Companies

+ +

To map a customer to an Autotask company:

+ +
    +
  1. Open the Edit customer dialog
    2. +
  2. In the Autotask mapping section, use the "Search Autotask companies" field
    3. +
  3. Type the company name (or part of it)
    4. +
  4. Click the Search button
    5. +
  5. Results will appear below the search field
    6. +
  6. Click on a result to select it
    7. +
  7. Click the Set mapping button (blue) to apply the mapping
    8. +
  8. Click Save changes to save the customer with the new mapping
    9. +
+ +
+ 💡 Auto-Search Feature:
+ When you open the Edit customer dialog, BackupChecks automatically searches for Autotask companies matching the customer name. This speeds up the mapping process for most customers. +
+ +

Refreshing Autotask Status

+ +

If you want to verify the Autotask company mapping is still valid:

+ +
    +
  1. Open the Edit customer dialog
    2. +
  2. Click the Refresh status button (gray) in the Autotask mapping section
    3. +
  3. BackupChecks will query Autotask to verify the company still exists and update the status
    4. +
+ +

Clearing Autotask Mapping

+ +

To remove an Autotask company mapping:

+ +
    +
  1. Open the Edit customer dialog
    2. +
  2. Click the Clear mapping button (red) in the Autotask mapping section
    3. +
  3. The mapping will be removed (but not saved yet)
    4. +
  4. Click Save changes to confirm the removal
    5. +
+ +

Existing tickets remain linked to the Autotask company, but new tickets will not be created until the customer is mapped again.

+ +

Refreshing All Autotask Mappings

+ +

To refresh the sync status of all customer Autotask mappings at once:

+ +
    +
  1. Navigate to the Customers page
    2. +
  2. At the top, click the Refresh all Autotask mappings button
    3. +
  3. BackupChecks will verify all mappings with Autotask and update their statuses
    4. +
+ +
+ 💡 Use Case:
+ Use this feature periodically to ensure all customer mappings are still valid, especially if Autotask companies have been renamed or deleted. +
+

Deleting Customers

To delete a customer:

@@ -146,7 +239,7 @@
  1. Navigate to the Customers page
  2. Find the customer you want to delete
    3. -
  3. Click the Delete button (trash icon)
    4. +
  4. Click the Delete button on the right side of the customer row
  5. Confirm the deletion in the dialog
@@ -155,51 +248,18 @@ Deleting a customer is permanent and will also delete all associated backup jobs, runs, tickets, and remarks. This action cannot be undone. Consider deactivating the customer instead if you might need the data later. -

Autotask Company Mapping

- -

If Autotask integration is enabled, you can map customers to Autotask companies. This allows BackupChecks to create tickets in the correct Autotask company.

- -

Mapping a Customer to Autotask

- -
    -
  1. Navigate to the Customers page
    2. -
  2. Find the customer you want to map
    3. -
  3. Click the Link Autotask Company button
    4. -
  4. A modal dialog will open with a search box pre-filled with the customer name
    5. -
  5. Review the search results and select the matching Autotask company
    6. -
  6. Click Save Mapping
    7. -
- -

Once mapped, the Autotask company name will appear in the "Autotask Company" column, and any tickets created for this customer's backup jobs will be created in the linked Autotask company.

- -
- 💡 Auto-Search Feature:
- When you open the Autotask mapping dialog, BackupChecks automatically searches for companies matching the customer name. This speeds up the mapping process for most customers. -
- -

Unmapping a Customer from Autotask

- -

To remove an Autotask company mapping:

- -
    -
  1. Click the Unlink button next to the Autotask company name
    2. -
  2. Confirm the unmapping
    3. -
- -

Existing tickets remain linked to the Autotask company, but new tickets will not be created until the customer is mapped again.

-

Exporting Customer Data

You can export all customer data to a CSV file for backup, reporting, or migration purposes.

  1. Navigate to the Customers page
    2. -
  2. Click the Export Customers button at the top of the page
    3. +
  3. At the top, click the Export CSV button
  4. A CSV file will be downloaded containing:
@@ -215,9 +275,9 @@
  1. Navigate to the Customers page
    2. -
  2. Click the Import Customers button
    3. -
  3. Select your CSV file (must match the export format)
    4. -
  4. Click Upload
    5. +
  5. At the top, click the Browse... button to select your CSV file
    6. +
  6. Select the CSV file (must match the export format)
    7. +
  7. Click the Import CSV button
  8. The system will: