Kayako - Revision history

SarahK: /* Setting Up Integration */

2022-04-25T19:50:58Z

‎Setting Up Integration

SarahK at 19:40, 18 January 2022

2022-01-18T19:40:42Z

SarahK at 19:05, 15 September 2021

2021-09-15T19:05:01Z

SarahK: /* Third-Party Client Area Integration */

2021-09-09T16:28:18Z

‎Third-Party Client Area Integration

SarahK: /* Setting up LoginShare */

2021-09-09T16:28:07Z

‎Setting up LoginShare

SarahK at 16:27, 9 September 2021

2021-09-09T16:27:30Z

John at 11:04, 14 September 2020

2020-09-14T11:04:15Z

John at 11:00, 14 September 2020

2020-09-14T11:00:57Z

SarahK: /* Setting up LoginShare */

2020-08-27T20:31:02Z

‎Setting up LoginShare

SarahK: /* Setting up Integration */

2020-08-04T17:26:51Z

‎Setting up Integration

@@ Line 40: / Line 40: @@
 To do this:
 # Log in to the Admin Area.
-# Go to the '''Support''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support'''.
+# Go to the '''[[Support Tab|Support]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
 # Select '''Kayako''' from the '''Support Module''' menu.
 __NOTOC__

@@ Line 19: / Line 19: @@
 # Navigate to '''Settings > LoginShare'''.
 # Set '''Enable external authentication for users''' to ''Yes''.
-# Set the LoginShare URL to the file at <tt><nowiki>http://www.yourdomain.com/whmcs/modules/support/kayako/loginshare.php</nowiki></tt>, replacing <tt><nowiki>http://www.yourdomain.com/whmcs/</nowiki></tt> with the URL to your WHMCS installation.
+# Set the LoginShare URL to the file at <tt><nowiki>http://www.example.com/whmcs/modules/support/kayako/loginshare.php</nowiki></tt>, replacing <tt><nowiki>http://www.example.com/whmcs/</nowiki></tt> with the URL to your WHMCS installation.
 # Edit the group permissions to use LoginShare for that group at '''Templates - Groups'''.
 # Set '''Use LoginShare to authenticate users''' to ''Yes''.

@@ Line 8: / Line 8: @@
 == Version 4 ==
-With Version 4, the new version of Kayako released in November 2010, we have created a LoginShare module that allows your clients to log in to Kayako using their WHMCS email address and password without needing to re-register in Kayako.
+The LoginShare module for Kayako allows your clients to log in to Kayako using their WHMCS email address and password, without needing to re-register in Kayako.
 === Setting up LoginShare ===
 # Log in to your WHMCS Admin Area
 # Navigate to the '''[[Support_Tab|Support]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support'''.

@@ Line 25: / Line 25: @@
 === Third-Party Client Area Integration ===
-There is also a full third-party Client Area integration. It is unsupported but is available for use. You can find out more details about it in Kayako's [[http://forge.kayako.com/projects/aiso-whmcs-integration official addons directory]].
+There is also a full third-party Client Area integration. It is unsupported but is available for use. You can find out more details about it in Kayako's [http://forge.kayako.com/projects/aiso-whmcs-integration official addons directory].
 == Version 3 ==

@@ Line 18: / Line 18: @@
 # Navigate to '''Settings > LoginShare'''.
 # Set '''Enable external authentication for users''' to ''Yes''.
-# Set the LoginShare URL to the file at <tt>http://www.yourdomain.com/whmcs/modules/support/kayako/loginshare.php</tt>, replacing <tt>http://www.yourdomain.com/whmcs/</tt> with the URL to your WHMCS installation.
+# Set the LoginShare URL to the file at <tt><nowiki>http://www.yourdomain.com/whmcs/modules/support/kayako/loginshare.php</nowiki></tt>, replacing <tt><nowiki>http://www.yourdomain.com/whmcs/</nowiki></tt> with the URL to your WHMCS installation.
 # Edit the group permissions to use LoginShare for that group at '''Templates - Groups'''.
 # Set '''Use LoginShare to authenticate users''' to ''Yes''.

@@ Line 1: / Line 1: @@
 <div class="docs-alert-danger">
 <span class="title">Module Deprecated</span><br />
-This module is depreciated and is no longer distributed as of WHMCS version 8.0.
+This module is deprecated and is no longer distributed as of WHMCS version 8.0.
 </div>
-Kayako is a leading help desk software, and so for those who need something a little more advanced than the support tools included in WHMCS, we have worked with Kayako to make possible integration between their software and WHMCS.
+Kayako is a leading help desk software that offers advanced support tools.
-==Version 4==
+== Version 4 ==
-With Version 4, the new version of Kayako released in November 2010, we have created a loginshare module which allows your clients to login to Kayako using the same email address and password that they are registered with in your WHMCS system, without needing to re-register in your Kayako system.
+With Version 4, the new version of Kayako released in November 2010, we have created a LoginShare module that allows your clients to log in to Kayako using their WHMCS email address and password without needing to re-register in Kayako.
-===Setting up LoginShare===
+=== Setting up LoginShare ===
-# Login to your WHMCS admin area and navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > [[Support_Tab|Support]]''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support'''.
+# Log in to your WHMCS Admin Area
-# Select "Kayako" in the '''Support Module''' dropdown to activate the module.
+# Navigate to the '''[[Support_Tab|Support]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support'''.
-# Now login to the administration area of your Kayako system. Navigate to '''Settings > LoginShare'''.
+# Select ''Kayako'' in the '''Support Module''' menu to activate the module.
-# Change the '''Enable external authentication for users''' option to ''Yes''.
+# Log in to the administration area of your Kayako system.
-# Set the LoginShare URL to the file at http://www.yourdomain.com/whmcs/modules/support/kayako/loginshare.php
+# Navigate to '''Settings > LoginShare'''.
-## Replace ''<nowiki>http://www.yourdomain.com/whmcs/</nowiki>'' with the URL to your WHMCS installation.
+# Set '''Enable external authentication for users''' to ''Yes''.
-# Finally edit the Group permissions to use loginshare. This feature is located at under '''Templates - Groups > X''' (where x is the group name). By default there is only one called "default".
+# Set the LoginShare URL to the file at <tt>http://www.yourdomain.com/whmcs/modules/support/kayako/loginshare.php</tt>, replacing <tt>http://www.yourdomain.com/whmcs/</tt> with the URL to your WHMCS installation.
-# Edit that group and change the '''Use LoginShare to authenticate users''' option to ''Yes''.
+# Edit the group permissions to use LoginShare for that group at '''Templates - Groups'''.
-And that's all there is to it. As a final step, you would then just need to update the links in your custom WHMCS homepage and header template files to point to the Kayako system files.
+=== Third-Party Client Area Integration ===
-===Third Party Client Area Integration===
+There is also a full third-party Client Area integration. It is unsupported but is available for use. You can find out more details about it in Kayako's [[http://forge.kayako.com/projects/aiso-whmcs-integration official addons directory]].
- http://forge.kayako.com/projects/aiso-whmcs-integration
+== Version 3 ==
-==Version 3==
+=== Setting Up Integration ===
-For Kayako Version 3, there is a full client area integration which allows the built in support tools to be replaced by the Kayako equivalents for a seamless client area experience. The way this works is by displaying the Kayako content in place of where the WHMCS support content would normally appear.
+You can find instructions to set up this integration in the <tt>/integrate/</tt> folder of the Kayako SupportSuite or eSupport package. If this folder and its files are not present, contact Kayako support.
-===Setting up Integration===
+After you edit and upload the files in the <tt>readme</tt> file, you will need to activate the integration within WHMCS.
-To setup this integration, simply take a look at the /integrate/ folder of your Kayako SupportSuite or eSupport download (available from the Kayako members' area) package for the files and instructions.
+To do this:
+# Log in to the Admin Area.
-If the /integrate/ folder and its files are not present, contact Kayako support and they should be able to provide you with the files you need.
+# Go to the '''Support''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support'''.
+# Select '''Kayako''' from the '''Support Module''' menu.
 __NOTOC__

← Older revision		Revision as of 11:00, 14 September 2020
Line 1:		Line 1:
		+	<div class="docs-alert-danger">
		+	<span class="title">Deprecated Functionality</span><br />
		+	This functionality has been removed in WHMCS version 8.0+
		+	</div>
		+
	Kayako is a leading help desk software, and so for those who need something a little more advanced than the support tools included in WHMCS, we have worked with Kayako to make possible integration between their software and WHMCS.		Kayako is a leading help desk software, and so for those who need something a little more advanced than the support tools included in WHMCS, we have worked with Kayako to make possible integration between their software and WHMCS.

@@ Line 35: / Line 35: @@
 If the /integrate/ folder and its files are not present, contact Kayako support and they should be able to provide you with the files you need.
-Once you have edited and uploaded the files as described by the readme document found in the /integrate/ folder, you will need to activate the integration within WHMCS. Simply log into your admin area and go to '''General Settings > Support''' and choose '''Kayako''' from the '''Support Module''' dropdown menu.
+Once you have edited and uploaded the files as described by the readme document found in the /integrate/ folder, you will need to activate the integration within WHMCS. Simply log into your admin area and go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Support''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support''' and choose '''Kayako''' from the '''Support Module''' dropdown menu.
 __NOTOC__