Difference between revisions of "Troubleshooting Module Problems"
From WHMCS Documentation
m |
|||
| Line 2: | Line 2: | ||
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. |
| − | # | + | #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'' | + | #Click '''Enable Debug Logging'''. |
| − | # | + | #Reproduce the issue. |
#Return to the module log page. | #Return to the module log page. | ||
| Line 12: | Line 12: | ||
<div class="docs-alert-info"> | <div class="docs-alert-info"> | ||
<span class="title">NOTE:</span><br /> | <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 clicking the '''Disable Debug Logging''' button. |
</div> | </div> | ||
Revision as of 14:15, 4 August 2020
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:
- 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.
NOTE:
It is important that once troubleshooting has been completed that the debugging tool is disabled by clicking the Disable Debug Logging button.