refresh_server_events()

Reloads the server-side scripting events (OsEvents) via adm.ServerEventsRefresh so that created, modified, or deleted events become active immediately — without restarting the server.

The DMS engine caches the registered OsEvents. A create_os_event(), update_os_event(), or delete_os_event() changes the database but does not take effect until the cache is reloaded (normally on a server restart). This method triggers the reload immediately.

1. Signature

  • Sync

  • Async

ecm.system.refresh_server_events() -> None
await ecm.system.refresh_server_events() -> None

2. Parameters

None.

3. Return value

None (None). A server error raises an exception.

4. Examples

  • Sync

  • Async

event_id = ecm.system.create_os_event(
    ECMOsEventCode.KERNEL_BEFORE_JOB,
    script="...",
)
ecm.system.refresh_server_events()  # activate without restart
event_id = await ecm.system.create_os_event(
    ECMOsEventCode.KERNEL_BEFORE_JOB,
    script="...",
)
await ecm.system.refresh_server_events()  # activate without restart

5. See also