Servicely Administration
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 script 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