Versions Compared

Old Version 43

changes.mady.by.user Igor Shakhbazyan

Saved on

compared with

New Version Current

changes.mady.by.user Dina Baksheeva

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Events allow create creating tasks for server-side scripts script executing, immediate or scheduled, or notification sending at a specified point of in time. These are the most common use cases of system events using. Also, it is possible to . You can also use one event register for both the needs listed above.

To use the system events in your tasks, you need to :

Create

create an event register record.

After thisThen, you can handle it in one of these the following ways:

  1. Define a server script for a system event ( by creating a record in the Event Script Action Actions (sys_event_script_action) dictionary) dictionary.
  2. Define a notification rule to  to send notifications.
  3. You can combine the options listed above, so your event register record will be able to trigger can trigger actions and send notifications cooperatively , if you bound bind them with this record.

Event structure

Creating an event

To create an event, use the server-side API methods methods ss.eventQueueor ss.eventQueueScheduled should be used. Create an event as described in the referenced articles, and as referenced articles. As a result, records in the the Event (sys_event) table will be created.

Note

You cannot create, edit, or delete records in the Events (sys_event) table manually. Only users with the admin role can read them.

The example of such record is described below.

Tip

Role required: admin.

Anchor
Event Record
Event Record
Event

Record

form fields

Field

Description

Name

The name of the record called from the Event Register (sys_event_register) table.

Instance

The ID of the Record object.

When creating an event via calling methods ss.eventQueueor ss.eventQueueScheduled, you have to pass on the Record object. The object ID will be saved in this field.

You 'll be able to can call on this value in the the Event Script Action (sys_event_script_action) script body:

event.instance

Table

This field contains a reference to the record table that was passed at the time when the event has been was created. This field is populated automatically.

Process started at

The date and time of the system event execution start. As for scheduled events, this field is populated with the value passed by the third parameter of the ss.eventQueueScheduled method.

The date and time of the Event (sys_event) script execution.

Process finished on

The date and time of the system event execution finish.

Param_1...Param_ 5

The string parameters that can be transmitted to the specified Event (sys_event) record via the SimpleOne server-side API (ss.eventQueue and ss.eventQueueScheduled methods).

State

Event state:

  • Ready – event is pending for execution. Execution time is specified in the Process finished on field.
  • Processing – the event is being executed.
  • Processed – the event has been processed. Processing time is specified in the Process finished on field.
  • Error – the event processing has been have failed.  Processing Processing time is specified in the Process finished on field.
  • Canceled - the event will not process after changing the states from the Ready state to this one.

Processing duration, ms

The system event processing duration (Duration of the system event processing in milliseconds).

User

The script specified in the Event Script Action record will be executed with the permissions of this user, and the ACL restrictions will also be also taken into account. 


Info

This field is always populated with the system user (which can also be also displayed as 100000000000000000 on forms). This is the user on behalf of which the event should be executed. 

Information The Created by field contains the information about the event originator (an a user on behalf of which this event has been created) is written down to the Created By field. 


Related lists area are bound with the event record contains containing the following lists:

  • The list of all related event register records from the Event Register (sys_event_register) table.
  • The list of all scripts all the scripts from the Event Script Action (sys_event_script_action) table are referenced to the current record.

Anchor
Event Register
Event Register
Event Register form fields

Field

Description

Name

The name

Name of the event register record.

Events (the Event (sys_event) table records) called for this register

will

contain this value in the Name field.

Table

Starts with only those events that contain a record related to a specified table. 

If you are going to trigger email sending with this record, then

make sure than

ensure that the value in the Table field in the Notification Rule record is the same

than

as in this event register record.

DescriptionEvent register record description.
Disable script logging

Select

this

the checkbox to disable script execution logging (to the Script Logs (sys_log_script) table) when the related event

started

starts up.

Related lists area lists area bound with the event register record contains containing the following lists:

  • The list of all scripts all the scripts from the Event Script Action (sys_event_script_action) table are referenced to the current record.
  • The list of all Notification Rules triggered by the record of the current event register record.

Anchor
Event Script Action
Event Script Action
Event Script Action form fields

Field

Description

Name

The name

Name of the event script action.

Event Register Record

The reference to the record in the Event Register (sys_event_register) table.

ActiveSelect this checkbox to make the script action active or inactive.
Execution orderSpecify the event script action execution order if there
are more than one record 
is more than one record for the related Event Register (sys_event_register) table. Actions are executed in ascending order.

Script

The script is executed when the event occurs.

Info

In the Event Script Action, the event object is

fired.

There are five additional string parameters (Param_1 ... Param_5) available in the script body, so you can call their value this way:

event.param_1, event.param_2;

You can also address to other field values of the following record:

event.column_name

available. The object is the instance of the SimpleRecord class and refers to a record from the Event (sys_event) table that started the script. To get the values of the record fields, use the dot-notation for the event object. To do this, you need to use properties with names corresponding to the names of record fields. For example: 

Code Block
languagejs
themeEclipse
linenumberstrue
const currentRecord = new SimpleRecord(event.table_id.name);
currentRecord.get(event.instance);
if (String(currentRecord.state) !== event.param_1) {
    currentRecord.state = event.param_1;
    currentRecord.update();
}


You can also update the parameters (Param_1...Param_ 5) of the event object with the Event Script Action.

Code Block
languagejs
themeEclipse
titleScript example
linenumberstrue
(function executeEventScript(event) {
  const lastComment = new SimpleRecord('sys_activity_feed_item');
  lastComment.addQuery('table_id', '156950677111866258'); // itsm_incident
  lastComment.addQuery('record_id', event.instance);
  lastComment.addQuery('type_id.name', '!=', 'history');
  lastComment.orderByDesc('sys_created_at');
  lastComment.setLimit(1);
  lastComment.query();
  event.param_5 = lastComment.next();
})(event);
Events are the objects of the Event (sys_event) table, so any fields can be addressed, as well as through dot-walking feature.


 Table of Contents
absoluteUrltrue
classfixedPosition
...