Difference between revisions of "Troubleshooting Guide"

From WHMCS Documentation

(Blank/Partially Loading Page)
(Module Command/Registrar Error)
Line 7: Line 7:
  
 
==Module Command/Registrar Error==
 
==Module Command/Registrar Error==
Module Command Errors are errors returned from the module and not WHMCS, so for provisioning modules (cPanel, Plesk etc) they come from your server, for registrar modules (eNom, ResellerClub etc) they come from your domain registrar.
+
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...
  
Therefore to discover the cause of such errors refer to your server/registrar's documentation or support team. We have collected some of the most most common errors and their causes, refer to the appropriate page in the following sections:
+
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:
  
*[[Server Modules]]
+
*[[Server Modules|Server/Provisioning Modules]]
 
*[[Domain Registrars]]
 
*[[Domain Registrars]]
 
*[[Common_Troubleshooting_Tips#Server_Errors|Module Errors]]
 
*[[Common_Troubleshooting_Tips#Server_Errors|Module Errors]]
  
Once the necessary corrections have been made use the Module Command buttons under the client's Products/Services or Domains tabs to attempt the command again.
+
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 Error===
+
===Unknown Errors===
Sometimes the module returns an error WHMCS does not recognise and this can result in an Unknown Error message. In these cases the [[Troubleshooting_Module_Problems|System Module Debug Log]] should be used to obtain the full response from the module. This will contain an error message that the server/registrar's documentation or support team will be able to explain.
+
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==
 
==Oops!, Blank, or Partially Loading Page==

Revision as of 10:36, 9 March 2018

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.

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 Hotfixes Forum as a solution for your issue may already be available.

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:

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. In these cases the 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:

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.

If there is no log entry at-all and you are using a merchant gateway this suggests that the client has no card details on file.
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