README.txt

Same filename in other branches
  1. 8.x-3.x d7-tests/README.txt
--------------------------------------------------------------------------------
                                 Rules
--------------------------------------------------------------------------------

Maintainers:
 * Wolfgang Ziegler (fago), nuppla@zites.net

The Rules module allows site administrators to define conditionally executed
actions based on occurring events (ECA-rules).

Project homepage: https://www.drupal.org/project/rules


Installation
------------

*Before* starting, make sure that you have read at least the introduction - so
you know at least the basic concepts. You can find it here:

                 https://www.drupal.org/node/298480

 * Rules depends on the Entity API module, download and install it from
   https://www.drupal.org/project/entity
 * Copy the whole rules directory to your modules directory
   (e.g. DRUPAL_ROOT/sites/all/modules) and activate the Rules and Rules UI
   modules.
 * The administrative user interface can be found at admin/config/workflow/rules


Documentation
-------------
* Check out the general docs at https://www.drupal.org/node/298476
* Check out the developer targeted docs at https://www.drupal.org/node/878718


Rules Scheduler
---------------

 * If you enable the Rules scheduler module, you get new actions that allow you
   to schedule the execution of Rules components.
 * Make sure that you have configured cron for your drupal installation as cron
   is used for scheduling the Rules components. For help see
   https://www.drupal.org/cron
 * If the Views module (https://www.drupal.org/project/views) is installed, the
   module displays the list of scheduled tasks in the UI.


Upgrade from Rules 6.x-1.x to Rules 7.x-2.x
--------------------------------------------

 * In order to upgrade Rules from 6.x-1.x to 7.x-2.x just run "update.php". This
   is going to make sure Rules 2.x is properly installed, but it will leave your
   Rules 1.x configurations untouched. Thus, your rules won't be upgraded yet.
 * To convert your Rules 1.x configurations to Rules 2.x go to
   'admin/config/workflow/rules/upgrade'.
     * At this page, you may choose the Rules 1.x rules and rule sets to upgrade
       and whether the converted configurations should be immediately saved to
       your database or whether the configuration export should be generated.
     * Note that for importing an export the export needs to pass the
       configuration integrity check, what might be troublesome if the
       conversion was not 100% successful. In that case, try choosing the
       immediate saving method and correct the configuration after conversion.
     * A rule configuration might require multiple modules to be in place and
       upgraded to work properly. E.g. if you used an action provided
       by a third party module, make sure the module is in place and upgraded
       before you convert the rule.
     * If all required modules are installed and have been upgraded but the rule
       conversion still fails, the cause might be that a module has not yet
       upgraded its Rules integration or does not implement the Rules conversion
       functionality. In that case, file an issue for the module that provided
       the action or condition causing the conversion to fail.
     * Note that any rule configurations containing token replacements or PHP
       input evaluations might need some manual corrections in order to stay
       working. This is, as some used token replacements might not be available
       in Drupal 7 any more and the PHP code might need to be updated in order
       to be compatible with Drupal 7.
     * Once the upgrade was successful, you may delete the left over Rules 1.x
       configurations by going to 'admin/config/workflow/rules/upgrade/clear'.
  * The Rules Scheduler module also comes with an upgrade routine that is
    invoked as usual via "update.php". Its actions can be upgraded via the usual
    Rules upgrade tool, see above.
    However, there is currently no support for upgrading already scheduled
    tasks. That means, all previously on Drupal 6 scheduled tasks won't apply
    for Drupal 7. The Drupal 6 tasks are preserved in the database as long as
    you do not clear your Rules 1.x configuration though.
  * The Rules Forms module has not been updated to Drupal 7 and there are no
    plans to do so, as unfortunately the module's design does not allow for
    automatic configuration updates.
    Thus, a possible future Rules 2.x Forms module is likely to work
    different, e.g. by working only for entity forms on the field level.

File

./README.txt

View source 
  1. 

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

  3.                                  Rules

  4. --------------------------------------------------------------------------------

  5. 

  6. Maintainers:

  7.  * Wolfgang Ziegler (fago), nuppla@zites.net

  8. 

  9. The Rules module allows site administrators to define conditionally executed

  10. actions based on occurring events (ECA-rules).

  11. 

  12. Project homepage: https://www.drupal.org/project/rules

  13. 

  14. 

  15. Installation

  16. ------------

  17. 

  18. *Before* starting, make sure that you have read at least the introduction - so

  19. you know at least the basic concepts. You can find it here:

  20. 

  21.                  https://www.drupal.org/node/298480

  22. 

  23.  * Rules depends on the Entity API module, download and install it from

  24.    https://www.drupal.org/project/entity

  25.  * Copy the whole rules directory to your modules directory

  26.    (e.g. DRUPAL_ROOT/sites/all/modules) and activate the Rules and Rules UI

  27.    modules.

  28.  * The administrative user interface can be found at admin/config/workflow/rules

  29. 

  30. 

  31. Documentation

  32. -------------

  33. * Check out the general docs at https://www.drupal.org/node/298476

  34. * Check out the developer targeted docs at https://www.drupal.org/node/878718

  35. 

  36. 

  37. Rules Scheduler

  38. ---------------

  39. 

  40.  * If you enable the Rules scheduler module, you get new actions that allow you

  41.    to schedule the execution of Rules components.

  42.  * Make sure that you have configured cron for your drupal installation as cron

  43.    is used for scheduling the Rules components. For help see

  44.    https://www.drupal.org/cron

  45.  * If the Views module (https://www.drupal.org/project/views) is installed, the

  46.    module displays the list of scheduled tasks in the UI.

  47. 

  48. 

  49. Upgrade from Rules 6.x-1.x to Rules 7.x-2.x

  50. --------------------------------------------

  51. 

  52.  * In order to upgrade Rules from 6.x-1.x to 7.x-2.x just run "update.php". This

  53.    is going to make sure Rules 2.x is properly installed, but it will leave your

  54.    Rules 1.x configurations untouched. Thus, your rules won't be upgraded yet.

  55.  * To convert your Rules 1.x configurations to Rules 2.x go to

  56.    'admin/config/workflow/rules/upgrade'.

  57.      * At this page, you may choose the Rules 1.x rules and rule sets to upgrade

  58.        and whether the converted configurations should be immediately saved to

  59.        your database or whether the configuration export should be generated.

  60.      * Note that for importing an export the export needs to pass the

  61.        configuration integrity check, what might be troublesome if the

  62.        conversion was not 100% successful. In that case, try choosing the

  63.        immediate saving method and correct the configuration after conversion.

  64.      * A rule configuration might require multiple modules to be in place and

  65.        upgraded to work properly. E.g. if you used an action provided

  66.        by a third party module, make sure the module is in place and upgraded

  67.        before you convert the rule.

  68.      * If all required modules are installed and have been upgraded but the rule

  69.        conversion still fails, the cause might be that a module has not yet

  70.        upgraded its Rules integration or does not implement the Rules conversion

  71.        functionality. In that case, file an issue for the module that provided

  72.        the action or condition causing the conversion to fail.

  73.      * Note that any rule configurations containing token replacements or PHP

  74.        input evaluations might need some manual corrections in order to stay

  75.        working. This is, as some used token replacements might not be available

  76.        in Drupal 7 any more and the PHP code might need to be updated in order

  77.        to be compatible with Drupal 7.

  78.      * Once the upgrade was successful, you may delete the left over Rules 1.x

  79.        configurations by going to 'admin/config/workflow/rules/upgrade/clear'.

  80.   * The Rules Scheduler module also comes with an upgrade routine that is

  81.     invoked as usual via "update.php". Its actions can be upgraded via the usual

  82.     Rules upgrade tool, see above.

  83.     However, there is currently no support for upgrading already scheduled

  84.     tasks. That means, all previously on Drupal 6 scheduled tasks won't apply

  85.     for Drupal 7. The Drupal 6 tasks are preserved in the database as long as

  86.     you do not clear your Rules 1.x configuration though.

  87.   * The Rules Forms module has not been updated to Drupal 7 and there are no

  88.     plans to do so, as unfortunately the module's design does not allow for

  89.     automatic configuration updates.

  90.     Thus, a possible future Rules 2.x Forms module is likely to work

  91.     different, e.g. by working only for entity forms on the field level.