Skip to main content

Create Event

Add Event

Follow the below steps to create a new event:

  1. From the explorer menu, right-click Event Handlers and Functions in an interface (or) master layout (or) component and select Add Event.
  2. In the properties panel, configure the properties as required and then click save.
PropertyDescriptionComments
Name*Provide the name of an event.Name must start with a character followed by alphanumeric or ''. No spaces are allowed. Except underscore (), no other special characters are allowed. Name cannot start with a number.
Async Operation*Specify whether the event should execute asynchronously (Yes) or synchronously (No) when triggered by an event.Select Yes or No.
DescriptionProvide a brief description of the event.Describe the purpose or functionality of the event.
Is ActiveSpecify whether the event is active for accessing or not. Either Yes or No.By default, it is set to Yes.
note

An asterisk (*) denotes that the property is mandatory for creating an event.

The "Event added successfully" message displays upon successful creation.

  1. The event designer canvas shows the Start and Stop constructs by default. From the ribbon, add the required constructs and configure them as required inside the flow to create a logic. For more information on constructs, refer to Configure Constructs.
  2. Click save.

The "Event updated successfully" message displays upon successful update.

Add Event - Step 1 Add Event - Step 2

Structure of an Event​

The created event contains the following:

  • Input Params to add input parameters for the flow
  • Variables

Event Structure

Add Input Parameters and Variables​

Users can add the parameters and variables to an event as applicable. To add, follow the below steps:

  1. Right-click the Input Parameters (or) Variables and select Add. A pop-up window displays.
  2. Configure the below properties as required and the click Save.
PropertyDescriptionComments
Name*Provide the name of a parameter/variable.Name must start with a character followed by alphanumeric or ''. No spaces are allowed. Except underscore (), no other special characters are allowed. Name cannot start with a number.
Is ArraySpecify whether the parameter is an array.By default, it is set to No.
Type*Select the data type of the parameter from the drop-down.-
Default ValueProvide the default value as required.-
note

An asterisk (*) denotes that the property is mandatory for creating a parameter or variable.

The success message displays upon successfully adding a parameter or variable.

Add Parameter to Event

Constructs​

The following are the constructs available in an event:

Constructs in an Event
If
Continue
Switch
Navigation
Form Dirty Check
Logout
Run Liquid Transformation
Create Anonymous Object
WhenAll