Skip to main content

1E 8.1 (on-premises)

Raise

Warning

This function is for internal use only.

Function

Raise

Action

A built-in function to raise one or more events.

Parameters

Topic (string): The topic that will be applied to the supplied event(s), for example: "Process.Crash".

Note

The topic name is not case-sensitive.

Timestamp (string, optional, default empty): A string representing the ISO-8601 timestamp that will be applied to the supplied event(s).

Note

If not given, the timestamp is the time of execution.

EventData (table, optional, default empty): Data to be associated with the event(s) which will be raised. An event will be created for each row in the table.

Note

It is not mandatory for an event to have associated data, in which case just 1 event will be raised.

Priority (string, optional, default 0): The priority of the event. 0 = standard, 1 = urgent.

Standard events may be batched and not sent for a few seconds for efficiency reasons, whereas urgent events are sent immediately.

New in v5.2.

Return values

EventCount (integer): The number of events that have been successfully raised.

Note

This will be 1 if there was no EventData table or it was empty, else this will equal the number of rows provided in the EventData table for which an event was successfully raised.

Example

Example - raise an event for each row in @stoppedServices

Raise(Topic: "Service.Stopped", EventData: @stoppedServices, Timestamp: "2019-09-15T18:25:43.511Z");

Platforms

  • All

Notes

From v5.0.