Difference between revisions of "Admin Area"
| Line 1: | Line 1: | ||
| + | The Admin Area is the portal that administrator users access to work within WHMCS. | ||
| + | |||
==Logging In== | ==Logging In== | ||
| − | + | ||
[[File:Videotutorial.png|center|link=https://www.youtube.com/watch?v=M_Ak62s_L1k&list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb&index=3&t=0sJb&index=4&t=0s|Watch Video Tutorial]] | [[File:Videotutorial.png|center|link=https://www.youtube.com/watch?v=M_Ak62s_L1k&list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb&index=3&t=0sJb&index=4&t=0s|Watch Video Tutorial]] | ||
| − | + | ||
| − | + | Before you log in, navigate 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]], you will need to use the custom name you have set up. | |
| − | + | ||
| − | For example, if you installed WHMCS at https://billing.example.com/, you would access | + | To log in, enter your admin username and password. If you experience problems logging in, you can [[FAQs|request a password reset]]. If problems continue, your IP address may have been [[FAQs|banned due to multiple failed login attempts]]. |
| − | + | ||
| − | If you have followed the [[Further Security Steps]] | + | ==Admin UI Themes== |
| − | + | ||
| − | + | In WHMCS 8.0 and later, the Admin Area uses '''Blend'''. This theme features a responsive design and is compatible with laptops, tablets and mobile devices. | |
| − | + | ||
| − | + | WHMCS 8.0 updated the Blend theme with a new look and improvements to make using WHMCS easier and more efficient. Changes include slimmer page framing, compact navigation, better visibility for upgrades and automation statuses, and the addition of a shortcut menu for creating new items. | |
| − | + | ||
| − | If you | + | Prior to WHMCS 8.0, you could also use '''V4''', a web 2.0-styled theme that was the default until WHMCS 5.0. |
| − | + | ||
| − | + | 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. | |
| − | + | ||
| − | If | + | [[File:TopNavigation.png|200px|thumb|left|Navigation Bar in WHMCS 8.0]] |
| − | + | ||
| − | == | + | In WHMCS 8.0 and later, it includes: |
| − | + | ||
| − | + | * '''+''' — 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 [[#Search|intelligent search]]. | |
| − | + | * '''<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. | |
| − | You can | + | * '''<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-question-circle" aria-hidden="true"></i>''' — Click to access WHMCS documentation, technical support, forums, and new version highlights, and to view license information for your WHMCS installation. | |
| − | == | + | |
| − | + | [[File:ConfigurationMenu.png|200px|thumb|left|The Configuration Menu in WHMCS 8.0]] | |
| − | + | ||
| − | + | ==Sidebar Navigation== | |
| − | + | ||
| − | + | The sidebar navigation menu displays links and information in context with the page you're currently using. | |
| − | + | ||
| − | + | [[File:LeftNavigation.png|200px|thumb|left|Left Navigation Menu in WHMCS 8.0]] | |
| + | |||
| + | 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. | ||
| + | |||
==Search== | ==Search== | ||
| − | + | ||
| − | There are two primary methods of search: '''Intelligent Search''' and '''Advanced Search'''. | + | There are two primary methods of search: '''Intelligent Search''' and '''Advanced Search'''. Both of these search options are available from any page. |
| − | + | ||
| − | + | [[File:IntelligentSearch.png|200px|thumb|left|Intelligent Search in WHMCS 8.0]] | |
| − | + | ||
| − | + | '''[[Intelligent Search]]''' is at the top right of every page. To use it, enter a search term and press enter. The system fetches them dynamically and displays them 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. | |
| − | + | ||
| − | == | + | [[File:AdvancedSearch.png|200px|thumb|left|Advanced 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. | ||
| + | |||
| + | ==Dashboard== | ||
| + | |||
| + | [[File:Dashboard.png|200px|thumb|left|The Admin Dashboard in WHMCS 8.0]] | ||
| + | |||
The [[Admin_Dashboard|admin homepage dashboard]] is made up of a number of individual 'widgets'. Each staff member can arrange, maximise, or minimize these widgets and enable or disable them entirely for different administrator roles. | The [[Admin_Dashboard|admin homepage dashboard]] is made up of a number of 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: | ||
*[[Widgets]] | *[[Widgets]] | ||
*[[Creating_a_Widget]] | *[[Creating_a_Widget]] | ||
| − | + | ||
==Languages== | ==Languages== | ||
| − | + | ||
The WHMCS admin area has full multi-language support. | 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 | + | 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 | + | 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]. | 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> | <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> | ||
Revision as of 19:48, 8 September 2020
The Admin Area is the portal that administrator users access to work within WHMCS.
Contents
Logging In
Before you log in, navigate 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 Further Security Steps, you will need to use the custom name you have set up.
To log in, enter your admin username and password. 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.
Admin UI Themes
In WHMCS 8.0 and later, the Admin Area uses Blend. This theme features a responsive design and is compatible with laptops, tablets and mobile devices.
WHMCS 8.0 updated the Blend theme with a new look and improvements to make using WHMCS easier and more efficient. Changes include slimmer page framing, compact navigation, better visibility for upgrades and automation statuses, and the addition of a shortcut menu for creating new items.
Prior to WHMCS 8.0, you could also use V4, a web 2.0-styled theme that was the default until WHMCS 5.0.
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.
In WHMCS 8.0 and later, it includes:
- + — A menu of shortcuts to create new items.
- Menus for each main area of WHMCS.
- — Click to use the intelligent search.
- — Click to go to Automation Status.
- — The Configuration menu. Click to access System Settings, System Logs, and many other items.
- — Click to access your account information and notes, visit the Client Area, or log out.
- — Click to access WHMCS documentation, technical support, forums, and new version highlights, and to view license information for your WHMCS installation.
The sidebar navigation menu displays links and information in context with the page you're currently using.
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.
Intelligent Search is at the top right of every page. To use it, enter a search term and press enter. The system fetches them dynamically and displays them 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.
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.
Dashboard
The admin homepage dashboard is made up of a number of 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:
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.