Difference between revisions of "Troubleshooting Guide"

Latest revision as of 20:06, 9 May 2022

You may encounter some common errors while using WHMCS. Before contacting support, run through the steps below to attempt to resolve the issue yourself.

Known Bugs

When we identify issues between releases, we publish individual patches (hotfixes) outside of the update structure.

For more information, see How we handle Bug Reports.

Module Command/Registrar Error

Module Command Errors are error messages that third party systems return via modules.

For more information, see:

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.

For more information, see Troubleshooting Module Problems.

Oops!, Blank, or Partially Loading Page

When you see an "Oops!", blank, or partially loaded page, an error condition has occurred.

For more information, see:

Payments Not Recorded

The callback setting configuration must communicate with your WHMCS installation. If it does not, the system may not successfully record payments in WHMCS.

For more information, see Troubleshooting Payment Record Issues.

500 Internal Server Error

The 500 internal server error is usually due to a customisation or an issue with the PHP configuration causing issues.

For more information, see PHP and WHMCS.

@@ Line 1: / Line 1: @@
 {{troubleshooting}}
-This guide will explain and help resolve many of the most common error messages that can occur whilst using WHMCS. Before contacting support please run through this step-by-step guide as you may be able to resolve the matter yourself.
+You may encounter some common errors while using WHMCS. Before contacting support, run through the steps below to attempt to resolve the issue yourself.
 ==Known Bugs==
-Sometimes issues are identified between releases and individual patches are published outside the update structure which can be applied if you are experiencing the symptoms. Please review the [https://forum.whmcs.com/forumdisplay.php?158-Hotfixes Hotfixes Forum] as a solution for your issue may already be available.
+When we identify issues between releases, we publish individual patches (hotfixes) outside of the update structure.
+For more information, see [[How we handle Bug Reports]].
 ==Module Command/Registrar Error==
-Module Command Errors are error messages returned from third party systems via modules.  Examples of modules that may generate error messages include cPanel, Plesk, Enom, ResellerClub, etc...
-To discover the cause of errors returned by a third party system, it is often necessary to consult the vendors documentation or support team. However, we have collated some of the most common errors and their causes in the pages below:
+Module Command Errors are error messages that third party systems return via modules.
+For more information, see:
 *[[Server Modules|Server/Provisioning Modules]]
@@ Line 15: / Line 19: @@
 *[[Common_Troubleshooting_Tips#Server_Errors|Module Errors]]
-To re-attempt the failed actions, use the Module Command buttons displayed when viewing the service or domain within the admin area clients profile.
+===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.
-===Unknown Errors===
+For more information, see [[Troubleshooting Module Problems]].
-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 the [[Troubleshooting_Module_Problems|System Module Debug Log]] can be used to obtain the raw response being received which will typically help pinpoint the problem.
 ==Oops!, Blank, or Partially Loading Page==
-When an "Oops!", blank, or partially loaded page is rendered it means that an error condition has occurred.  You may be able to get more information about the error condition by enabling Display Errors or looking into your logs as described in [[Error Management]]
-We have collated some common errors and their causes, which you may refer to in the following sections:
+When you see an "Oops!", blank, or partially loaded page, an error condition has occurred.
-*[[Server Modules]]
+For more information, see:
-*[[Domain Registrars]]
-*[[Common_Troubleshooting_Tips#Server_Errors]]
+*[[Blank or Partially Rendered Pages]]
+*[[Error Management]].
+*[[Server Modules]].
+*[[Domain Registrars]].
+*[[Common_Troubleshooting_Tips#Server_Errors|Common Troubleshooting Tips]].
 ==Payments Not Recorded==
-Should a payment not be recorded in WHMCS the first thing to check are the callback settings on your payment gateway's website to ensure it is configured to communicate with your WHMCS installation. As a rule callback commands should be sent to the appropriate file in the /modules/gateways/callback directory but specific instructions for individual gateways can be found at [[Payment Gateways]].
-If the configuration is correct navigate to '''Billing > Gateway Log''' and review the debug data at the time payment was made, this should display an error message or code which your payment gateway's documentation or support team will be able to explain. We have also collected some of the most most common errors and their causes, refer to the appropriate page in the [[Payment Gateways]] section.
+The callback setting configuration '''must''' communicate with your WHMCS installation. If it does not, the system may not successfully record payments in WHMCS.
+For more information, see [[Troubleshooting Payment Record Issues]].
+== 500 Internal Server Error ==
+The 500 internal server error is usually due to a customisation or an issue with the PHP configuration causing issues.
-If there is no log entry at-all and you are using a [[Payment_Gateways#Merchant_Gateways|merchant gateway]] this suggests that the client has no card details on file.<br />
+For more information, see [[PHP and WHMCS]].
-Otherwise it means your gateway is unable to communicate with the callback file on your server, a server setting such as the firewall or mod_security could be blocking them. Liaise with your payment gateway and server administrator to resolve such matters.
 ==Other Issues==
 {{troubleshooting}}

Documentation