Application Links and cPanel Quick Start Guide

From WHMCS Documentation

Revision as of 12:18, 19 February 2016 by John (talk | contribs) (Getting Started)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Application Links combines WHMCS Single Sign-On with cPanel & WHM to provide access to 14 of the most commonly used areas of WHMCS from directly within the cPanel user interface.

CPanelAppLinkingUI.png

Application Links allows end users to transition quickly and effortlessly from web hosting control panel to billing and support resources without having to re-authenticate, removing the separation between control panel and billing, making it easier for customers to get help when they need it, and keeping your brand in customers minds.

Find out more in our launch announcement here.

Getting Started

Watch Video Tutorial


If you already have cPanel & WHM servers setup in your WHMCS installation, turning on Application Links is simply a button press away. The following steps assume you're already logged in to your WHMCS admin area.

  1. Navigate to Setup > Application Links
    Don't see this menu option? Ensure you are running WHMCS 6.2, have the Configure Application Links permission, and that your admin area templates are fully up-to-date.
  2. Slide the toggle setting from Off to On for cPanel
  3. The status indicator will update to reflect the provisioning of links has begun

Please wait while the process completes. If you have a lot of cPanel Accounts, this may take some time to complete. Do not navigate away from the page.

When complete the status indicator will update to show Application Links are Active for cPanel. Login to any cPanel account to verify the links are displayed.

Won't let you enable it? The option to enable Application Links will be unavailable if you do not have at least one active cPanel server configured
Requires cPanel & WHM Version 54 which entered RELEASE status on Monday, 25th January, 2016

Customising the Links

There are 14 possible links available with the cPanel Application Links integration.

You can choose which links appear, the labels they have and in which order they are displayed.

ApplicationLinksConfiguration.png

To configure application links:

  1. Click the Configure link under the status toggle
  2. A modal will load showing all the available cPanel Application Links. From here you can:
    • Slide the toggle setting on/off to enable/disable a given link
    • Customise the display label for a link
    • Drag and drop to re-order the display of links within the cPanel UI
  3. When you're happy with your changes, click Save Changes
  4. If Application Links are enabled, the status indicator will update to reflect the syncing of your configuration changes has begun
  5. Please wait while the process completes
  6. When complete the status indicator will update to show Application Links are Active for the application
Navigating away from the page while the sync is still in progress may leave some products/services without the new configuration.

Common Problems

When enabling Application Links, if the links fail to provision for any accounts you will receiving some warnings. The View Log button can be used to view those warnings. In most cases warnings can safely be ignored. Some examples of the types of warnings you may receive:

  • cPanel Account Username not found - indicates a cPanel account in your WHMCS system that is no longer present on the server
  • The value of “user” may not be empty - indicates one or more cPanel accounts in your WHMCS system have no username defined for them so the links are unable to be provisioned

More Information

For further help and information, please refer to the Application Links Full Documentation