> For the complete documentation index, see [llms.txt](https://docs.eximee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.eximee.com/documentation/documentation-en/budowanie-aplikacji/logika-biznesowa/przeplywy/akcje.md). # Actions ## Actions section The section **Actions** allows adding actions to the form for selected components that trigger events. To define an action on the form, first add to the form the component for which we want to define the action (e.g. [Trigger](/documentation/documentation-en/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/6-interakcje-i-akcje/trigger.md)) and the component to which the action applies (e.g. [Popup](/documentation/documentation-en/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/6-interakcje-i-akcje/popup.md)).

**Figure 1.** Section with defined actions

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

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

**Figure 3.** Example row of a SHOW_POPUP action after clicking the checkbox

## Defining an event for the Next button When defining an action on 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 go to the next page when the event condition is not met. It is enough to add an action with the opposite condition for the FORWARD\_PAGE action.

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

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

{% hint style="info" %} Demo form: 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, in **actionBindings** add an event equal to **EDIT**. A statement that has such an event defined will display a special data editing option, and clicking it will display a popup.

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

{% hint style="info" %} Demo form: 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 its error message). When adding an action, select from the action dropdown the item from the list of allowed events, which in turn is defined in the validator implementation. ## Defined events for the 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 forms: demoTextField, demoCombobox, demoPopup {% endhint %} ## PageService as an action If we define PageService on the form, we can choose it in the section **Properties** - after selecting it, it is possible to choose the CALL action. ## Action redirecting to a defined returnUrl It is possible to attach an action (e.g. on clicking the Trigger) that will trigger a redirect to ***returnUrl*** (REDIRECT\_TO\_RETURN\_URL), whose value is taken from the session variable with that name (the session variable ***returnUrl*** must be exposed). ## Action redirecting to a defined URL It is possible to attach an action (e.g. on clicking the Trigger) that will trigger a redirect to the URL specified by the user, whose value is determined at the time the action is defined - REDIRECT. The action will be executed even if a validator highlights some data as invalid. ## 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. Then you need to specify 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 form. ## Action of entering a new form powered with a data model from the given process It is possible to define an action for entering a new form, which on start will be populated with a data model from a specific process. Then you need to specify the START\_FORM\_BASED\_ON\_PROCESS action on the Trigger component. As part of this action, configure the form name (**formName)** and **processInstanceId,** from which the model will be retrieved. Remember that **processInstanceId** must be a reference to a session variable, because only **the session variable is supported.**\ Currently, action configuration is not possible from the Designer level; use the "Source" tab. Example configuration below. ``` GesTrigger1 ``` ## Actions - starting the Application {% hint style="info" %} Availability of 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 start point.

**Figure 8.** *START_APPLICATION action definition row*

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. Specifies whether an automatic redirect to the next user task should occur. Default value: false | ## Action of starting 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.

**Illustration 9.** *START_PROCESS_AND_RESUME action definition row*

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, a 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 e.g. in BPMN configuration (candidate users) for a user task, so that the user creating the process has access to that task. ## Action of approving 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.** *COMPLETE_TASK_AND_RESUME action definition row*

## Action redirecting to a new form The LOAD\_NEW\_FORM action allows redirecting to a new form. As part of the action, define the name of the form (**formName**) to which to redirect. You can also add additional parameters that will be passed to the new form (currently this is not possible from the Designer level; to do this, use the "Source" tab and add another "formActionParameter" in the action). ## Example components sending events | Component (action source) | Possible event | Description | | ----------------------------------------------- | ----------------- | ------------------------------------------------------------------ | | Page (page) | NEXT | Action on clicking the next button on the form page | |

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

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

| HIDDEN |

| CHECK | Action on checking the checkbox | |

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

| UNCHECK | Unchecking the checkbox | |

| BACKWARD\_PAGE | Go to the previous page (same as clicking the button **Undo**, **Back** 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 form | | Trigger | START\_APPLICATION | Starting the process (the process set as the start point) of the application indicated in **applicationName** application | | Trigger | START\_FORM\_BASED\_ON\_PROCESS | Action of entering a new form (formName parameter) populated with a model from the given process instance (processInstanceId parameter). | {% hint style="info" %} Demo forms: demoAkcje, demoTooltipy {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://docs.eximee.com/documentation/documentation-en/budowanie-aplikacji/logika-biznesowa/przeplywy/akcje.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.