# Actions ## Actions section Section **Actions** allows actions for selected event-triggering components to be added to the application. To define an action on the application, first add to 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** button at the top of the section above the other actions (if there were any on the application), an empty row is added, in which we first choose the action source in the field **Select action source**. The list will contain only those application components for which an action can be defined.

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

**Figure 3.** Example row of the 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 when 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 normal progression from Page1

{% hint style="info" %} Demo application: 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 to add an event (Event) equal to **actionBindings** in **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 application: 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, choose in the action dropdown the 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 from List Field - 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 applications: demoTextField, demoCombobox, demoPopup {% endhint %} ## PageService as an action If we define PageService on the application, we can choose it in the section **Properties** - after selecting it, it is possible to choose the CALL action. ## Action to redirect to a defined returnUrl It is possible to attach an action (e.g. on Trigger click) that will 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). ## Action to redirect to a defined URL It is possible to attach an action (e.g. on Trigger click) that will redirect to the URL provided by the user, whose value is determined when defining the action - REDIRECT. The action will be executed even if a validator highlights some data as incorrect. ## Parking action upon entering a specific page It is possible to define a parking action upon entering a specific page: PARK\_FORM\_WITH\_PROVIDED\_HASH. In that case, you need to specify an 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 application. ## Action to enter a new application with the data model populated from a given process It is possible to define an action for entering a new application, which at startup will be populated with the data model from a specific process. In that case, specify the START\_FORM\_BASED\_ON\_PROCESS action on the Trigger component. As part of this action, configure the application 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; use the "Source" tab. Below is an example configuration. ``` GesTrigger1 ``` ## Actions - application startup {% hint style="info" %} 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 step of the process | JAVASCRIPT condition. Indicates whether automatic redirection to the next user task should occur. Default value: false | ## Action to start a process instance The START\_PROCESS\_AND\_RESUME action is responsible for starting a process instance and redirecting to a user task. As part of the action, you need to define the name of the process to be started.

**Figure 9.** *Row for defining the START_PROCESS_AND_RESUME action*

The START\_PROCESS\_AND\_RESUME action takes the following parameters: | | | | -------------------------- | --------------------------------------------- | | Process definition key | Name of the process definition to be started. | | Case number (Business key) | Business case identifier | After the process is started, the process variable is set in the instance `sys_process_start_user_id`, containing the identifier of the user starting the process. This variable can be used, for example, in BPMN configuration (candidate users) for a user task, so that the user creating the process has access to this task. ## Action to approve a user task in the process The COMPLETE\_TASK\_AND\_RESUME action is responsible for approving the user task and redirecting to the next task.

**Figure 10.** *Row for defining the COMPLETE_TASK_AND_RESUME action*

## Sample components sending events | Component (Action source) | Possible event | Description | | ------------------------------------------------- | ----------------- | --------------------------------------------------------------------- | | Page (page) | NEXT | Action on clicking the next button on the application page | |

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

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

| HIDDEN |

| CHECK | Action on checking the checkbox | |

| UNCHECK | Action on unchecking the checkbox | | RadioGroup | VALUE\_CHANGED | Action on changing the component value | | TileGroup | VALUE\_CHANGED | Action on changing the component value | | TileGroup | TILE\_CLICKED | Action on clicking a single tile in a tile group | ## Sample components receiving events | Component handling actions | Form action type | Description | | ------------------------------------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | Checkbox | CHECK | Checking the checkbox | |

| UNCHECK | Unchecking the checkbox | |

| BACKWARD\_PAGE | Move to the previous page (equivalent to clicking the **Back**, **Return** 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 application | | Trigger | START\_APPLICATION | Starting the process (the process set as the starting point) specified in the **applicationName** application | | Trigger | START\_FORM\_BASED\_ON\_PROCESS | Action to enter a new application (formName parameter) populated with the model from the specified process instance (processInstanceId parameter). | {% hint style="info" %} Demo applications: demoAkcje, demoTooltipy {% endhint %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.eximee.com/documentation/documentation-en/budowanie-aplikacji/logika-biznesowa/przeplywy/akcje.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.