Groovy: example run a rule by dilyanpalauzov · Pull Request #2701 · openhab/openhab-docs

dilyanpalauzov · 2026-04-13T08:35:05Z

This demonstrates how to execute a Rule by UID from a DSL rule or DSL script. It depends on openhab/openhab-core#5484.

netlify · 2026-04-13T08:38:22Z

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`1cca5a1`
🔍 Latest deploy log	https://app.netlify.com/projects/openhab-docs-preview/deploys/6a009963cc735e00085ad7ac
😎 Deploy Preview	https://deploy-preview-2701--openhab-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

stefan-hoehn · 2026-04-13T10:02:42Z

@rkoshak @cweitkamp Can you review this?

Copilot

Pull request overview

Adds documentation to demonstrate executing an automation Rule by UID from Rules DSL via RuleManager.runNow(), complementing existing DSL rule examples.

Changes:

Add a “Run A Rule” section describing how to trigger a rule by UID.
Provide a Rules DSL code snippet that looks up the RuleManager OSGi service and calls runNow("r2").

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-13T10:06:45Z

+val ruleManager = ruleManagerBundleContext.getService(ruleManagerServiceReference)
+ruleManager.runNow("r2")


The sample retrieves an OSGi service via BundleContext.getService(...) but never releases it. In OSGi this increments the service use count; please wrap usage in try/finally and call bundleContext.ungetService(ruleManagerServiceReference) (and only after confirming the reference is non-null).

Suggested change

val ruleManager = ruleManagerBundleContext.getService(ruleManagerServiceReference)

ruleManager.runNow("r2")

if (ruleManagerServiceReference !== null) {

val ruleManager = ruleManagerBundleContext.getService(ruleManagerServiceReference)

try {

ruleManager.runNow("r2")

} finally {

ruleManagerBundleContext.ungetService(ruleManagerServiceReference)

}

}

I added ruleManagerBundleContext.ungetService(ruleManagerServiceReference).

I am not aware how RuleManager.runNow(String) can throw an exception, so i am not going to wrap it in try {…} finally {…}.

Likewise I cannot think of an example, where the returned values from OSGi are null. Adding comparison to null will make the examples unnecessary complicated.

Copilot · 2026-04-13T10:06:46Z

+val ruleManager = ruleManagerBundleContext.getService(ruleManagerServiceReference)
+ruleManager.runNow("r2")


This snippet assumes getServiceReference(...) always returns a reference. If the RuleManager service is unavailable, ruleManagerServiceReference will be null and the subsequent getService(...) call will fail; please add a guard with a clear log message or alternative behavior when the reference/service cannot be obtained.

Suggested change

val ruleManager = ruleManagerBundleContext.getService(ruleManagerServiceReference)

ruleManager.runNow("r2")

if (ruleManagerServiceReference === null) {

logWarn("rules-dsl", "RuleManager service reference is unavailable; cannot run rule 'r2'")

} else {

val ruleManager = ruleManagerBundleContext.getService(ruleManagerServiceReference)

if (ruleManager === null) {

logWarn("rules-dsl", "RuleManager service is unavailable; cannot run rule 'r2'")

} else {

ruleManager.runNow("r2")

}

}

If somebody provides an example/test scenario, where OSGi returns null, or runNow() throws an exception, I will amend the example accordingly.

Copilot · 2026-04-13T10:06:46Z


+### Run A Rule
+
+A rule with UID `r2` can be executed with [RuleManager.runNow()](https://www.openhab.org/javadoc/latest/org/openhab/core/automation/rulemanager#runNow(java.lang.String)):


Within this document, other JavaDoc links use the https://openhab.org/... domain (e.g., the HSBType link earlier). For consistency (and to avoid mixed-domain links), consider switching this URL from https://www.openhab.org/... to https://openhab.org/....

Suggested change

A rule with UID `r2` can be executed with [RuleManager.runNow()](https://www.openhab.org/javadoc/latest/org/openhab/core/automation/rulemanager#runNow(java.lang.String)):

A rule with UID `r2` can be executed with [RuleManager.runNow()](https://openhab.org/javadoc/latest/org/openhab/core/automation/rulemanager#runNow(java.lang.String)):

I removed www..

rkoshak · 2026-04-15T14:52:53Z

As I use neither Rules DSL nor jRuby I don't know if I'm the right person to review from a technical perspective. I assume @dilyanpalauzov tested the code itself.

Given openhab/openhab-core#5481, I wonder if it makes more sense to wait until we determine what's going to happen with that PR and if it looks like it won't make it until OH 5.2 then look at merging this. If it does make it, these docs should change to refer to these new "System" actions being added.

I can review for grammar and word choice and the like but didn't see anything needing correction or comment.

lolodomo · 2026-05-05T11:02:43Z

There is an easy way coming for 5.2 (if contribution is merged).
So let's pause this change and merge it just before 5.2 is released only if the other change is not merged.

dilyanpalauzov · 2026-05-10T11:48:02Z

I changed val with var and voilà - the example is now both for Groovy and for Xbase/DSL Script/DSL Rule. I labelled it as “Groovy”.

I moved the exmaple also to another location, which already contained examples to run a rule (Scene) for JavaScript⇔GraalVM and JRuby.

dilyanpalauzov mentioned this pull request Apr 13, 2026

[DSL] Add extra commands/abilities to DSL scripts/rules openhab/openhab-core#5481

Open

dilyanpalauzov force-pushed the dsl_runrule branch from b41fab6 to 79dfba1 Compare April 13, 2026 08:42

stefan-hoehn requested a review from Copilot April 13, 2026 10:02

Copilot started reviewing on behalf of stefan-hoehn April 13, 2026 10:03 View session

Copilot AI reviewed Apr 13, 2026

View reviewed changes

dilyanpalauzov force-pushed the dsl_runrule branch 2 times, most recently from f47ff34 to 97dbe10 Compare April 14, 2026 06:50

dilyanpalauzov force-pushed the dsl_runrule branch from 97dbe10 to 06ccafb Compare May 10, 2026 11:46

dilyanpalauzov changed the title ~~DSL Rules: example run a rule~~ Groovy: example run a rule May 10, 2026

dilyanpalauzov force-pushed the dsl_runrule branch from 06ccafb to 70e3dbe Compare May 10, 2026 11:52

Groovy: example run a rule

1cca5a1

dilyanpalauzov force-pushed the dsl_runrule branch from 70e3dbe to 1cca5a1 Compare May 10, 2026 14:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Groovy: example run a rule#2701

Groovy: example run a rule#2701
dilyanpalauzov wants to merge 1 commit into
openhab:mainfrom
dilyanpalauzov:dsl_runrule

dilyanpalauzov commented Apr 13, 2026

Uh oh!

netlify Bot commented Apr 13, 2026 •

edited

Loading

Uh oh!

stefan-hoehn commented Apr 13, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 13, 2026

Uh oh!

dilyanpalauzov Apr 14, 2026

Uh oh!

Copilot AI Apr 13, 2026

Uh oh!

dilyanpalauzov Apr 14, 2026

Uh oh!

Copilot AI Apr 13, 2026

Uh oh!

dilyanpalauzov Apr 14, 2026

Uh oh!

rkoshak commented Apr 15, 2026 •

edited

Loading

Uh oh!

lolodomo commented May 5, 2026

Uh oh!

dilyanpalauzov commented May 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		val ruleManager = ruleManagerBundleContext.getService(ruleManagerServiceReference)
		ruleManager.runNow("r2")

-val ruleManager = ruleManagerBundleContext.getService(ruleManagerServiceReference)
-ruleManager.runNow("r2")
+if (ruleManagerServiceReference === null) {
+    logWarn("rules-dsl", "RuleManager service reference is unavailable; cannot run rule 'r2'")
+} else {
+    val ruleManager = ruleManagerBundleContext.getService(ruleManagerServiceReference)
+    if (ruleManager === null) {
+        logWarn("rules-dsl", "RuleManager service is unavailable; cannot run rule 'r2'")
+    } else {
+        ruleManager.runNow("r2")
+    }
+}


		### Run A Rule

		A rule with UID `r2` can be executed with [RuleManager.runNow()](https://www.openhab.org/javadoc/latest/org/openhab/core/automation/rulemanager#runNow(java.lang.String)):

Uh oh!

Conversation

dilyanpalauzov commented Apr 13, 2026

Uh oh!

netlify Bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Uh oh!

stefan-hoehn commented Apr 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

dilyanpalauzov Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

dilyanpalauzov Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

dilyanpalauzov Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

rkoshak commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lolodomo commented May 5, 2026

Uh oh!

dilyanpalauzov commented May 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

netlify Bot commented Apr 13, 2026 •

edited

Loading

rkoshak commented Apr 15, 2026 •

edited

Loading