Difference between revisions of "Application Links"
(Created page with "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...") |
(→Reviewing the Provisioning Log) |
||
| Line 76: | Line 76: | ||
<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">Navigating away from the page while the de-provisioning is still in progress may leave some links still present in the remote application.</div> | ||
| − | ==Reviewing the | + | ==Reviewing the Application Link Log== |
Application links provisioning has its own dedicated logging system. | Application links provisioning has its own dedicated logging system. | ||
Revision as of 14:09, 25 November 2015
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
- View/Order Addons
- 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 get to choose which of the above links are provided to end users and the display label text used for each.
Contents
Managing Application Linking
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.
Enabling Application Links
- Navigate to Setup > 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
- 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
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.
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
- Click the Configure link for the Application you wish to make changes for
- A modal will load showing all supported Application Links by that module
Disabling Application Links
To disable application links:
- Navigate to Setup > Application Links
- Slide the toggle setting from On to Off for the Application you wish to disable
- 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
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.