Difference between revisions of "Application Links"

Latest revision as of 17:15, 28 August 2023

Application Linking allows end users and module developers to integrate with and use WHMCS Single Sign-On. WHMCS Single Sign-On allows trusted applications to authenticate users and send them to a desired page within the Client Area.

You can view a list of modules that support application linking at Configuration () > System Settings > Application Links or, prior to WHMCS 8.0, Setup > Application Links.

This requires the Configure Application Links permission, which WHMCS only assigns to Full Administrator-level users by default.

Supported Link Destinations

Supported link destinations include the following:

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

You can configure which of the above links your end users see and their display label text.

Enabling Application Links

The Application Links feature requires a supported version of cPanel & WHM or WP Squared.

To enable Application Links:

Go to Configuration () > System Settings > Application Links or, prior to WHMCS 8.0, Setup > Application Links. The system will display all of the installed modules that support Application Links.
Set the toggle to On next to the application that you wish to enable it for.
You can't enable Application Links until you configure at least one active server and assign it to the given module.
The status indicator will update to reflect that the system has started provisioning links. When the process finishes, the status indicator will update to show that Application Links are active for the application.

Warning
If you navigate away from the page while the provisioning is still in progress, the system may not fully provision all of the links for all of the products or services.

Configuring Application Links

You can customize the provisioned Application Links on a per-application basis, allowing you to choose exactly which links your end users receive and display label they use.

You can configure this before or while you enable application links. The system syncs any changes and pushes them out across all your servers.

To configure application links:

Go to Configuration () > System Settings > Application Links or, prior to WHMCS 8.0, Setup > Application Links.
Click Configure for the application you wish to make changes for. The supported Application Links will appear (see above). From here, you can:
- Toggle the setting on or off to enable or disable a given link.
- Customise the display label for a link.
- Reorder the display of links within the third-party application.
Click Save Changes. If you have enabled Application Links for the given application, the status indicator will update to reflect that the syncing of your configuration changes has begun. When the process finishes, the status indicator will update to show that Application Links are active for the application.

If you navigate away from the page while the sync is still in progress, the system may not fully sync all of the links for all of the products or services.

Disabling Application Links

To disable application links:

Go to Configuration () > System Settings > Application Links or, prior to WHMCS 8.0, Setup > Application Links.
Set the toggle to Off for the application that you wish to disable. The status indicator will update to reflect that the deprovisioning has begun. When the process finishes, the status indicator will update to show that Application Links are disabled for the application.

If you navigate away from the page while the deprovisioning is still in progress, the system may not fully deprovision all of the links for all of the products or services.

Reviewing the Application Link Log

Application Link provisioning has its own dedicated logging system. You will see View Log for each application that supports Application Links.

The log will display entries for the last provisioning operation that you performed for a given application (Activation, Configuration Changes, or Deactivation).

The log uses four 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 Linking. Typically, this means it requires a newer version of the third-party application.
Notice — No servers for the given application support Application Linking. 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.

Application Link Controls

There is a one-to-one relationship between a given cPanel or WP Squared 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. 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.

@@ Line 1: / Line 1: @@
-Application Linking is the simple way for end users and module developers to integrate with and use WHMCS Single Sign-On.
+Application Linking allows end users and module developers to integrate with and use [[WHMCS_Single_Sign-On|WHMCS Single Sign-On]]. WHMCS Single Sign-On allows trusted applications to authenticate users and send them to a desired page within the Client Area.
-WHMCS Single Sign-On allows trusted applications to authenticate users and send them to a desired page within the client area.
+You can view a list of modules that support application linking at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Application Links''' or, prior to WHMCS 8.0, '''Setup > Application Links'''.
+<div class="docs-alert-warning">
+This requires the '''Configure Application Links''' [[Administrator Roles|permission]], which WHMCS only assigns to '''Full Administrator'''-level users by default.
+</div>
+== Supported Link Destinations ==
 Supported link destinations include the following:
@@ Line 8: / Line 14: @@
 <div class="col-sm-4">
 '''Ordering'''
-* View/Order Addons
+* Upgrade/Downgrade
 * Register New Domain
 * Transfer a Domain
@@ Line 31: / Line 37: @@
 </div>
-You are able to configure which of the above links are provided to your end users and the display label text used for each.
+You can configure which of the above links your end users see and their display label text.
-==Managing Application Links==
+==Enabling Application Links==
-You can view and manage all modules that support application linking by navigating to ''Setup > Application Links''.
+[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=esAsImsRlcY&hd=1|Watch Video Tutorial]]
-From here you can view modules that support application linking, turn application linking on/off, view the application linking provisioning log and customise the links that will be provisioned.
+<div class="docs-alert-warning">
+The Application Links feature requires a supported version of [[CPanel/WHM|cPanel & WHM]] or [[WP Squared]].
+</div>
-<div class="docs-alert-info">Requires the ''Configure Application Links'' administrator permission which is assigned only to Full Administrator level users by default.</div>
+To enable Application Links:
-===Enabling Application Links===
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Application Links''' or, prior to WHMCS 8.0, '''Setup > Application Links'''. The system will display all of the installed modules that support Application Links.
+# Set the toggle to ''On'' next to the application that you wish to enable it for.<div class="docs-alert-success">You can't enable Application Links until you configure at least one active server and assign it to the given module.</div> The status indicator will update to reflect that the system has started provisioning links. When the process finishes, the status indicator will update to show that Application Links are active for the application.
-<div class="docs-alert-danger">Please be aware that cPanel & WHM Version 54 (scheduled to hit the release tier in January 2016) is required for Application Links. It is currently available in CURRENT and EDGE tiers.</div>
+<div class="docs-alert-warning">
+<span class="title">Warning</span><br />
+If you navigate away from the page while the provisioning is still in progress, the system may not fully provision all of the links for all of the products or services.
+</div>
-# Navigate to ''Setup > Application Links''
+==Configuring Application Links==
-# All installed modules that support Application Linking will be displayed
-# Slide the toggle setting from Off to '''On''' next to the Application you wish to enable it for<div class="docs-alert-success">The option to enable Application Links will be unavailable if you do not have at least one active server configured and assigned to the given module</div>
-# The status indicator will update to reflect the provisioning of links has begun
-# Please wait while the process completes
-# When complete the status indicator will update to show Application Links are Active for the application
-<div class="docs-alert-warning">Navigating away from the page while the provisioning is still in progress may leave some links not fully provisioned for all products/services.</div>
+You can customize the provisioned Application Links on a per-application basis, allowing you to choose exactly which links your end users receive and display label they use.
-===Configuring Application Links===
+[[File:ApplicationLinksConfiguration.png|500px]]
-The Application Links that are provisioned can be customised on a per Application basis allowing you to choose exactly which links are provided to your end users, and what display label they are displayed with.
+You can configure this before or while you enable application links. The system syncs any changes and pushes them out across all your servers.
-[[File:ApplicationLinksConfiguration.png]]
-Configuration can be performed before application links are enabled as well as while enabled.  Any changes are then synced and pushed out accross all your servers.
 To configure application links:
-# Navigate to ''Setup > Application Links''
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Application Links''' or, prior to WHMCS 8.0, '''Setup > Application Links'''.
-# Click the '''Configure''' link for the Application you wish to make changes for
+# Click '''Configure''' for the application you wish to make changes for. The supported Application Links will appear (see above). From here, you can:
-# A modal will load showing all supported Application Links by that module (see screenshot above). From here you can:
+#* Toggle the setting on or off to enable or disable a given link.
-#* Slide the toggle setting on/off to enable/disable a given link
+#* Customise the display label for a link.
-#* Customise the display label for a link
+#* Reorder the display of links within the third-party application.
-#* Drag and drop to re-order the display of links within the Third Party Application
+# Click '''Save Changes'''. If you have enabled Application Links for the given application, the status indicator will update to reflect that the syncing of your configuration changes has begun. When the process finishes, the status indicator will update to show that Application Links are active for the application.
-# When you're happy with your changes, click '''Save Changes'''
-# If Application Links are enabled for the given application, the status indicator will update to reflect the syncing of your configuration changes has begun
-# Please wait while the process completes
-# When complete the status indicator will update to show Application Links are Active for the application
-<div class="docs-alert-warning">Navigating away from the page while the sync is still in progress may leave some products/services without the new configuration.</div>
+<div class="docs-alert-warning">
+If you navigate away from the page while the sync is still in progress, the system may not fully sync all of the links for all of the products or services.
+</div>
-===Disabling Application Links===
+==Disabling Application Links==
 To disable application links:
-# Navigate to ''Setup > Application Links''
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Application Links''' or, prior to WHMCS 8.0, '''Setup > Application Links'''.
-# Slide the toggle setting from On to '''Off''' for the Application you wish to disable
+# Set the toggle to '''Off''' for the application that you wish to disable. The status indicator will update to reflect that the deprovisioning has begun. When the process finishes, the status indicator will update to show that Application Links are disabled for the application.
-# The status indicator will update to reflect the de-provisioning has begun
-# Please wait while the process completes
-# When complete the status indicator will update to show Application Links are Disabled for the application
-<div class="docs-alert-warning">Navigating away from the page while the de-provisioning is still in progress may leave some links still present in the remote application.</div>
+<div class="docs-alert-warning">
+If you navigate away from the page while the deprovisioning is still in progress, the system may not fully deprovision all of the links for all of the products or services.
+</div>
 ==Reviewing the Application Link Log==
-Application links provisioning has its own dedicated logging system.
+Application Link provisioning has its own dedicated logging system. You will see '''View Log''' for each application that supports Application Links.
-A View Log button is provided for each Application that supports Application Linking.
+The log will display entries for the last provisioning operation that you performed for a given application ('''Activation''', '''Configuration Changes''', or '''Deactivation''').
-The log will display log entries for the last provisioning operation that was performed for a given application - these can be an Activation, a sync of Configuration Changes or a deactivation.
+The log uses four logging levels:
-The log uses 4 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 Linking. Typically, this means it requires a newer version of the third-party application.
+* '''Notice''' — No servers for the given application support Application Linking. 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.
-* '''Debug''' - Used for event based logging such as start and completion of processes
+== Application Link Controls ==
-* '''Information''' - You'll see an information level log entry when a server that is attempting to have links provisioned to it does not support Application Linking (typically means it requires a newer version of the Third Party Application be installed)
-* '''Notice''' - You'll see a notice level log entry when no servers for the given Application support Application Linking (also typically means it requires a newer version of the Third Party Application be installed)
+There is a one-to-one relationship between a given cPanel or WP Squared 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 and Accounts|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.
-* '''Warning''' - Error messages returned from the Application/module itself. These typically require attention.
+The client account owner can revoke the '''Single Sign-On''' permission for the user at '''Hello, Name! > User Management'''. Admins can remove this permission by clicking '''Manage User''' in the client's profile's '''[[Clients:Users_Tab|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 '''[[Clients:Profile_Tab|Profile]]''' tab.

Documentation