Difference between revisions of "Admin Area"
(→Dashboard) |
|||
| Line 1: | Line 1: | ||
| − | The Admin Area is the portal that administrator users access to work within WHMCS. | + | [[File:NewLookDashboard.png|300px|thumb|right|WHMCS 8.0 Admin Dashboard]] |
| − | + | ||
| + | The Admin Area is the portal that administrator users access to work within WHMCS. The WHMCS admin area has over 125 interface pages, each often containing multiple sub-interfaces. | ||
| + | |||
==Logging In== | ==Logging In== | ||
| − | + | To log in to the WHMCS admin area: | |
| − | + | ||
| − | + | # Go to your installation's <tt>admin</tt> directory. | |
| − | + | #* For example, if you installed WHMCS at <tt>https://billing.example.com/</tt>, you would access <tt>https://billing.example.com/admin/</tt>. | |
| − | + | #* If you have followed the [[Further Security Steps|recommended security steps]], you will need to use the custom name you have set up. | |
| − | + | # Enter your admin username and password. | |
| − | == | + | # Click '''Login'''. |
| − | + | ||
| − | + | If you experience problems logging in, you can [[Resetting an Admin Password|request a password reset]]. If problems continue, your IP address may have been [[Removing an IP Address Ban|banned due to multiple failed login attempts]]. | |
| − | + | ||
| − | WHMCS 8.0 | + | == Default Theme == |
| − | + | ||
| − | + | We updated the default Admin Area theme in WHMCS 8.0 and later to '''Blend''', and the sections below only describe the interface in WHMCS 8.0 and higher. In this update we: | |
| − | + | * Replaced the '''Setup''' menu with the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>)''' menu. | |
| + | * Added the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings''' and '''[[Automation Status]] (<i class="fa fa-cogs" aria-hidden="true"></i>)''' interfaces. | ||
| + | * Added new update icon '''(<i class="fa fa-download" aria-hidden="true"></i>)''' that appears whenever an update is available. | ||
| + | |||
You can find other templates in the WHMCS Marketplace or customize and create your own. For more information, see [[Admin Area Template Files]]. | You can find other templates in the WHMCS Marketplace or customize and create your own. For more information, see [[Admin Area Template Files]]. | ||
==Top Navigation== | ==Top Navigation== | ||
| − | The top navigation bar allows access to all of WHMCS's features through a series of menus | + | [[File:TopNavigation.png|200px|thumb|Navigation Bar in WHMCS 8.0]] |
| − | + | ||
| − | [[File: | + | The top navigation bar allows access to all of WHMCS's features through a series of menus: |
| − | + | ||
| − | + | [[File:ConfigurationMenu.png|200px|thumb|right|The Configuration Menu in WHMCS 8.0]] | |
| − | + | ||
* '''+''' — A menu of shortcuts to create new items. | * '''+''' — A menu of shortcuts to create new items. | ||
* Menus for each main area of WHMCS. | * Menus for each main area of WHMCS. | ||
| − | * '''<i class="fa fa-search" aria-hidden="true"></i>''' — Click to use the | + | * '''<i class="fa fa-search" aria-hidden="true"></i>''' — Click to use the Intelligent Search (below). |
* '''<i class="fa fa-cogs" aria-hidden="true"></i>''' — Click to go to [[Automation Status]]. | * '''<i class="fa fa-cogs" aria-hidden="true"></i>''' — Click to go to [[Automation Status]]. | ||
* '''<i class="fa fa-wrench" aria-hidden="true"></i>''' — The '''Configuration''' menu. Click to access '''System Settings''', '''System Logs''', and many other items. | * '''<i class="fa fa-wrench" aria-hidden="true"></i>''' — The '''Configuration''' menu. Click to access '''System Settings''', '''System Logs''', and many other items. | ||
| − | * '''<i class="fa fa-user-circle" aria-hidden="true"></i>''' — Click to access your account information and notes, visit the Client Area, or log out. | + | * '''<i class="fa fa-user-circle" aria-hidden="true"></i>''' — Click to access your admin account information and notes, visit the Client Area, or log out. |
| − | * '''<i class="fa fa-question-circle" aria-hidden="true"></i>''' — Click to access WHMCS documentation, technical support, forums, | + | * '''<i class="fa fa-question-circle" aria-hidden="true"></i>''' — Click to access WHMCS documentation, technical support, forums, new version highlights, and license information for your WHMCS installation. |
| − | |||
| − | |||
==Sidebar Navigation== | ==Sidebar Navigation== | ||
| − | The sidebar navigation menu displays links and information | + | The sidebar navigation menu displays links and information that relate to the current interface. |
For example, when you go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Manage Admins''', the sidebar menu displays links to all of the other system setting-related pages. If you navigate to the list of orders at '''Orders > List All Orders''', the sidebar menu will include items from the '''Orders''' menu instead. | For example, when you go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Manage Admins''', the sidebar menu displays links to all of the other system setting-related pages. If you navigate to the list of orders at '''Orders > List All Orders''', the sidebar menu will include items from the '''Orders''' menu instead. | ||
| Line 53: | Line 56: | ||
'''Advanced Search''' is in the bottom left of the sidebar on every page. With advanced search, you can choose exactly what entity type and field you wish to perform a search for. Entering a search term here and submitting it will take you to the exact match or list of possible matches. | '''Advanced Search''' is in the bottom left of the sidebar on every page. With advanced search, you can choose exactly what entity type and field you wish to perform a search for. Entering a search term here and submitting it will take you to the exact match or list of possible matches. | ||
| − | ''' | + | '''Intelligent Search''' is at the top right of every page. To use it, enter a search term and press enter. Starting from when you enter three or more characters, the system searches as you type. Intelligent search makes a best guess attempt at what you are searching for and will display the most relevant matches it is able to find. |
| + | |||
| + | === Intelligent Search === | ||
| + | |||
| + | Intelligent Search allows you to perform the following search types: | ||
| + | |||
| + | * Numeric searches — Entering a numeric search term will trigger searching for Client IDs, User IDs, Contact IDs, Service IDs, Domain IDs, and Invoice IDs as well as the last four digits of Clients' credit cards. There is no minimum length restriction. | ||
| + | * Alphanumeric searches — Entering a search term containing a minimum of three letters and numbers will trigger a search of: | ||
| + | ** Clients, Users, and Contacts: Name, Company Name, Email Address, Address, Phone Number | ||
| + | ** Services and Domains: Domain Name, Username, Dedicated IP, Assigned IP, Notes | ||
| + | ** Invoices: Invoice ID or Invoice Number | ||
| + | ** Support Tickets: Ticket ID, Mask, or Subject | ||
| + | |||
| + | Automatic searching can be toggled off using a slide toggle button located towards the bottom of the intelligent search results pane. Disabling search as you type will persist for the duration of your current admin session. When search as you type is disabled, you must press enter to initiate a search. | ||
| + | |||
| + | ==== Shortcuts ==== | ||
| + | |||
| + | You can use the following shortcuts with Intelligent Search: | ||
| + | |||
| + | * Enter/Return: Perform a search | ||
| + | * Escape: Close the search results | ||
| + | |||
| + | ==== Search Results ==== | ||
| + | |||
| + | [[File:intelligent_search_show_more.png|250px|thumb|Show More Results]] | ||
| + | |||
| + | Search results are grouped into categories. By default, the first 10 results will be displayed. If more than 10 results are available, a "Show More" link will be displayed. | ||
| + | |||
| + | To view any additional results, click on this link. Only one category can be expanded at a time in this way. | ||
| + | |||
| + | Apps and modules can integrate with intelligent search using the Hooks system. For more information, see our [https://developers.whmcs.com/hooks-reference/everything-else/#intelligentsearch Hook Documentation]. | ||
==Dashboard== | ==Dashboard== | ||
| Line 59: | Line 92: | ||
[[File:Dashboard.png|600px|thumb|center|The Admin Dashboard in WHMCS 8.0]] | [[File:Dashboard.png|600px|thumb|center|The Admin Dashboard in WHMCS 8.0]] | ||
| − | The [[Admin_Dashboard|admin homepage dashboard]] | + | The [[Admin_Dashboard|admin homepage dashboard]] displays individual 'widgets'. Each staff member can arrange, maximise, or minimize these widgets and enable or disable them entirely for different administrator roles. |
| − | For more information: | + | For more information, see: |
*[[Widgets]] | *[[Widgets]] | ||
*[[Creating_a_Widget]] | *[[Creating_a_Widget]] | ||
Revision as of 18:45, 25 January 2022
The Admin Area is the portal that administrator users access to work within WHMCS. The WHMCS admin area has over 125 interface pages, each often containing multiple sub-interfaces.
Contents
Logging In
To log in to the WHMCS admin area:
- Go to your installation's admin directory.
- For example, if you installed WHMCS at https://billing.example.com/, you would access https://billing.example.com/admin/.
- If you have followed the recommended security steps, you will need to use the custom name you have set up.
- Enter your admin username and password.
- Click Login.
If you experience problems logging in, you can request a password reset. If problems continue, your IP address may have been banned due to multiple failed login attempts.
Default Theme
We updated the default Admin Area theme in WHMCS 8.0 and later to Blend, and the sections below only describe the interface in WHMCS 8.0 and higher. In this update we:
- Replaced the Setup menu with the Configuration () menu.
- Added the Configuration () > System Settings and Automation Status () interfaces.
- Added new update icon () that appears whenever an update is available.
You can find other templates in the WHMCS Marketplace or customize and create your own. For more information, see Admin Area Template Files.
The top navigation bar allows access to all of WHMCS's features through a series of menus:
- + — A menu of shortcuts to create new items.
- Menus for each main area of WHMCS.
- — Click to use the Intelligent Search (below).
- — Click to go to Automation Status.
- — The Configuration menu. Click to access System Settings, System Logs, and many other items.
- — Click to access your admin account information and notes, visit the Client Area, or log out.
- — Click to access WHMCS documentation, technical support, forums, new version highlights, and license information for your WHMCS installation.
The sidebar navigation menu displays links and information that relate to the current interface.
For example, when you go to Configuration () > Manage Admins, the sidebar menu displays links to all of the other system setting-related pages. If you navigate to the list of orders at Orders > List All Orders, the sidebar menu will include items from the Orders menu instead.
Search
There are two primary methods of search: Intelligent Search and Advanced Search. Both of these search options are available from any page.
Advanced Search is in the bottom left of the sidebar on every page. With advanced search, you can choose exactly what entity type and field you wish to perform a search for. Entering a search term here and submitting it will take you to the exact match or list of possible matches.
Intelligent Search is at the top right of every page. To use it, enter a search term and press enter. Starting from when you enter three or more characters, the system searches as you type. Intelligent search makes a best guess attempt at what you are searching for and will display the most relevant matches it is able to find.
Intelligent Search
Intelligent Search allows you to perform the following search types:
- Numeric searches — Entering a numeric search term will trigger searching for Client IDs, User IDs, Contact IDs, Service IDs, Domain IDs, and Invoice IDs as well as the last four digits of Clients' credit cards. There is no minimum length restriction.
- Alphanumeric searches — Entering a search term containing a minimum of three letters and numbers will trigger a search of:
- Clients, Users, and Contacts: Name, Company Name, Email Address, Address, Phone Number
- Services and Domains: Domain Name, Username, Dedicated IP, Assigned IP, Notes
- Invoices: Invoice ID or Invoice Number
- Support Tickets: Ticket ID, Mask, or Subject
Automatic searching can be toggled off using a slide toggle button located towards the bottom of the intelligent search results pane. Disabling search as you type will persist for the duration of your current admin session. When search as you type is disabled, you must press enter to initiate a search.
Shortcuts
You can use the following shortcuts with Intelligent Search:
- Enter/Return: Perform a search
- Escape: Close the search results
Search Results
Search results are grouped into categories. By default, the first 10 results will be displayed. If more than 10 results are available, a "Show More" link will be displayed.
To view any additional results, click on this link. Only one category can be expanded at a time in this way.
Apps and modules can integrate with intelligent search using the Hooks system. For more information, see our Hook Documentation.
Dashboard
The admin homepage dashboard displays individual 'widgets'. Each staff member can arrange, maximise, or minimize these widgets and enable or disable them entirely for different administrator roles.
For more information, see:
Languages
The WHMCS admin area has full multi-language support.
Each administrator user can set their own language preference via the My Account page, which you can access at Account () > My Account or, prior to WHMCS 8.0, directly from the top navigation bar.
Language files for the admin area are in the /admin/lang/ directory.
To customise the translations for a given language, create an overrides file. You can learn more about overrides and how to use them in our Developer Documentation.