Troubleshooting Module Problems - Revision history

JuanR: /* Enable Logging */

2024-01-03T13:45:06Z

‎Enable Logging

SarahK at 20:22, 9 May 2022

2022-05-09T20:22:55Z

PeterM at 10:31, 11 April 2022

2022-04-11T10:31:43Z

PeterM: /* Enable Logging */

2022-03-23T17:03:20Z

‎Enable Logging

PeterM: /* Enable Logging */

2022-03-09T15:41:37Z

‎Enable Logging

SarahK at 20:59, 25 January 2022

2022-01-25T20:59:37Z

SarahK at 14:15, 4 August 2020

2020-08-04T14:15:57Z

John at 13:13, 7 July 2014

2014-07-07T13:13:10Z

John at 15:32, 24 November 2011

2011-11-24T15:32:28Z

John at 11:12, 17 November 2011

2011-11-17T11:12:41Z

← Older revision		Revision as of 13:45, 3 January 2024
Line 18:		Line 18:

	The details of the interaction between WHMCS and the module will display onscreen for your own analysis. You can forward these details to the provider's technical support team if necessary.		The details of the interaction between WHMCS and the module will display onscreen for your own analysis. You can forward these details to the provider's technical support team if necessary.
		+
		+	<div class="docs-alert-info">
		+	To use the '''Reset Module Debug Log''' option, temporarily grant the <tt>DROP</tt> privilege to the WHMCS database user. For more information, see [[System_Environment_Guide#Database_Privileges\|Database Privileges]].
		+	</div>

	== Unknown Errors ==		== Unknown Errors ==

@@ Line 1: / Line 1: @@
-This module debugging tool can be used to identify and resolve problems communicating with remote API systems. It will record and display the raw API data being sent to, and received back from the remote system. Logging should only ever be enabled for testing, and never left enabled all the time.
+You can use this module debugging tool to identify and resolve problems communicating with remote API systems. It will record and display the raw API data going to and from the remote system.
 == Enable Logging ==
 <div class="docs-alert-info">
-<span class="title">NOTE:</span><br />
+Only enable logging for this tool for testing purposes. At all other times, make certain that you set '''Module Logging''' to '''Off'''.
 </div>
-If you are experiencing a technical issue with a module, enable logging:
+If you are experiencing a technical issue with a module, enable logging.
-#Make sure your Administrator role has the '''View Module Debug Log''' permission.
+To do this:
-The details of the interaction between WHMCS and the module will be displayed on-screen for your own analysis. These details can then be forwarded to the provider's technical support team if necessary.
+# Make sure your [[Administrator Roles|administrator role]] has the '''View Module Debug Log''' permission.
 == Unknown Errors ==
-Sometimes a third party system or module will provide a response that WHMCS is unable to recognise and interpret. This can result in the display of an "Unknown Error" message.
+Sometimes a third-party system or module will provide a response that WHMCS is unable to recognise and interpret. This can result in the display of an '''Unknown Error''' message.
-In these cases, you can use the System Module Debug Log to obtain the raw response, which will typically help identify the problem.
+In these cases, you can use the '''System Module Debug Log''' to obtain the raw response, which will typically help identify the problem.

@@ Line 12: / Line 12: @@
 #Make sure your Administrator role has the '''View Module Debug Log''' permission.
 #Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Module Log''' ('''Utilities > Logs > Module Log''' in WHMCS 7.x and earlier).
-#Switch '''Module Logging''' to '''On'''.<br/><br/>[[File:turn-on-module-log.png|800px]]
+#Switch '''Module Logging''' to '''On'''.<br/><br/>[[File:turn-on-module-log-2.png|800px]]
 #Reproduce the issue.<br/>
 #Return to the module log page.

@@ Line 5: / Line 5: @@
 <div class="docs-alert-info">
 <span class="title">NOTE:</span><br />
-It is important that once troubleshooting has been completed that the debugging tool is disabled by clicking the '''Disable Debug Logging''' button.
+It is important that once troubleshooting has been completed that the debugging tool is disabled by switching '''Module Logging''' to '''Off'''.
 </div>

@@ Line 12: / Line 12: @@
 #Make sure your Administrator role has the '''View Module Debug Log''' permission.
 #Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Module Log''' ('''Utilities > Logs > Module Log''' in WHMCS 7.x and earlier).
-#Click '''Enable Debug Logging'''.
+#Switch '''Module Logging''' to '''On'''.<br/><br/>[[File:turn-on-module-log.png|800px]]
-#Reproduce the issue.
+#Reproduce the issue.<br/>
 #Return to the module log page.

@@ Line 3: / Line 3: @@
 If you are experiencing a technical issue with a module enable logging:
 #First ensure your Administrator Role has ''View Module Debug Log'' permission
-#Then navigate to '''Utilities > Module Log'''
+#Then navigate to '''Utilities > Logs > Module Log'''
 #Click ''Enable Debug Logging''
 #Now reproduce the issue

@@ Line 10: / Line 10: @@
 The details of the interaction between WHMCS and the module will be displayed on-screen for your own analysis. These details can then be forwarded to the provider's technical support team if necessary.
-  '''NOTE:''' It is important that once troubleshooting has been completed that the debugging tool
+  '''NOTE:''' It is important that once troubleshooting has been completed that the debugging tool is disabled by clicking the
- is disabled by clicking the ''Disable Debug Logging'' button.
+ ''Disable Debug Logging'' button.