Difference between revisions of "Admin Area"

Latest revision as of 19:26, 8 February 2023

WHMCS 8.0 Admin Dashboard

The Admin Area is the portal that admins access when they work within WHMCS. The WHMCS admin area has over 125 interface or feature pages, each often containing multiple sub-interfaces.

You can access the Admin Area by following the steps below to log in as an admin. Then, use the navigation tools to find the WHMCS features you want to use.

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. The Admin Dashboard will display.

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.

Top Navigation

The top navigation bar allows access to all of WHMCS's features through a series of menus:

The Configuration Menu in WHMCS 8.0

+ — 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, Apps & Integrations, 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.

Sidebar Navigation

The sidebar navigation menu displays links and information that relate to the current interface.

For example, when you go to Configuration () > Manage Admins or, prior to WHMCS 8.0, Setup > Staff Management > Administrator Users, 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 in WHMCS 8.0

Intelligent Search in WHMCS 8.0

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

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 Hook Documentation.

Dashboard

The Admin Dashboard in WHMCS 8.0

The Admin Dashboard displays individual widgets. Each admin can arrange, maximise, or minimize these widgets and enable or disable them entirely for different administrator roles.

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.

We rely on the contributions of our users for language translations. If you notice any discrepancies or phrasings that you want to improve, we welcome you to submit your suggestions for change to our support team. We thank you for your help to ensure our users have the best experience possible, whatever their language.

Admin Directory URL

We recommend customizing the Admin Area's URL by renaming the default admin directory's name and updating it in the configuration.php file. This makes it harder for bots and other malicious users to access the login page.

The admin directory name can only contain alphanumeric characters (a-z and 0-9), numerals (0-9), hyphens (-), and underscores (_).
You cannot move the admin directory outside of the WHMCS installation's root directory.

For steps to rename the admin directory and troubleshoot issues, see Renaming the WHMCS Admin Directory and Troubleshooting Admin Directory Errors.

@@ Line 1: / Line 1: @@
+[[File:NewLookDashboard.png|300px|thumb|right|WHMCS 8.0 Admin Dashboard]]
+The Admin Area is the portal that admins access when they work within WHMCS. The WHMCS admin area has over 125 interface or feature pages, each often containing multiple sub-interfaces.
+You can access the Admin Area by following the [[#Logging_In|steps below]] to log in as an admin. Then, use [[#Top_Navigation|the navigation tools]] to find the WHMCS features you want to use.
 ==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'''. The [[Admin Dashboard]] will display.
+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]].
+== Default Theme ==
-To login to the WHMCS admin area, navigate to the admin directory within your installation.
+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.
-For example if you installed WHMCS @ https://billing.example.com/ then you would access the admin area by visiting https://billing.example.com/admin/
+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==
-If you have followed the [[Further Security Steps]] and renamed your admin directory, you will need to use the custom name you have setup.
+The top navigation bar allows access to all of WHMCS's features through a series of menus:
-===IP Banning===
+[[File:ConfigurationMenu.png|200px|thumb|right|The Configuration Menu in WHMCS 8.0]]
-If multiple failed login attempts are detected from the same IP, an IP ban will be enforced.
+* '''+''' — A menu of shortcuts to create new items.
+* Menus for each main area of WHMCS.
+* '''<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-wrench" aria-hidden="true"></i>''' — The '''Configuration''' menu. Click to access '''System Settings''', '''System Logs''', '''[[Apps_and_Integrations|Apps & Integrations]]''', and many other items.
+* '''<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, new version highlights, and license information for your WHMCS installation.
-If you get banned, you can wait either wait for the ban to expire or manually remove the ban via the database.  By default the ban lasts for 15 minutes. You can adjust the length of time the ban is enforced for in '''General Settings > Security'''.  For more information on manually removing a banned IP, please refer to our [[FAQs]].
+==Sidebar Navigation==
-===Password Resets===
+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>) > [[Administrator Users|Manage Admins]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Administrator Users''', the sidebar menu displays links to all of the other system setting-related pages. If you navigate to the list of orders at '''Orders > [[Order Management|List All Orders]]''', the sidebar menu will include items from the '''Orders''' menu instead.
-If a password is lost or forgotten, you can request a password reset from the login page.
+==Search==
-Upon requesting a password reset, you will receive an email containing a link that will allow you to set a new password.
+There are two primary methods of search: '''Intelligent Search''' and '''Advanced Search'''. Both of these search options are available from any page.
-If you fail to receive the email, or have disabled the forgotten password option, instructions for resetting the admin password can be found in our [[FAQs]].
+[[File:AdvancedSearch.png|200px|thumb|left|Advanced Search in WHMCS 8.0]]
-==Templates==
+[[File:IntelligentSearch.png|200px|thumb|right|Intelligent Search in WHMCS 8.0]]
-The admin area comes with 2 templates as standard:
+'''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.
-*'''Blend''' - The current default template featuring a responsive design and compatible with laptops, tablets and mobile devices.
+=== Intelligent Search ===
-*'''V4''' - A web 2.0 styled interface that was the default until Version 5.0.
-You can customise and create your own custom admin area templates. Please refer to [[Admin Area Template Files]] for more information.
+Intelligent Search allows you to perform the following search types:
-===Choosing your admin template===
+* 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
-Each administrator user has their own preference that controls the admin area theme/template they see and use.
+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.
-To see and customise the template that you use for your own admin user, simply navigate to '''My Account''' using the top navigation bar.
+==== Shortcuts ====
-To see and change the template used by other administrator users, if you have permission, navigate to '''Setup > Staff Management > Administrator Users'''
+You can use the following shortcuts with Intelligent Search:
-==Search==
+* Enter/Return: Perform a search
+* Escape: Close the search results
+==== Search Results ====
-There are 2 primary methods of search - '''Intelligent Search''' & '''Advanced Search'''.  Both of these search options are available from any page.
+[[File:intelligent_search_show_more.png|250px|thumb|Show More Results]]
-* '''Intelligent Search''' is located at the top right of every page. To use it, enter a search term and hit enter. Results are dynamically fetched and displayed instantly. 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.
+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.
-'''Advanced Search''' is located 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 will take you to the exact match or list of possible matches.
+To view any additional results, click on this link. Only one category can be expanded at a time in this way.
-==Widgets==
+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].
-The admin homepage dashboard is made up of a number of individual 'widgets'. These widgets can be arranged and maximised/minimized by each individual member of staff and enabled/disabled entirely for different administrator roles.
-Further Reading:
+==Dashboard==
-*[[Widgets]]
-*[[Creating_a_Widget]]
+[[File:Dashboard.png|600px|thumb|center|The Admin Dashboard in WHMCS 8.0]]
+The [[Admin Dashboard]] displays individual [[Widgets|widgets]]. Each admin can arrange, maximise, or minimize these widgets and enable or disable them entirely for different administrator roles.
 ==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 (<i class="fa fa-user-circle" aria-hidden="true"></i>) > [[My Account]]''' or, prior to WHMCS 8.0, directly from the top navigation bar.
+Language files for the admin area are in the <tt>/admin/lang/</tt> 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 [https://developers.whmcs.com/languages/overrides/ Developer Documentation].
+<div class="docs-alert-warning">
+We rely on the contributions of our users for language translations. If you notice any discrepancies or phrasings that you want to improve, we welcome you to submit your suggestions for change to our support team. We thank you for your help to ensure our users have the best experience possible, whatever their language.
+</div>
-Each administrator user can set their own language preference via the '''My Account''' page accessed from the top navigation bar.
+== Admin Directory URL ==
-Language files for the admin area can be found in the '''/admin/lang/''' directory.
+We recommend customizing the Admin Area's URL by renaming the default <tt>admin</tt> directory's name and updating it in the <tt>configuration.php</tt> file. This makes it harder for bots and other malicious users to access the login page.
-If you wish to customise the translations for a given language, an overrides file should be created. You can learn more about overrides and how to use them in our [https://developers.whmcs.com/languages/overrides/ Developer Documentation].
+* The admin directory name can only contain alphanumeric characters (a-z and 0-9), numerals (0-9), hyphens (-), and underscores (_).
+* You '''cannot''' move the admin directory outside of the WHMCS installation's root directory.
-<div class="docs-alert-warning">We rely on the contributions of our users for language translations. If you notice any discrepancies or phrasings that you feel could be imported, we welcome you to submit your suggestions for change to our support team. We thank you for your help to ensure our users have the best experience possible, whatever their language.</div>
+For steps to rename the <tt>admin</tt> directory and troubleshoot issues, see [https://help.whmcs.com/m/installation/l/1650304-renaming-the-whmcs-admin-directory Renaming the WHMCS Admin Directory] and [https://help.whmcs.com/m/troubleshooting/l/1650308-troubleshooting-admin-directory-errors Troubleshooting Admin Directory Errors].

Documentation