You are here

Home » API reference » Webform Purge 7

README.txt in Webform Purge 7 

CONTENTS OF THIS FILE
---------------------
   
 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Troubleshooting
 * FAQ
 
 
INTRODUCTION
------------

The Webform Purge allows you to set up automated purging of Webform submissions
on a daily rolling schedule. You select the number of days to retain and the 
module uses hook_cron to purge them during cron runs.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/webform_purge

 * To submit bug reports and feature suggestions, or to track changes:
   https://drupal.org/project/issues/webform_purge
   
   
REQUIREMENTS
------------

This module requires the following modules:

 * Webform (https://www.drupal.org/project/webform)
 
 
INSTALLATION
------------
 
 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-7
   for further information.

 * The installation creates configuration variables in the drupal core
   'variable' table.
   
   
CONFIGURATION
-------------
 
 * Configure settings in Administration » Configuration » Webform Purge:

   - Enable automated purging

     This option enables the functionality of the module. If not checked, 
	 the purge function will not run.

   - Run only once per day

     This option is used to limit the purge to just one cron run per day.
	 Conversely if unchecked, it will run with every cron run. 

   - Days to retain

     The number of days to retain submissions before they are purged.

    
   
TROUBLESHOOTING
---------------

 * If expected entries are not purged, check the following:

   - Is the Enable automated purging checkbox checked?
   
   - Is the submission younger than the Days to retain?

FAQ
---

Q: If I want to incrementally purge starting with a very old date and progress
   to my target date, do I have to run this across multiple days?	

A: No, you can uncheck the 'Run only once per day' option and then set a 
   'Days to retain' at a high value and then run the cron job.  Repeat this
   until you achieve your target number of days to retain.
   
Q: How can I tell how many entries were purged?

A: Check the 'Recent log messages' under the Reports tab for an informational
   entry from the webform_purge module.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.    

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Troubleshooting

  9.  * FAQ

  10.  

  11.  

  12. INTRODUCTION

  13. ------------

  14. 

  15. The Webform Purge allows you to set up automated purging of Webform submissions

  16. on a daily rolling schedule. You select the number of days to retain and the 

  17. module uses hook_cron to purge them during cron runs.

  18. 

  19.  * For a full description of the module, visit the project page:

  20.    https://www.drupal.org/project/webform_purge

  21. 

  22.  * To submit bug reports and feature suggestions, or to track changes:

  23.    https://drupal.org/project/issues/webform_purge

  24.    

  25.    

  26. REQUIREMENTS

  27. ------------

  28. 

  29. This module requires the following modules:

  30. 

  31.  * Webform (https://www.drupal.org/project/webform)

  32.  

  33.  

  34. INSTALLATION

  35. ------------

  36.  

  37.  * Install as you would normally install a contributed Drupal module. See:

  38.    https://drupal.org/documentation/install/modules-themes/modules-7

  39.    for further information.

  40. 

  41.  * The installation creates configuration variables in the drupal core

  42.    'variable' table.

  43.    

  44.    

  45. CONFIGURATION

  46. -------------

  47.  

  48.  * Configure settings in Administration » Configuration » Webform Purge:

  49. 

  50.    - Enable automated purging

  51. 

  52.      This option enables the functionality of the module. If not checked, 

  53. 	 the purge function will not run.

  54. 

  55.    - Run only once per day

  56. 

  57.      This option is used to limit the purge to just one cron run per day.

  58. 	 Conversely if unchecked, it will run with every cron run. 

  59. 

  60.    - Days to retain

  61. 

  62.      The number of days to retain submissions before they are purged.

  63. 

  64.     

  65.    

  66. TROUBLESHOOTING

  67. ---------------

  68. 

  69.  * If expected entries are not purged, check the following:

  70. 

  71.    - Is the Enable automated purging checkbox checked?

  72.    

  73.    - Is the submission younger than the Days to retain?

  74. 

  75. FAQ

  76. ---

  77. 

  78. Q: If I want to incrementally purge starting with a very old date and progress

  79.    to my target date, do I have to run this across multiple days?	

  80. 

  81. A: No, you can uncheck the 'Run only once per day' option and then set a 

  82.    'Days to retain' at a high value and then run the cron job.  Repeat this

  83.    until you achieve your target number of days to retain.

  84.    

  85. Q: How can I tell how many entries were purged?

  86. 

  87. A: Check the 'Recent log messages' under the Reports tab for an informational

  88.    entry from the webform_purge module.