Rules Essentials

Documentation for the Rules Essentials module. A work in progress.

This documentation guide attempts to do three things:

Provide a description of the Rules module, how it works, and how to use it to enhance your site.
Provide a detailed guide for programmers wanting to implement Rules support, port Rules support from Drupal 7, or migrate configured Rules from a Drupal 7 site.
Provide documentation for the new features added by the Rules Essentials module.

The Rules Essentials module adds numerous enhancements to the Rules user interface. While most of the documentation in this guide is general information about Rules, if you don't have Rules Essentials installed and enabled you will find the screenshots in this guide reflect these UI enhancements and appear different (sometimes significantly so) from the default Rules UI.

What is Rules?

What the Rules module does, why you might want to use it

Data selection

Describes how the Data selection input mode works

Direct input

Describes how the Direct input mode works

Global Context Variables

This module adds some new global context variables

Token replacement

Rules allows you to use data variables as tokens

Events

This module adds some new Events

Conditions

This module adds some new Conditions

Actions

This module adds some new Actions

Importing and Exporting Rules

A tutorial on how to use the core Drupal Configuration Manager module to import and export Rules

Examples

A collection of example Reaction Rules

Troubleshooting

How to solve problems, get help, and report bugs

How to report issues

For Developers

A guide to programming your own Rules and using Rules programmatically

Further reading

A collection of links to related documentation

Glossary

A list of Rules terminology

Changes to Rules in Drupal 8

If you are familiar with the Drupal 7 version of Rules, this page provides a brief overview of the changes to Rules in Drupal 8

Tags

Guide maintainers