Configured Events: Custom Metadata

The list of configured events is set on the Custom Metadata > Events tab in the Parameters dialog box.

NOTE. Event setup is available for the users included in the Administrators group.

In the web application select the Parameters item on the side panel of the object navigator.
In the desktop application select the Tools > Parameters item in the object navigator's main menu.

To create an event, execute one of the operations:

Click the Add button.
Select the Add item in the context menu of the list of events.

A new event will be added to the list, name can be set for this event. Event identifier is generated automatically.

To delete the event, execute one of the operations:

Select one or several events in the list and click the Delete button.
Select the Delete item in the event's context menu.

After confirmation the selected events will be deleted.

Event occurrence is traced with task scheduler interface is used to work with the events collection. In this case the task container specified in task scheduler settings should contain tasks run on occurring the configured event.

An event may occur after executing a task if the corresponding setup is created for it. An event can also be generated from application code. The IMetabaseCustomForeEvents interface is used to work with the events collection. To generate an event, get its description by means of properties or methods of the specified interface, and execute the IMetabaseCustomForeEvent.Invoke method.

The example of generating event named Loading Start. If on performing the example the task scheduler is run, and the container, with which the task scheduler works, has tasks started on executing this event, they will be performed.

Sub InvokeEvent;
Var
    MB: IMetabase;
    CustomClassExtender: IMetabaseCustomExtender;
    Events: IMetabaseCustomForeEvents;
    ForeEvent: IMetabaseCustomForeEvent;
Begin
    MB := MetabaseClass.Active;
    //Get user class container
    CustomClassExtender := Mb.SpecialObject(MetabaseSpecialObject.CustomExtender).Edit As IMetabaseCustomExtender;
    //Get events list
    Events := CustomClassExtender.Events;
    ForeEvent := Events.FindByName("Loading Start");
    //Event generating
    ForeEvent.Invoke;
End Sub InvokeEvent;