Application Links

Application Links in cPanel

Application Links allow customers to seamlessly transition from cPanel or WP Squared to the WHMCS Client Area using Single Sign-On. When you enable Application Links, those icons will display automatically within the control panel.

Using this feature in the Admin Area requires the Configure Application Links admin role permission, which WHMCS only assigns to Full Administrator admins by default.

You can access this feature at Configuration () > System Settings > Application Links.

To use Application Links, you must enable the desired applications. Separately, you can enable and configure the individual links for each application.

  • Before you can use Application Links, you must first add at least one server that runs a supported version of cPanel & WHM or WP Squared to your WHMCS installation.
  • You can choose to configure individual links for an application before you enable Application Links for the application itself, or you can configure them after enabling the application. The system syncs your changes and pushes them out across all of your servers regardless of order.

Activate Applications

To activate Application Links for an application, go to Configuration () > System Settings > Application Links.

Configuring Application Links with cPanel Off

Set the desired application toggle to ON to activate it. The system will sync the change automatically.

Configuring Application Links with cPanel On

  • Syncing this change may require several seconds. The grey DISABLED badge will change to a green ACTIVE badge when the sync is finished.
  • If you navigate away from the page while the sync is still in progress, it may not fully sync all links.

To configure the links for an application, click Configure under that application’s toggle.

  1. Go to Configuration () > System Settings > Application Links.
  2. Click Configure for the desired application. A list of links and configuration settings will appear.
    Configuring links for an application in Application Links
  3. For each link that you want to configure (see below):
    1. Toggle links to On to display them or Off to hide them.
    2. If you want to change a link’s display name, enter the desired name under Display Name.
  4. Use the arrows on each row to reorder the display order of the links.
  5. Click Save Changes. If you have enabled or disabled Application Links for an application, the status indicator will update to reflect that the syncing of your configuration changes has begun.
  6. Wait for the sync to finish.
    If you navigate away from the page while the sync is still in progress, it may not fully sync all links.
    When the process finishes, the status indicator will update to indicate which applications and links are enabled or disabled.

You can enable and configure custom display labels for the following links:

Destination TypeDestination
Ordering
  • Upgrade/Downgrade
  • Register New Domain
  • Transfer a Domain
Support
  • Open Ticket
  • View Ticket History
  • News & Announcements
  • Download Resources
  • Search our Knowledgebase
  • Check Network Status
Account
  • Manage Profile
  • View Billing Information
  • Manage Billing Information
  • View Email History
  • View Invoice History

The Application Link system has its own activity log. The log displays entries for the last provisioning operation that you performed for a given application (activation, configuration changes, or deactivation).

To access the log for an application, click View Log.

The Application Link logs use the following logging levels:

  • Debug — Event-based logging, like the start and completion of processes.
  • Information — The system is attempting to provision links to a server that does not support Application Links. Typically, this means that it requires a newer version of the third-party application.
  • Notice — No servers for the given application support Application Links. Typically, this means it requires a newer version of the third-party application.
  • Warning — Error messages that the application or module itself returned. These typically require attention.

You can safely ignore some of the warnings that appear in this log. For example:

  • A cPanel Account Username not found error indicates that your WHMCS installation has records for a cPanel account that does not exist on the server.
  • A The value of “user” may not be empty error indicates that cPanel accounts on your WHMCS installation do not have a specified username, and so the system cannot provision them.

User Permissions

There is a one-to-one relationship between a given cPanel or WP Squared hosting account and a WHMCS client. Because there is not a multi-user system for cPanel or WP Squared accounts, you must use single sign-on to authenticate as the WHMCS account owner. While WHMCS can control which users have permission to use single sign-on to authenticate with cPanel or WP Squared, the reverse is not currently possible. For this reason, restricting single sign-on is possible at the user and account levels.

  • The client account owner can revoke the Single Sign-On permission for the user at Hello, Name! > User Management in the Client Area. Admins can remove this permission by clicking Manage User in the client’s profile’s Users tab.
  • The client account owner can disable single sign-on for the account at Hello, Name! > Security Settings. Admins can disable Allow Single Sign-On in the client profile’s Profile tab.
application-links single-sign-on logs authentication hosting-accounts wp-squared cpanel

Last modified: November 19, 2024