Skip to main content

Events

There are two ways to generate events:
  • Server-side script using the gs.eventQueue() method
  • Workflow Create Event activity

gs.eventQueue() Method

The eventQueue() method is part of the GlideSystem server-side API. The eventQueue() method inserts an event in an event queue. The eventQueue() method is typically passed four parameters but can also take an optional 5th parameter:
  1. Event name. Enclose the event name in quotes.
  2. GlideRecord object, typically current but can be any GlideRecord object from the event's table.
  3. Any value that resolves to a string. This is known as parm1 (Parameter 1). Can be a string, variable that resolves to a string, or method that resolves to a string.
  4. Any value that resolves to a string. This is known as parm2 (Parameter 2). Can be a string, variable that resolves to a string, or method that resolves to a string.
  5. (Optional) Name of the queue to manage the event.

DEVELOPER TIP: Use gs.getUserName() and gs.getUserID() for parm1 and parm2 if no other values are required to see which user triggered the event in the event log.

The Create Event workflow activity is part of the Notifications category.

In the Events Log, an entry with [object Object] for the table has a problem with the record that was passed by the gs.eventQueue() method. The most likely cause is that the object passed was for the wrong table.


Application that create a large volume of events and/or events that take a long time to process should use a custom queue.

Populate the Queue field for the event in the Event Registry to define a custom queue. Use only lowercase letters, no spaces, and no special characters except underscore (_).

Comments