Difference between revisions of "Hide Inactive Clients"
m |
(→What is an Inactive Client?) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.7 and above</div> | <div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.7 and above</div> | ||
| − | ==What is | + | The Hide Inactive Clients feature is intended to optimise speed and efficiency when navigating and searching clients and their products and services within the admin area. It does this by hiding clients and their associated products and services from result sets when the client is in an inactive status. |
| − | + | ||
| − | + | ==What is an Inactive Client?== | |
| + | |||
| + | An inactive client is any client whose client status is not ''Active''. | ||
| + | |||
| + | By default, WHMCS automatically manages the client status attribute based on the client's products, services, addons and domains. If a client has one or more active services, they are set to ''Active''. Clients without any active services will be set to ''Inactive''. For more information, see [[Clients:Profile_Tab#Status|Client Statuses]]. | ||
| + | |||
| + | ==How does it work?== | ||
| + | |||
| + | On supported pages, list and search results will hide inactive clients by default. | ||
| + | |||
| + | When this occurs, a toggle button will be visible at the top of the results list. The toggle button shows the number of inactive clients currently being hidden. Toggling the button will display the hidden inactive clients. | ||
[[File:hide_inactive_toggle.png|thumb|Hide Inactive Clients Toggle]] | [[File:hide_inactive_toggle.png|thumb|Hide Inactive Clients Toggle]] | ||
| − | Hide Inactive Clients | + | If a list or search returns only inactive clients, then the toggle will default to Off and inactive clients will be displayed. |
| + | |||
| + | ==Where is Hide Inactive Clients supported?== | ||
| + | |||
| + | The following admin area client and product lists implement the Hide Inactive Clients functionality at this time: | ||
| + | |||
* Clients List (Clients -> View/Search Clients) | * Clients List (Clients -> View/Search Clients) | ||
* Client Product List (Clients -> Products/Services) | * Client Product List (Clients -> Products/Services) | ||
* Client Domains List (Clients -> Domain Registrations) | * Client Domains List (Clients -> Domain Registrations) | ||
* Client Addons List (Clients -> Service Addons) | * Client Addons List (Clients -> Service Addons) | ||
| − | |||
| − | + | Hide Inactive Clients is also implemented into [[Intelligent Search]]. By default search results will render with inactive clients hidden, with a toggle option provided to view them. | |
| − | |||
Latest revision as of 20:53, 27 December 2022
The Hide Inactive Clients feature is intended to optimise speed and efficiency when navigating and searching clients and their products and services within the admin area. It does this by hiding clients and their associated products and services from result sets when the client is in an inactive status.
What is an Inactive Client?
An inactive client is any client whose client status is not Active.
By default, WHMCS automatically manages the client status attribute based on the client's products, services, addons and domains. If a client has one or more active services, they are set to Active. Clients without any active services will be set to Inactive. For more information, see Client Statuses.
How does it work?
On supported pages, list and search results will hide inactive clients by default.
When this occurs, a toggle button will be visible at the top of the results list. The toggle button shows the number of inactive clients currently being hidden. Toggling the button will display the hidden inactive clients.
If a list or search returns only inactive clients, then the toggle will default to Off and inactive clients will be displayed.
Where is Hide Inactive Clients supported?
The following admin area client and product lists implement the Hide Inactive Clients functionality at this time:
- Clients List (Clients -> View/Search Clients)
- Client Product List (Clients -> Products/Services)
- Client Domains List (Clients -> Domain Registrations)
- Client Addons List (Clients -> Service Addons)
Hide Inactive Clients is also implemented into Intelligent Search. By default search results will render with inactive clients hidden, with a toggle option provided to view them.