Difference between revisions of "Troubleshooting Module Problems"
(→Enable Logging) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | 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 == | == Enable Logging == | ||
<div class="docs-alert-info"> | <div class="docs-alert-info"> | ||
| − | + | Only enable logging for this tool for testing purposes. At all other times, make certain that you set '''Module Logging''' to '''Off'''. | |
| − | |||
</div> | </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. |
| − | + | To do this: | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | The details of the interaction between WHMCS and the module will | + | # Make sure your [[Administrator Roles|administrator role]] has the '''View Module Debug Log''' permission. |
| + | # Go to the '''Module Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs'''. | ||
| + | # Set '''Module Logging''' to '''On'''.<br/><br/>[[File:turn-on-module-log-2.png|800px]] | ||
| + | # Reproduce the issue. | ||
| + | # Return to the module log page. | ||
| + | |||
| + | 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 == | ||
| − | 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 | + | 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. |
Latest revision as of 13:45, 3 January 2024
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
Only enable logging for this tool for testing purposes. At all other times, make certain that you set Module Logging to Off.
If you are experiencing a technical issue with a module, enable logging.
To do this:
- Make sure your administrator role has the View Module Debug Log permission.
- Go to the Module Log at Configuration () > System Logs or, prior to WHMCS 8.0, Utilities > Logs.
- Set Module Logging to On.
- Reproduce the issue.
- Return to the module log page.
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.
To use the Reset Module Debug Log option, temporarily grant the DROP privilege to the WHMCS database user. For more information, see Database Privileges.
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.
In these cases, you can use the System Module Debug Log to obtain the raw response, which will typically help identify the problem.