Create an event
If you do not find a suitable existing event, you can create your own.
Before you begin
Role required: events_admin
About this task
The gs.EventQueue function works directly with the backend and therefore business rules that are called by gs.EventQueue() are not invoked.
Procedure
Navigate to All > System Policy > Events > Registry, and then select New.
On the form fill in the fields.
| Field | Description |
|---|---|
| Event name | Name of your new event. |
| Table | Database table for this event. Note: Only tables and database views that are in the same scope as the event appear on the listing. |
| Queue | Name of the queue that the event is placed into when triggered.Use only lowercase letters, no spaces, and no special characters except underscore \(\_\). For example, `my_queue`. See Using custom queues to process events. |
| Priority | Order in which messages will be processed. Lower values have higher priority.Note: The com.glide.sysevent.priority.enabled system property is enabled by default. If you disable it, events processing is not done by priority. |
| Caller Access | Restricted caller access settings.- Caller Restriction: calls to the resource must be manually approved. - Caller Tracking: Calls to the resource are automatically approved. |
| Fired by | Name of the business rule that runs the event. This field is for reference only and is not used by any process. Make sure that there is enough information to locate your event again. |
| Description | Short description of the purpose of the event. |
Click the Business Rules related link.
If you are creating an event for a base system table, select the existing event business rule for the table.
For example, select the sc request events business rule to create a custom Request event.
If you are updating an existing event business rule, add a new condition to the Script.
The following sample script adds a request.commented event with the user's Sys ID as parm1 and the user's user name for parm2.
if (current.operation() != 'insert' && current.comments.changes()) { gs.eventQueue('request.commented', current, gs.getUserID(), gs.getUserName()); }If you are creating an event for a custom table, create a new business rule that runs after database operations.
For example, this business rule defines several events for a custom application called Marketing Events.
| Field | Value |
|---|---|
| Name | Attendee Events |
| Table | Attendee \[x\_snc\_marketing\_ev\_attendee\] |
| Application | Marketing Events |
| Advanced | Selected |
| When | after |
| Insert | Selected |
| Update | Selected |
| Delete | Selected |
| Script | Add custom script that: - Checks for one or more conditions on the current record. - Calls the gs.eventQueue\(\) method and specifies an event name. See code sample. |
**Note:** If you add **Filter Conditions**, **Role conditions**, or a **Condition** value, verify it runs the business rule when expected.
```
(function executeRule(current, previous /*null when async*/) {
//This function will be automatically called when this rule is processed.
//Add event when attendee inserted
if(current.operation() == 'insert' && current.marketing_event.changes()) {
gs.eventQueue('x_snc_marketing_ev.attendee.added', current,
current.marketing_event, current.email);
}
//Add event when marketing event changes
if(current.operation() == 'update' && current.marketing_event.changes()) {
gs.eventQueue('x_snc_marketing_ev.attendee.deleted', previous,
previous.marketing_event, previous.email);
gs.eventQueue('x_snc_marketing_ev.attendee.added', current,
current.marketing_event, current.email);
}
//Add event when attendee deleted
if(current.operation() == 'delete') {
gs.eventQueue('x_snc_marketing_ev.attendee.deleted', current,
current.marketing_event, current.email);
}
})(current, previous);
```
- Register the event.
What to do next
Create a script action or notification to process the event.
Parent Topic:Managing system events
Related topics