Application Links

From WHMCS Documentation

Revision as of 08:11, 11 October 2017 by John (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Application Linking is the simple way for 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.

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 are able to configure which of the above links are provided to your end users and the display label text used for each.

Managing Application Links

You can view and manage all modules that support application linking by navigating to Setup > Application Links.

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.

Requires the Configure Application Links administrator permission which is assigned only to Full Administrator level users by default.

Enabling Application Links

Watch Video Tutorial
Please be aware that cPanel & WHM Version 54 (which entered RELEASE status on Monday, 25h January, 2016) is required for Application Links.
  1. Navigate to Setup > Application Links
  2. All installed modules that support Application Linking will be displayed
  3. Slide the toggle setting from Off to On next to the Application you wish to enable it for
    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
  4. The status indicator will update to reflect the provisioning of links 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 provisioning is still in progress may leave some links not fully provisioned for all products/services.

Configuring Application Links

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.

ApplicationLinksConfiguration.png

Configuration can be performed before application links are enabled as well as while enabled. Any changes are then synced and pushed out across all your servers.

To configure application links:

  1. Navigate to Setup > Application Links
  2. Click the Configure link for the Application you wish to make changes for
  3. A modal will load showing all supported Application Links by that module (see screenshot above). 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 Third Party Application
  4. When you're happy with your changes, click Save Changes
  5. If Application Links are enabled for the given application, the status indicator will update to reflect the syncing of your configuration changes has begun
  6. Please wait while the process completes
  7. 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.

Disabling Application Links

To disable application links:

  1. Navigate to Setup > Application Links
  2. Slide the toggle setting from On to Off for the Application you wish to disable
  3. The status indicator will update to reflect the de-provisioning has begun
  4. Please wait while the process completes
  5. When complete the status indicator will update to show Application Links are Disabled for the application
Navigating away from the page while the de-provisioning is still in progress may leave some links still present in the remote application.

Reviewing the Application Link Log

Application links provisioning has its own dedicated logging system.

A View Log button is provided for each Application that supports Application Linking.

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 4 logging levels:

  • Debug - Used for event based logging such as start and completion of processes
  • 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)
  • Warning - Error messages returned from the Application/module itself. These typically require attention.