# Actions ## Actions section A section **Actions** allows adding actions to the request for selected components that trigger events. To define an action on the request, first add in the form the component for which you want to define the action (e.g. [Trigger](https://github.com/Consdata/eximee-docs/blob/main/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/trigger.md)) and the component to which the action applies (e.g. [Popup](https://github.com/Consdata/eximee-docs/blob/main/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/popup.md)).

**Figure 1.** Section with defined actions

## Adding an action After clicking the **Add action** at the top of the section above the remaining actions (if there were any already on the request), an empty row is added, in which we first choose the action source in the field **Select action source**. The list will include only those request components for which an action can be defined.

***Figure 2.** Row for defining a new action*

**Figure 3.** Row of a sample SHOW_POPUP action after clicking the checkbox

## Defining an event for the Next button When defining an action for clicking the Next button, remember to also provide an action that will be executed when the condition specified for the action is not met, because otherwise the user would not be able to move to the next page if the event condition is not satisfied. It is enough to add an action with the opposite condition for the FORWARD\_PAGE action.

**Figure 4.** Example of an action opening a popup for the clicked Next button on Page1

**Figure 5.** Example of an action for the opposite condition allowing you to proceed normally from Page1

{% hint style="info" %} Demo request: demoPopup {% endhint %} ## Defining actions for the Statements component For [Statements - Statements](https://github.com/Consdata/eximee-docs/blob/main/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/oswiadczenia-statements/README.md) in a specific statement you need in **actionBindings** add an event (Event) equal to **EDIT**. A statement that has such an event defined will display a special data editing option, and clicking it will show a popup.

**Figure 6.** Example of a statement with a defined action

{% hint style="info" %} Demo request: demoStatementsPopup {% endhint %} ## Defined events for the Slider [Slider](https://github.com/Consdata/eximee-docs/blob/main/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/slider.md) is able to handle an event defined in the validator (it must send the EMIT\_EVENT action in the error message). When adding an action, select from the action drop-down list an item from the list of allowed events, which is in turn defined in the validator implementation. ## Defined events for contextual help of the Text Field and Value Selection from List Field For components: [Text Field - TextField](https://github.com/Consdata/eximee-docs/blob/main/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/pole-tekstowe-textfield.md) and [Value selection field from list - Combobox](https://github.com/Consdata/eximee-docs/blob/main/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/pole-wyboru-wartosci-z-listy-combobox.md) containing a label, you can define an action to open a popup when clicking the contextual help button. Before defining the action, add contextual help (tooltip) to the component.

**Figure 7.** Example of an action defined for the tooltip of the Text Field component

{% hint style="info" %} Demo requests: demoTextField, demoCombobox, demoPopup {% endhint %} ## PageService as an action If we define a PageService on the request, we can choose it in the section **Properties** - after selecting it, it is possible to choose the CALL action. ## Redirect action to a defined returnUrl It is possible to attach an action (e.g. on clicking the Trigger) that will perform a redirect to ***returnUrl*** (REDIRECT\_TO\_RETURN\_URL), whose value is taken from a session variable with that name (the session variable ***returnUrl*** must be exposed). ## Redirect action to a defined URL It is possible to attach an action (e.g. on clicking the Trigger) that will perform a redirect to the URL provided by the user, whose value is set when defining the action - REDIRECT. The action will be performed even if a validator highlights some data as invalid. ## Parking action after entering a specific page It is possible to define a parking action after entering a specific page: PARK\_FORM\_WITH\_PROVIDED\_HASH. Then you need to define the action for the page component (e.g. with the ON\_PAGE\_ENTER event). For the parking mechanism to work, remember to set the value of the session variable ***hashForUnparking***, which is needed to unpark the request. ## Action to enter a new request populated with a data model from a given process It is possible to define an action for entering a new request that will initially be populated with a data model from a specific process. Then you need to define the START\_FORM\_BASED\_ON\_PROCESS action on the Trigger component. As part of this action, you need to configure the request name (**formName)** and **processInstanceId,** from which the model will be retrieved. Remember that **processInstanceId** must be a reference to a session variable, because only a **session variable is supported.**\ Currently, action configuration is not possible from the Designer; you need to use the "Source" tab. Example configuration below. ``` GesTrigger1 ``` ## Actions - starting the Application {% hint style="info" %} The availability of the functionality depends on the license and may not be available in all deployments. {% endhint %} The START\_APPLICATION action is responsible for starting the process set as the starting point.

**Figure 8.** *Row for defining the START_APPLICATION action*

The START\_APPLICATION action takes the following parameters: | | | | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | Application name | Indication of the process to be started. | | Redirect to the next process step | JAVASCRIPT condition. Indicates whether automatic redirection to the next user task should occur. Default value: false | ## Sample components sending events | Component (action source) | Possible event | Description | | ----------------------------------------------------- | ----------------- | ---------------------------------------------------------------------------- | | Page (screen) | NEXT | Action when clicking the Next button on the request page | |

| ON\_EXIT | Action on leaving the page | |

| ON\_PAGE\_ENTER | Action on entering a specific page | |

| HIDDEN |

| CHECK | Action when checking the checkbox | |

| UNCHECK | Action when unchecking the checkbox | | RadioGroup | VALUE\_CHANGED | Action when changing the component value | | TileGroup | VALUE\_CHANGED | Action when changing the component value | | TileGroup | TILE\_CLICKED | Action when clicking a single tile in a tile group | ## Sample components receiving events | Component handling actions | Type of form action | Description | | ----------------------------------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | Checkbox | CHECK | Checkbox checked | |

| UNCHECK | Checkbox unchecked | |

| BACKWARD\_PAGE | Go to the previous page (same as clicking the **Back**, **Back** button, etc.) | |

| REDIRECT\_TO\_RETURN\_URL | Redirect to the URL defined in the session variable ***returnUrl*** | |

| REDIRECT | Redirect to the URL defined in the field available after selecting the REDIRECT action type | |

| CLOSE\_POPUP | Closing the popup component | |

| SAVE\_POPUP | Saving the popup component | | Attachments (Uploadfile) | CLEAR\_UPLOAD\_FILE | Clearing the added attachment (works for the ON\_PAGE\_ENTER action) | | Form | PARK\_FORM\_WITH\_PROVIDED\_HASH | Parking the request | | Trigger | START\_APPLICATION | Starting the process (the process set as the starting point) of the specified **applicationName** application | | Trigger | START\_FORM\_BASED\_ON\_PROCESS | Action to enter a new request (formName parameter) populated with a model from the given process instance (processInstanceId parameter). | {% hint style="info" %} Demo requests: demoAkcje, demoTooltipy {% endhint %}