Addon Modules Management - Revision history

SarahK: Redirected page to Addon Modules

2022-12-19T19:27:57Z

Redirected page to Addon Modules

SarahK at 16:33, 18 April 2022

2022-04-18T16:33:16Z

SarahK at 20:08, 25 January 2022

2022-01-25T20:08:49Z

PeterM at 15:47, 22 September 2020

2020-09-22T15:47:34Z

SarahK at 20:16, 4 August 2020

2020-08-04T20:16:59Z

John at 09:29, 26 June 2020

2020-06-26T09:29:54Z

John at 08:42, 31 July 2018

2018-07-31T08:42:35Z

Lawrence at 15:12, 29 May 2018

2018-05-29T15:12:57Z

Joshua at 13:32, 4 July 2017

2017-07-04T13:32:02Z

Joshua at 13:10, 6 June 2017

2017-06-06T13:10:47Z

← Older revision		Revision as of 19:27, 19 December 2022
Line 1:		Line 1:
−	~~Addon modules allow developers to extend the functionality of WHMCS further including new pages in the admin or client areas.~~	+	#REDIRECT [[Addon Modules]]
−
−	* You can find addons to download and install in the [https://marketplace.whmcs.com WHMCS Marketplace].
−	* For more information about developing your own addon modules, see [http://developers.whmcs.com our developer documentation].
−
−	~~===Uploading and Installing Addons===~~
−
−	~~Before you can install a new addon, you must upload it to your WHMCS installation. To do this, unzip and upload the addon files to your installation's <tt>/modules/addons</tt> directory.~~
−
−	After you successfully upload the addon files, the addon will appear in the list of addon modules at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
−
−	~~===Troubleshooting===~~
−
−	~~====Oops Error====~~
−
−	An Oops Error Message when you view the list of addon modules can be caused by an incompatible module. For help to resolve this error, see [https://help.whmcs.com/m/troubleshooting/l/678235-troubleshooting-a-blank-page-oops-error-message Troubleshooting A Blank Page Oops Error Message].
−
−	The error will reference the addon module that is causing the failure. Once you know the affected addon, you can remove the addon files from '''/modules/addons''' or obtain an updated version of the addon from the developer.
−
−	~~====Addon does not appear in menu====~~
−
−	~~Ensure that you have selected the administrator roles during~~ [[Addon Modules~~\|addon configuration~~]].

@@ Line 1: / Line 1: @@
 Addon modules allow developers to extend the functionality of WHMCS further including new pages in the admin or client areas.
 * You can find addons to download and install in the [https://marketplace.whmcs.com WHMCS Marketplace].
 * For more information about developing your own addon modules, see [http://developers.whmcs.com our developer documentation].
@@ Line 10: / Line 9: @@
 After you successfully upload the addon files, the addon will appear in the list of addon modules at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
 ===Troubleshooting===

@@ Line 1: / Line 1: @@
 Addon modules allow developers to extend the functionality of WHMCS further including new pages in the admin or client areas.
-A range of addons can be found in our Marketplace at https://marketplace.whmcs.com which contains both free and commercial addons from WHMCS and third party developers. Once you have downloaded or purchased addons these can then be installed within your WHMCS.
 ===Troubleshooting===
 ====Oops Error====
-An Oops Error Message is shown when visiting '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. This can be caused by an incompatible module. Please follow our guide on blank/oops pages to obtain the full error - https://help.whmcs.com/m/troubleshooting/l/678235-troubleshooting-a-blank-page-oops-error-message.
-The error will reference the addon module that is causing the failure. Once you know the affected addon you can remove the addon files from '''/modules/addons''' or obtain an updated version of the addon from the developer.
+An Oops Error Message when you view the list of addon modules can be caused by an incompatible module. For help to resolve this error, see [https://help.whmcs.com/m/troubleshooting/l/678235-troubleshooting-a-blank-page-oops-error-message Troubleshooting A Blank Page Oops Error Message].
 ====Addon does not appear in menu====
-Ensure that you have selected the administrator roles you wish to have access as outlined in step 4 of '''Installing An Addon''' above.

@@ Line 1: / Line 1: @@
-Addon modules allows developers to extend the functionality of WHMCS further including new pages in the admin or client areas. Addons can be obtained from the WHMCS Marketplace at https://marketplace.whmcs.com/
+Addon modules allow developers to extend the functionality of WHMCS further including new pages in the admin or client areas.
+A range of addons can be found in our Marketplace at https://marketplace.whmcs.com which contains both free and commercial addons from WHMCS and third party developers. Once you have downloaded or purchased addons these can then be installed within your WHMCS.
 Documentation for creating an addon module can be found at [[Addon Modules]]
+===Installing An Addon===
-==Downloading and installing an addon==
+# To install a new addon to WHMCS it will first need to be uploaded to your WHMCS installation. Unzip and upload the addon files to the '''/modules/addons''' directory within your installation location. Once uploaded the addon will be available within your admin area.
-<html><a href="https://www.youtube.com/watch?v=g3sYz7tvcac&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
+# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules''', and the addon you have uploaded will be listed.
+# Click '''Activate''' next to the addon you wish to enable. The addon is now active within your WHMCS.
-==Addon module management & access control==
+# Click '''Configure''' and select which administrator roles you wish to have access to the addon by enabling them under the '''Access Control''' section. Some addons will also have additional options specific to the addon module.
-<html><a href="http://www.youtube.com/watch?v=39TpVTs8onE&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
+# The addon will now appear under the '''Addons''' option in the top menu.
+===Removing An Addon===
-==Removing Addon Modules==
+# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
+# Deactivate the required addon by clicking the '''Deactivate''' button
-To remove an Addon Module, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. Then, click the '''Deactivate''' button next to the addon.
+# You can now delete the directory for the addon within '''/modules/addons'''
 <div class="docs-alert-danger">
-<span class="title">Note</span><br />
+<span class="title">Please Note</span><br />
-Disabling an Addon Module may delete data from database. After disabling an Addon Module, you may then delete it from the <em>/modules/addons</em> directory.
+Disabling an Addon Module may delete data relevant to the addon from the database.
 </div>

@@ Line 1: / Line 1: @@
 Addon modules allows developers to extend the functionality of WHMCS further including new pages in the admin or client areas. Addons can be obtained from the WHMCS Marketplace at https://marketplace.whmcs.com/
-Once downloaded and installed they are all managed through the '''Setup > Addon Modules''' interface. Once activated, the modules will display in the dedicated "Addons" dropdown menu within the admin area for quick & easy access from any page.
+Once downloaded and installed they are all managed through '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. Once activated, the modules will display in the dedicated "Addons" dropdown menu within the admin area for quick and easy access from any page.
 Management options consist of activating and deactivating of the modules, as well as access control which allows full admins to define exactly which of the administrator roles are allowed to access each addon module.
@@ Line 15: / Line 15: @@
 ==Removing Addon Modules==
-To remove an Addon Module, navigate to the '''Setup > Addon Modules''' page and then click the '''Deactivate''' button next to the addon.
+To remove an Addon Module, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. Then, click the '''Deactivate''' button next to the addon.
 <div class="docs-alert-danger">

@@ Line 7: / Line 7: @@
 Documentation for creating an addon module can be found at [[Addon Modules]]
-'''Downloading and installing an addon'''
+==Downloading and installing an addon==
 [[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=g3sYz7tvcac&hd=1|Watch Video Tutorial]]
-'''Addon module management & access control'''
+==Addon module management & access control==
 [[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=39TpVTs8onE&hd=1|Watch Video Tutorial]]
-'''Removing Addon Modules'''
+==Removing Addon Modules==
 To remove an Addon Module, navigate to the '''Setup > Addon Modules''' page and then click the '''Deactivate''' button next to the addon.

← Older revision		Revision as of 13:32, 4 July 2017
Line 17:		Line 17:
	'''Removing Addon Modules'''		'''Removing Addon Modules'''

−	To remove an Addon Module, navigate to the '''Setup > Addon Modules''' page and then click the '''Deactivate''' button next to the addon. ~~Please note,~~ <span ~~style~~="~~color: red~~">Disabling an Addon Module may delete data from database~~</span>~~. After disabling an Addon Module, you may then delete it from ~~'''~~/modules/addons~~'''~~ directory.	+	To remove an Addon Module, navigate to the '''Setup > Addon Modules''' page and then click the '''Deactivate''' button next to the addon.
		+
		+	<div class="docs-alert-danger">
		+	<span class="title">Note</span><br />
		+	Disabling an Addon Module may delete data from database. After disabling an Addon Module, you may then delete it from the <em>/modules/addons</em> directory.
		+	</div>

← Older revision		Revision as of 13:10, 6 June 2017
Line 13:		Line 13:
	'''Addon module management & access control'''		'''Addon module management & access control'''
	[[File:Videotutorial.png‎\|center\|link=http://www.youtube.com/watch?v=39TpVTs8onE&hd=1\|Watch Video Tutorial]]		[[File:Videotutorial.png‎\|center\|link=http://www.youtube.com/watch?v=39TpVTs8onE&hd=1\|Watch Video Tutorial]]
		+
		+
		+	'''Removing Addon Modules'''
		+
		+	To remove an Addon Module, navigate to the '''Setup > Addon Modules''' page and then click the '''Deactivate''' button next to the addon. Please note, <span style="color: red">Disabling an Addon Module may delete data from database</span>. After disabling an Addon Module, you may then delete it from '''/modules/addons''' directory.