Usage Examples

---

• Effective Registration
• Effective Activation
  • Disabled
  • Continuous Shelved
  • One Shot Shelved
  • Latched
• EPICS
• Admin GUI
• All (everything)

---

Effective Registration

1. Spin up containers

cd examples/compose
docker-compose -f effective.yml up

2. Make sure a category exists

docker exec -it jaws /scripts/client/set-category.py IOC

3. Set (or replace) base class definition

docker exec -it jaws /scripts/client/set-class.py base --category IOC --priority P4_INCIDENTAL --rationale because --correctiveaction fixit --pointofcontactusername tester

4. Set (or replace) a simple alarm

docker exec -it jaws /scripts/client/set-instance.py alarm1 --producersimple

5. Observe class defaults are inherited

docker exec -it jaws /scripts/client/list-effective-registrations.py

Effective Activation

Disabled

1. Spin up containers

cd examples/compose
docker-compose -f effective.yml up

2. Set Disabled override

docker exec -it jaws /scripts/client/set-override.py alarm1 --override Disabled

3. Set Shelved override (has lower precedence)

docker exec -it jaws /scripts/client/set-override.py alarm1 --override Shelved --expirationseconds 90 --reason Other

4. Show overrides

docker exec -it jaws /scripts/client/list-overrides.py

5. Show effective activations

docker exec -it jaws /scripts/client/list-effective-activations.py

Continuous Shelved

1. Spin up containers

cd examples/compose
docker-compose -f effective.yml up

2. Monitor for automated expiration tombstone message

docker exec -it jaws /scripts/client/list-overrides.py --monitor 

3. Shelve an alarm for 5 seconds

docker exec -it jaws /scripts/client/set-override.py --override Shelved alarm1 --reason Other --expirationseconds 5

4. Show effective activations

docker exec -it jaws /scripts/client/list-effective-activations.py

One Shot Shelved

1. Launch Docker

docker-compose up

2. Set activation

docker exec -it jaws /scripts/client/set-activation.py alarm1

3. Monitor overrides

docker exec -it jaws /scripts/client/list-overrides.py --monitor

4. Set one-shot shelved

docker exec -it jaws /scripts/client/set-override.py alarm1 --override Shelved --oneshot --reason Other --expirationseconds 90

5. Unset activation

docker exec -it jaws /scripts/client/set-activation.py alarm1 --unset

Latched

1. Launch Docker

docker-compose up

2. Set (or replace) latching class definition

docker exec -it jaws /scripts/client/set-class.py latchingclass --category IOC --priority P4_INCIDENTAL --rationale because --correctiveaction fixit --pointofcontactusername tester

3. Register alarm1 as member of latchingclass

docker exec -it jaws /scripts/client/set-instance.py alarm1 --producersimple --alarmclass latchingclass

4. Monitor for latch

docker exec -it jaws /scripts/client/list-overrides.py --monitor 

5. Set active (and observe auto-latch)

docker exec -it jaws /scripts/client/set-activation.py alarm1

6. Clear Latch

docker exec -it jaws /scripts/client/set-override.py alarm1 --override Latched --unset

EPICS

1. Spin up containers

cd examples/compose
docker-compose -f epics.yml up

2. Register an alarm (and trigger EPICS monitoring)

docker exec -it jaws /scripts/client/set-instance.py alarm1 --producerpv channel1

3. Trip an alarm

docker exec softioc caput channel1 1

4. Verify that the alarm-activations topic received a properly formatted message

docker exec -it jaws /scripts/client/list-activations.py

Admin GUI

1. Spin up containers

cd examples/compose
docker-compose -f admin-gui.yml up

2. Navigate web browser: http://localhost:8080/jaws-admin-gui/

All

1. Spin up containers

cd examples/compose
docker-compose -f all.yml up