Skip to content

Commit 0710de0

Browse files
authored
Merge pull request #3 from ISISComputingGroup/Ticket_8731_Alerts_Dialog
Ticket8731_GUI Changes for configuring Alerts
2 parents dad3c36 + 1292945 commit 0710de0

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

doc/gui/Menu-Bar.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ IOC Menu
5454
Start/stop IOCs
5555
Selecting the Start/stop IOCs menu item displays a dialog allowing you to start an IOC or to stop an IOC that is currently running.
5656

57-
Run-Control Menu
58-
----------------
57+
Block Actions Menu
58+
------------------
5959
View run-control settings
6060
Selecting the View Run-Control Settings menu item displays a dialog showing you which blocks (if any) are currently under run-control. You can also assign new run-control settings to blocks and modify or remove existing run-control settings.
6161

@@ -81,6 +81,11 @@ You can change run-control settings in 3 different ways (2 temporary and 1 perma
8181

8282
The :doc:`Blocks-and-Groups` page describes how blocks under run-control are shown in the GUI.
8383

84+
Alert on blocks settings
85+
1. Selecting the "Alert on blocks settings" menu item displays a dialog showing us blocks in current configuration and the facilitates configuring the alert parameters for individual blocks.
86+
2. The dialog also shows the emails and mobiles configured for receiving the alerts. We can change change these values.
87+
3. We can also send a test message of our choice. This message is changed by the server, once a new alert condition happens.
88+
8489
Preferences Menu
8590
----------------
8691

@@ -101,4 +106,4 @@ Console Log
101106
Icon Licences
102107
View the licences for the icons used in IBEX
103108
Get help
104-
Displays support telephone numbers and how to get help or report problems.
109+
Displays support telephone numbers and how to get help or report problems.

doc/scripting/Alerts-on-Blocks.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,12 @@ Alerts, like run control, are normally set on floating point (or integer) value
4141
g.alerts.set_range("RunState", -1.0, 3.5, delay_in=5.0, delay_out=300.0)
4242
```
4343
will send an alert if the instrument has been WAITING or VETOING (>3.5) for more than 300 seconds.
44-
44+
45+
## GUI for managing alerts
46+
There is a convenient way to configure alerts details using the IBEX client.
47+
The GUI is available from the top-level menu item "Block Actions", which was previously called Run-control.
48+
<img width="1213" height="691" alt="image" src="https://github.com/user-attachments/assets/58258fe2-1efd-4956-a0d6-ffeb8aebcb05" />
49+
4550
## Sending alert messages directly from scripts
4651
You can also send an immediate alert message from an executing script by doing the following
4752
```python
@@ -53,8 +58,10 @@ g.alerts.set_email(["a@b", "c@d"])
5358
if bad_thing_happened:
5459
g.alerts.send("Help, a bad thing has happened!")
5560
```
61+
## Sending alert messages from the GUI
62+
Use the Send Message button (highlighted in blue below) in the Alert Settings GUI to send a custom message to the configured emails and/or mobiles.
63+
<img width="1213" height="691" alt="image" src="https://github.com/user-attachments/assets/dbe2304d-ad36-4551-959a-803127ac5745" />
5664

5765
## Future enhancements
58-
* Create GUI for managing alerts, similar to how run control is done now
5966
* Allow saving alerts into a configuration/component
6067

0 commit comments

Comments
 (0)