River Docs

Rules

Find, build, and edit rules. Do a test before you save.

Use Rules to find matching data and open issues, send notifications, or produce CSV exports. You need the rules permission and a configured data source.

Find a rule

Open Rules from the main navigation.

Rules listRules list

Use the search field to find a rule by name or description. Use the status filter to show active or inactive rules.

Admins can use Run All Rules to select a month range and run the rules. The server enforces a five-minute cooldown. The Run control on a row runs only that rule.

Configure a rule

Click Create rule, or open an existing rule.

Rule builderRule builder

Open a rule and change its threshold without saving.

The builder has Configure and Test tabs.

  1. Enter the rule name and description.
  2. Under When, select the data source.
  3. Select Conditions or Raw SQL.
  4. Under Then, configure the actions.

Changing the source removes the existing branches. Select the source before you build conditions.

Branches run from top to bottom. The first matching branch wins. Drag branches to change their order. A branch without conditions matches all rows.

Raw SQL uses the rows returned by your query as matches. Do a test before you save the query.

The available actions are:

  • Open issue: configure the title, description, severity, assignee, due date, and icon. Use ${field} to insert row values into templates.
  • Send notification: select roles or people. Each person's notification settings apply.
  • Write CSV export: produce files in Reports. Replace keeps the latest CSV. Append keeps one CSV for each run.

Do a test and save

Open Test. Click Run test. A test does not run actions.

Do a test, review matching rows, and inspect the generated SQL.

The results show the number of scanned rows and the matching rows. Each matching row identifies its branch. Click View SQL to inspect the generated SQL.

Review the matches. Put a specific branch before a broader branch. Use template fields from the selected source.

Select Active or Paused in the footer. Click Create rule for a new rule, or Save changes for an existing rule. Saved confirms the saved state.

Change an existing rule

Structural changes can affect issues that the rule already opened. The impact dialog provides these choices:

  • Keep editing: return to the builder without saving.
  • Save as new rule: create a separate rule. The original rule remains available.
  • Save and delete old issues: replace the rule and permanently delete its previous issues.

A name change alone does not show this dialog.

On this page