Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Events allow executing creating tasks for server-side scripts at some point of time or a certain schedule
Every script executing event consists of:
script executing, immediate or scheduled, or notification sending at a specified point in time. These are the most common use cases of system events. You can also use one event register for the needs listed above.
To use the system events in your tasks, you need to create an event register record.
Then, you can handle it in one of the following ways:
the script body (stored in the- Define a server script for a system event by creating a record in the Event Script Actions (
- sys_event_script_action
- ) dictionary.
- Define a notification rule to send notifications.
- You can combine the options listed above, so your event register record can trigger actions and send notifications cooperatively if you bind them with this record.
Event structure
Image Added
Creating an event
To create an event, use the server-side API methods ss.eventQueueor ss.eventQueueScheduled. Create an event as described in the referenced articles. As a result, records in 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 | ||||
---|---|---|---|---|
|
The event structure:
Image Removed
Field
Description
Name
The name of the record called from the Event Register (sys_event_register
table) table.
Instance
ID of the Record object.
When creating an event via calling methods ss.eventQueueor ss.eventQueueScheduled, you
can 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
The This field contains a reference to the record table that
contains the record specified in the Instance field.was passed at the time the event 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.
Process onThe date and time of the Event (sys_event
_script_action script ) script execution.
ProcessedProcess finished on
The date and time
when of the system event
has been doneexecution finish.
Param_1...Param_ 5
The
String parameters. the values of them are callable in the sys_event_script_action script: event.param_1, event.param_2 and so onstring 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 - Ready – event is pending for execution. Execution time is specified in the Process
on field- finished on field.
- Processing – the event is being executed.
processed - Processed – the event has been processed. Processing time is specified in the
Processed field- Process finished on field.
error - Error – the event processing
has been failed- have failed. 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 sys_event_script_action script 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 taken into account.
Info This field is always populated with the system user (which can also be displayed as 100000000000000000 on forms). This is the user on behalf of which the event should be executed.
The Created by field contains the information about the event originator (a user on behalf of which this event has been created).
The Related List on the form event contains the
Field | Description |
---|---|
Name | The name of the record called from the Event Register (sys_event_register |
) table. | |
Instance | 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 |
can call |
this value in |
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 the event 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: |
|
|
|
|
|
|
Processing duration, ms |
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 taken into account.
|
Related lists are bound with the event record containing the following lists:
- The list of all related event register records from the Event Register (sys_event_register) table.
- The list of all the scripts from
- the Event Script Action (sys_event_script_action
Event Register Record
Поле
Описание
Name
Имя записи регистра, на которую будет ссылаться скрипт и по которому будет вызываться событие в записи события
На форму события выведен Related List, содержащий список всех скриптов из таблицы sys_event_script_action которые ссылаются на текущую запись.
Event Script Action Record
Поле
Описание
Name
Имя записи скрипта события
Event Register Record
Ссылка на запись в таблице sys_event_register
Script
Скрипт выполняемый при вызове события.
В теле скрипта доступны для выбора 5 дополнительных параметров Param 1..Param 5 типа String к значению которых можно обратиться:
event.param_1, event.param_2 и т.д.
Также можно обратиться к значению других полей записи:
event.column_name
Создать событие можно добавив новую записи в таблицы sys_event. Для этого через навигатор необходимо перейти: System Definitions -> Event -> New
Либо создать событие через методы серверного API ss.eventQueue и ss.eventQueueScheduled. Подробное описание методов здесь (ссылка на https://wiki.simpleone.ru/wiki/development/view/API/Server/SimpleSystem/)- ) table are referenced to the current record.
Anchor | ||||
---|---|---|---|---|
|
Field | Description |
---|---|
Name | Name of the event register record. Events (the Event (sys_event) table records) called for this register 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 ensure that the value in the Table field in the Notification Rule record is the same as in this event register record. |
Description | Event register record description. |
Disable script logging | Select the checkbox to disable script execution logging (to the Script Logs (sys_log_script) table) when the related event starts up. |
Related lists area bound with the event register record containing the following lists:
- The list of 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.
Anchor | ||||
---|---|---|---|---|
|
Field | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Name of the event script action. | ||||||||||||||||||||||
Event Register Record | The reference to the record in the Event Register (sys_event_register) table. | ||||||||||||||||||||||
Active | Select this checkbox to make the script action active or inactive. | ||||||||||||||||||||||
Execution order | Specify the event script action execution order if there 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.
You can also update the parameters (Param_1...Param_ 5) of the event object with the Event Script Action.
|
Table of Contents | ||||
---|---|---|---|---|
|
...