System Event Definition

4 min

System events provide an API and methodology for processing any type of event that can handled asynchronously and on background threads.

Candidates for this type of event include audit related actions, triggering integrations and batch calculations.

The system event definition record provides documentation on a System Event.

System event

The System Event is a generic record that describes an event that has occurred.

Field	Description	Specifics
Name	The name of the event.	Required
Queue	The queue that will process the event. Different queues can be configured to allow jobs for specific functions to be disabled (for example, Full Text indexing could be disabled for upgrade or performance reasons).	Defaults to ‘default’ which is the base shared event queue.
Status	The status of the event.	ready, processed, error
Table	If the event is related to a Table/Record, the Table of the related record.
Identifier	If the event is related to a Record, the ID of the record.
Parameter X Name	The name of the parameter. Optional and only for readability.
Parameter X	The value of the parameter. Optional and specific to the event implementation.
Message	Used for displaying error conditions on a failed event
Payload	An alternate mechanism for passing event state. Useful for when the simple parameters are not adequate.

System event scripts define the business logic used to process the system events.

Field	Description	Specifics
Name	The name of the event.	Required
System event	Reference to the System event this script actions.	Required
Active	Whether the script is active or not
Order	The order the scripts will be processed in the event more than one match.
Description	Optional. Description/documentation related to the System Event Script.
Table	Provides an optional mechanism to further filter the event in conjunction with the Condition field.
Condition	Provides an optional mechanism to further filter the event in conjunction with the Table field.
Script	A script that provides the logic to apply to the System Event.Available parameters🎫 A reference to the SystemEvent recordcurrent: A reference to the record the event is actioning (denoted by the Table/Identifier fields in the System Event.