Tips and Tricks HQ Support Portal › Forums › WP eStore Forum › WP eStore F.A.Q/Instructions › How and When to Enable Debug and What does it do?
Tagged: Debug, debug file, Email Not Receiving, eStore Debug, IPN, post payment failure, post payment processing
- This topic has 0 replies, 1 voice, and was last updated 13 years, 3 months ago by Ivy.
February 20, 2010 at 2:46 am #829IvyMember
If you are testing a plugin for the first time, go through this checklist which has a list of common mistakes that people often make when testing (it will help you avoid those mistakes):
What does enable debug do?
Once someone makes a payment, the payment gateway (for example: PayPal) sends a payment notification (IPN) to the WP eStore plugin’s post payment processing script. The plugin then does a range of verification checks and perform the post payment work (e.g. send emails to the customers, award affiliate commission, update stock quantities etc).
When the debug is enabled the plugin will log every step of the post payment processing tasks in a log file which can be analyzed to find out any failures that maybe stopping the plugin from completing the full post payment processing steps.
When to enable debug?
Basically, if something is not functioning as expected after the payment is made on PayPal (e.g. emails are not getting sent out) it is a good idea to enable debug and perform a test transaction so you can analyze the log file to identify the issue.
How to Enable Debug?
Simply check the “Enable Debug” checkbox from the “Testing and Debugging Settings” section of the eStore’s settings page and save the settings.
It is also a good idea to use the “Reset Debug Log Files” button to reset your debug files before doing the test transaction so you can capture a clean debug output from the transaction you are about to do.
Using with PayPal Sandbox
If you are doing PayPal sandbox testing then read this section carefully.
PayPal sandbox was designed mainly for developers so non-developers can sometimes get confused with PayPal sandbox setup. If you just created a sandbox account, chances are that your account is not fully configured and setup properly to do the full checkout testing. The following info should be helpful for you:
#1) Guide to PayPal Sandbox Setup
#2) Testing Preparation and Checklist
Where to find this Log file?
After you have ran a transaction with debug enabled, you will most likely want to check the log file. You can access all the log files from the settings menu of the eStore plugin (Check under the “Debugging and Testing” section of the settings menu. If you are doing a transaction testing then the debug files you want to look for are:
- subscription_handle_debug.log (for membership payment if you are using it)
All the debug files are stored in this plugin’s (wp-cart-for-digital-product) directory in case you want to manually check them using FTP.
Look for the word “Failure” in that file and it will tell you exactly what is failing.
If you need a hand with understanding/reading the file let us know and we should be able to guide you. When contacting us for an issue related to this please send us the debug file or your website address.
What to do if the Log file is empty or new debug is not getting added to the file?
The following post will tell you what to do if the debug log file is empty even after running a transaction with debug enabled.
What to do if the Debug file is empty or New Debug info is not getting added
How do You Know if You are Looking at New Debug info or Old Debug info?
Ideally you should be resetting the debug file by emptying out the content of the debug file so that you have a fresh file to look at. If you forgot to do this or you don’t want to do this then use the date and timestamp value in the debug file to determine the freshness of the debug info.
Each debug line in the debug file has a date and timestamp value which should help you identify if certain debug info is new or old (from a previous transaction).
What to do after you are done troubleshooting
After you are done troubleshooting and the issue is fixed, you can reset the debug log files and turn it off from the settings menu of the plugin.
- You must be logged in to reply to this topic.