Difference between revisions of "Troubleshooting Module Problems"
| 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. | 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. | ||
| − | If you are experiencing a technical issue with a module enable logging: | + | == Enable Logging == |
| + | |||
| + | <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. | ||
| + | </div> | ||
| + | |||
| + | If you are experiencing a technical issue with a module, enable logging: | ||
| + | |||
#Make sure your Administrator role has the '''View Module Debug Log''' permission. | #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). | #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). | ||
| Line 10: | Line 18: | ||
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. | 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. | ||
| − | + | == 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. | ||
Revision as of 20:59, 25 January 2022
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.
Enable Logging
NOTE:
It is important that once troubleshooting has been completed that the debugging tool is disabled by clicking the Disable Debug Logging button.
If you are experiencing a technical issue with a module, enable logging:
- Make sure your Administrator role has the View Module Debug Log permission.
- Go to Configuration () > System Logs > Module Log (Utilities > Logs > Module Log in WHMCS 7.x and earlier).
- Click Enable Debug Logging.
- Reproduce the issue.
- Return to the module log page.
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.
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.