Fix Managing Customers documentation based on actual UI
Corrected documentation to match actual customer management interface: Customer Fields: - Only customer name and active status (no contact fields) - Customer name is not clickable - Edit and Delete buttons on right side (no "Actions" column) Edit Customer Dialog: - Modal dialog with customer name and active checkbox - Autotask mapping integrated in same dialog (not separate button) - Search Autotask companies field with Search button - Set mapping (blue), Refresh status (gray), Clear mapping (red) buttons - Current mapping display with sync status timestamp - Cancel and Save changes buttons New Customer Interface: - Simple form at top of page - Only name field and Active checkbox - Add button to create customer - Browse... button for CSV file selection - Import CSV and Export CSV buttons - Refresh all Autotask mappings button Added Screenshots: - edit-customer.png: Shows edit dialog with Autotask mapping interface - new-customers.png: Shows customer creation and CSV import/export controls Removed incorrect information about contact person, email, phone, notes fields. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
5896614637
commit
5700f795e4
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.9 KiB |
@ -16,10 +16,11 @@
|
||||
<ul>
|
||||
<li>View all customers and their backup job counts</li>
|
||||
<li>Create new customer accounts</li>
|
||||
<li>Edit customer information</li>
|
||||
<li>Edit customer names and active status</li>
|
||||
<li>Map customers to Autotask companies (if Autotask integration is enabled)</li>
|
||||
<li>Activate or deactivate customer accounts</li>
|
||||
<li>Export and import customer data</li>
|
||||
<li>Export and import customer data via CSV</li>
|
||||
<li>Delete customers</li>
|
||||
</ul>
|
||||
|
||||
<h2>Accessing the Customers Page</h2>
|
||||
@ -46,7 +47,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><strong>Name</strong></td>
|
||||
<td>Customer name (clickable to view/edit details)</td>
|
||||
<td>Customer name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Jobs</strong></td>
|
||||
@ -61,8 +62,8 @@
|
||||
<td>Checkbox indicating whether the customer account is active</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Actions</strong></td>
|
||||
<td>Edit, Delete, and Autotask mapping buttons</td>
|
||||
<td><strong>Edit / Delete</strong></td>
|
||||
<td>Edit and Delete buttons on the right side of each row</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -74,21 +75,22 @@
|
||||
|
||||
<h2>Creating a New Customer</h2>
|
||||
|
||||
<p>The customer creation interface is located at the top of the Customers page.</p>
|
||||
|
||||
<figure>
|
||||
<img src="{{ url_for('static', filename='images/documentation/new-customers.png') }}"
|
||||
alt="New Customer Interface" />
|
||||
<figcaption>Figure 1: New customer creation interface with CSV import/export and Autotask refresh options</figcaption>
|
||||
</figure>
|
||||
|
||||
<p>To create a new customer account:</p>
|
||||
|
||||
<ol>
|
||||
<li>Navigate to the <strong>Customers</strong> page</li>
|
||||
<li>Scroll down to the <strong>New Customer</strong> section</li>
|
||||
<li>Fill in the following fields:
|
||||
<ul>
|
||||
<li><strong>Customer Name:</strong> (Required) The name of the organization or client</li>
|
||||
<li><strong>Contact Person:</strong> (Optional) Primary contact name</li>
|
||||
<li><strong>Contact Email:</strong> (Optional) Contact email address</li>
|
||||
<li><strong>Contact Phone:</strong> (Optional) Contact phone number</li>
|
||||
<li><strong>Notes:</strong> (Optional) Additional information or notes about the customer</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Click <strong>Create Customer</strong></li>
|
||||
<li>At the top, locate the "New customer name" field</li>
|
||||
<li>Enter the <strong>customer name</strong> (required)</li>
|
||||
<li>Check the <strong>Active</strong> checkbox if you want the customer to be active immediately (checked by default)</li>
|
||||
<li>Click the <strong>Add</strong> button</li>
|
||||
</ol>
|
||||
|
||||
<p>The customer will be created and appear in the customer list immediately.</p>
|
||||
@ -105,16 +107,36 @@
|
||||
<ol>
|
||||
<li>Navigate to the <strong>Customers</strong> page</li>
|
||||
<li>Find the customer in the list</li>
|
||||
<li>Click the <strong>Edit</strong> button (pencil icon) in the Actions column</li>
|
||||
<li>Modify the customer details in the edit form</li>
|
||||
<li>Click <strong>Save</strong> to apply changes</li>
|
||||
<li>Click the <strong>Edit</strong> button on the right side of the customer row</li>
|
||||
<li>An "Edit customer" dialog will open</li>
|
||||
</ol>
|
||||
|
||||
<p>All customer fields (name, contact person, email, phone, notes) can be updated at any time.</p>
|
||||
<figure>
|
||||
<img src="{{ url_for('static', filename='images/documentation/edit-customer.png') }}"
|
||||
alt="Edit Customer Dialog" />
|
||||
<figcaption>Figure 2: Edit customer dialog showing customer name, active status, and Autotask mapping interface</figcaption>
|
||||
</figure>
|
||||
|
||||
<h3>Editable Fields</h3>
|
||||
|
||||
<p>In the Edit customer dialog, you can modify:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>Customer name:</strong> Change the customer's display name</li>
|
||||
<li><strong>Active:</strong> Toggle whether the customer is active or inactive</li>
|
||||
<li><strong>Autotask mapping:</strong> Link or unlink the customer to an Autotask company (see below)</li>
|
||||
</ul>
|
||||
|
||||
<p>After making changes, click <strong>Save changes</strong> to apply them, or <strong>Cancel</strong> to discard.</p>
|
||||
|
||||
<div class="doc-callout doc-callout-info">
|
||||
<strong>💡 Simple Customer Data:</strong><br>
|
||||
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.
|
||||
</div>
|
||||
|
||||
<h2>Activating and Deactivating Customers</h2>
|
||||
|
||||
<p>Customers can be marked as active or inactive using the checkbox in the Active column.</p>
|
||||
<p>Customers can be marked as active or inactive using the Active checkbox in the Edit customer dialog or directly in the customer list.</p>
|
||||
|
||||
<h3>Active Customers</h3>
|
||||
|
||||
@ -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.
|
||||
</div>
|
||||
|
||||
<h2>Autotask Company Mapping</h2>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<h3>Viewing Current Mapping</h3>
|
||||
|
||||
<p>In the Edit customer dialog, the <strong>Autotask mapping</strong> section shows:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>Current mapping:</strong> The name of the linked Autotask company (if mapped)</li>
|
||||
<li><strong>Status:</strong> Sync status (e.g., "ok • Checked: 2026-02-07 00:06:15")</li>
|
||||
</ul>
|
||||
|
||||
<h3>Searching for Autotask Companies</h3>
|
||||
|
||||
<p>To map a customer to an Autotask company:</p>
|
||||
|
||||
<ol>
|
||||
<li>Open the Edit customer dialog</li>
|
||||
<li>In the <strong>Autotask mapping</strong> section, use the "Search Autotask companies" field</li>
|
||||
<li>Type the company name (or part of it)</li>
|
||||
<li>Click the <strong>Search</strong> button</li>
|
||||
<li>Results will appear below the search field</li>
|
||||
<li>Click on a result to select it</li>
|
||||
<li>Click the <strong>Set mapping</strong> button (blue) to apply the mapping</li>
|
||||
<li>Click <strong>Save changes</strong> to save the customer with the new mapping</li>
|
||||
</ol>
|
||||
|
||||
<div class="doc-callout doc-callout-info">
|
||||
<strong>💡 Auto-Search Feature:</strong><br>
|
||||
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.
|
||||
</div>
|
||||
|
||||
<h3>Refreshing Autotask Status</h3>
|
||||
|
||||
<p>If you want to verify the Autotask company mapping is still valid:</p>
|
||||
|
||||
<ol>
|
||||
<li>Open the Edit customer dialog</li>
|
||||
<li>Click the <strong>Refresh status</strong> button (gray) in the Autotask mapping section</li>
|
||||
<li>BackupChecks will query Autotask to verify the company still exists and update the status</li>
|
||||
</ol>
|
||||
|
||||
<h3>Clearing Autotask Mapping</h3>
|
||||
|
||||
<p>To remove an Autotask company mapping:</p>
|
||||
|
||||
<ol>
|
||||
<li>Open the Edit customer dialog</li>
|
||||
<li>Click the <strong>Clear mapping</strong> button (red) in the Autotask mapping section</li>
|
||||
<li>The mapping will be removed (but not saved yet)</li>
|
||||
<li>Click <strong>Save changes</strong> to confirm the removal</li>
|
||||
</ol>
|
||||
|
||||
<p>Existing tickets remain linked to the Autotask company, but new tickets will not be created until the customer is mapped again.</p>
|
||||
|
||||
<h2>Refreshing All Autotask Mappings</h2>
|
||||
|
||||
<p>To refresh the sync status of all customer Autotask mappings at once:</p>
|
||||
|
||||
<ol>
|
||||
<li>Navigate to the <strong>Customers</strong> page</li>
|
||||
<li>At the top, click the <strong>Refresh all Autotask mappings</strong> button</li>
|
||||
<li>BackupChecks will verify all mappings with Autotask and update their statuses</li>
|
||||
</ol>
|
||||
|
||||
<div class="doc-callout doc-callout-tip">
|
||||
<strong>💡 Use Case:</strong><br>
|
||||
Use this feature periodically to ensure all customer mappings are still valid, especially if Autotask companies have been renamed or deleted.
|
||||
</div>
|
||||
|
||||
<h2>Deleting Customers</h2>
|
||||
|
||||
<p>To delete a customer:</p>
|
||||
@ -146,7 +239,7 @@
|
||||
<ol>
|
||||
<li>Navigate to the <strong>Customers</strong> page</li>
|
||||
<li>Find the customer you want to delete</li>
|
||||
<li>Click the <strong>Delete</strong> button (trash icon)</li>
|
||||
<li>Click the <strong>Delete</strong> button on the right side of the customer row</li>
|
||||
<li>Confirm the deletion in the dialog</li>
|
||||
</ol>
|
||||
|
||||
@ -155,51 +248,18 @@
|
||||
Deleting a customer is <strong>permanent</strong> 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.
|
||||
</div>
|
||||
|
||||
<h2>Autotask Company Mapping</h2>
|
||||
|
||||
<p>If Autotask integration is enabled, you can map customers to Autotask companies. This allows BackupChecks to create tickets in the correct Autotask company.</p>
|
||||
|
||||
<h3>Mapping a Customer to Autotask</h3>
|
||||
|
||||
<ol>
|
||||
<li>Navigate to the <strong>Customers</strong> page</li>
|
||||
<li>Find the customer you want to map</li>
|
||||
<li>Click the <strong>Link Autotask Company</strong> button</li>
|
||||
<li>A modal dialog will open with a search box pre-filled with the customer name</li>
|
||||
<li>Review the search results and select the matching Autotask company</li>
|
||||
<li>Click <strong>Save Mapping</strong></li>
|
||||
</ol>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<div class="doc-callout doc-callout-info">
|
||||
<strong>💡 Auto-Search Feature:</strong><br>
|
||||
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.
|
||||
</div>
|
||||
|
||||
<h3>Unmapping a Customer from Autotask</h3>
|
||||
|
||||
<p>To remove an Autotask company mapping:</p>
|
||||
|
||||
<ol>
|
||||
<li>Click the <strong>Unlink</strong> button next to the Autotask company name</li>
|
||||
<li>Confirm the unmapping</li>
|
||||
</ol>
|
||||
|
||||
<p>Existing tickets remain linked to the Autotask company, but new tickets will not be created until the customer is mapped again.</p>
|
||||
|
||||
<h2>Exporting Customer Data</h2>
|
||||
|
||||
<p>You can export all customer data to a CSV file for backup, reporting, or migration purposes.</p>
|
||||
|
||||
<ol>
|
||||
<li>Navigate to the <strong>Customers</strong> page</li>
|
||||
<li>Click the <strong>Export Customers</strong> button at the top of the page</li>
|
||||
<li>At the top, click the <strong>Export CSV</strong> button</li>
|
||||
<li>A CSV file will be downloaded containing:
|
||||
<ul>
|
||||
<li>Customer name, contact person, email, phone, notes</li>
|
||||
<li>Customer name</li>
|
||||
<li>Active status</li>
|
||||
<li>Autotask company mapping (if applicable)</li>
|
||||
<li>Autotask company mapping (company ID and name, if applicable)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
@ -215,9 +275,9 @@
|
||||
|
||||
<ol>
|
||||
<li>Navigate to the <strong>Customers</strong> page</li>
|
||||
<li>Click the <strong>Import Customers</strong> button</li>
|
||||
<li>Select your CSV file (must match the export format)</li>
|
||||
<li>Click <strong>Upload</strong></li>
|
||||
<li>At the top, click the <strong>Browse...</strong> button to select your CSV file</li>
|
||||
<li>Select the CSV file (must match the export format)</li>
|
||||
<li>Click the <strong>Import CSV</strong> button</li>
|
||||
<li>The system will:
|
||||
<ul>
|
||||
<li>Create new customers if they don't exist</li>
|
||||
@ -258,7 +318,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>3</td>
|
||||
<td>(Optional) Map to Autotask company</td>
|
||||
<td>(Optional) Map to Autotask company via Edit dialog</td>
|
||||
<td>Tickets can be created in Autotask for failed backups</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -268,7 +328,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>5</td>
|
||||
<td>(If needed) Deactivate customer</td>
|
||||
<td>(If needed) Deactivate customer via Edit dialog</td>
|
||||
<td>Jobs hidden from operational views</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user