HowTo: Using Global Events in Web Objects

Official Content
This documentation is valid for:

Most times it's necessary to implement a solution where one action in a Web Component object of the screen causes a reaction in another web component.

For example, trigger an action in some web component if the user selects an item in a Menu (of another component of the screen).

Since communication between the web components of the screen is a bit limited - the only feasible communication is between parents to children-, Global Events are very useful for enabling the GeneXus user to establish communication between Web Components that are disengaged (1)

 

Benefits of using Global Events on the web:

  • Global Events give a solution for communication between the web components of a form.
  • Also, you can execute a specific event of a component with no need to Refresh the component's form.

 

 

Example

Communicating with a sibling object

An action in component A should trigger an action in component B.

i2016_08_13_20_21_394

Consider a hypothetical case where we have two sibling components, one of them ("AuthorsComponent") loads a list of Authors, and the other ("BooksComponent") filters the literary works of the author selected in the first component.

i2016_08_13_20_24_165_png

As both components have no communication with each other, the best way to trigger the refresh of the Component B's grid is to use Global Events.

1. Open the GlobalEvents external object and add an event called "SelectAuthor". Consider adding the necessary parameters there.

i2016_08_15_23_09_261_png

2. In the "AuthorsComponent" we call the "SelectAuthor" Global Event when the user activates a line of the grid.

"AuthorsComponent" code:
Event grid1.OnLineActivate
    GlobalEvents.SelectAuthor(AuthorId)
Endevent

3. In "BooksComponent" we define the "SelectAuthor" Global Event. It receives the &authorId as a parameter and calls the grid refresh. &authorId is a variable present on the screen in this case.

"BooksComponent" code
Event GlobalEvents.SelectAuthor(&authorId)
    grid1.Refresh()
Endevent

Here we've shown a particular example, but any combination of the localization of the components in the form is possible. The parent object of all the components can also define or invoke a Global Event.

Note:

In this scheme, there are N web components that can publish an event, and M web components which are subscribers to the events.

 

Then, another web component could subscribe to the "SelectAuthor" Global Event. For example, a component that shows the author's biography.

Sample Literature Global Events2

To try it yourself, download the sample Web Global Events sample for books.

 

Restrictions

  • If a web component which defines a Global Event is present more than once on the screen, the Global Event is called only once (only for one instance of the web components and not for all of them).
  • Global Events can only be called from objects with UI (web panels and web transactions). In Business Component rules, they have to be called inside the [Web] section. Eg: 
    Web Trn rules:
    [ web ] 
    {
    GlobalEvents.TotalWorksEvent(-1) 
        if delete on aftercomplete;
    
    GlobalEvents.TotalWorksEvent(1) 
        if insert on aftercomplete;
    }

(1)The traditional problem of web components communication

The traditional ways to communicate between web components (solution without Global Events), are:

  1. Executing a Refresh Web Component command
    In general, web sessions are used to pass information to other web components, and the web session is read in a Refresh event.
    However, the WebComponent.Refresh command can be executed for the child components of a given component, not for parents or siblings.
    Besides, the Refresh command executes a full refresh of the screen, and in the majority of the cases, this is not desired.
     
  2. Calling the Web Component, passing it the necessary parameters (WebComponent.create command).
    A Web Component can be created as a child, you cannot create parent or sibling components.

In sum, sibling components, cannot communicate with each other, and one web component cannot communicate with its parent or grandparents.


Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.