> 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 Section **Actions** allows adding actions to the form for selected components that initiate events. To define an action on a form, first add to the form the component for which you 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 the action applies to (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 **Add action** button at the top of the section above the other actions (if there were any already on the form), an empty row is added, in which we first choose the action source in the field **Choose action source**. The list will contain only those form components for which an action can be defined.

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

**Figure 3.** Example row of a SHOW_POPUP action after clicking a 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 run when the condition given 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 to open a popup 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/tree/main/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/oswiadczenia-statements/README.md) in a specific statement, you need to 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 display a popup.

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

{% hint style="info" %} Demo form: demoStatementsPopup {% endhint %} ## Defined events for Slider [Slider](https://github.com/Consdata/eximee-docs/tree/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 the item from the list of allowed events, which in turn is defined in the validator implementation. ## Defined events for contextual help for the Text Field and the Value Selection Field from List For components: [Text Field - TextField](https://github.com/Consdata/eximee-docs/tree/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/tree/main/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/pole-wyboru-wartosci-z-listy-combobox.md) that contain a label, you can define an action to open a popup when the context help button is clicked. 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 a PageService on the form, we can select it in the section **Properties** - after selecting it, the CALL action can be chosen. ## Action to redirect to a defined returnUrl It is possible to attach an action (e.g. on Trigger click) that will initiate redirection to ***returnUrl*** (REDIRECT\_TO\_RETURN\_URL), whose value is taken from a session variable of 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 initiate redirection to the user-provided URL, whose value is determined when the action is defined - REDIRECT. The action will be performed even if some validator highlights some data as invalid. ### Eximee internal redirection {% hint style="info" %} Availability of the functionality depends on the license and may not be available in all deployments. {% endhint %} If the address leads to another Eximee form, click in the action **Show details** and in the row **Redirect type** check the box **Eximee internal redirection**. The platform will then add parameters configured for the environment to the redirect, for example the source of entry or channel. Parameters present in the address are not overwritten, and parameters without a value are not included. An action without the box checked redirects to the address unchanged. The list of parameters, the rules for including them, and an example are described on the page [Eximee internal redirections](/documentation/documentation-en/eksploatacja-aplikacji/webforms/konfiguracja/przekierowania-wewnetrzne.md). ## Action to park after entering a specific page It is possible to define a parking action after entering a specific page: PARK\_FORM\_WITH\_PROVIDED\_HASH. In that case, 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 form. ## Action to enter a new form populated with a data model from the specified process It is possible to define an action to enter a new form, which will initially be populated with a data model from a specific process. In that case, define the START\_FORM\_BASED\_ON\_PROCESS action on the Trigger component. As part of this action, define the form name (**formName)** and **processInstanceId,** from which the model will be retrieved. Remember that **processInstanceId** must point 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 start point.

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

The START\_APPLICATION action takes the following parameters: | | | | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | Application name | Specification of the process to be started. | | Redirect to the next step of the process | JAVASCRIPT condition. Specifies 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 `sys_process_start_user_id`, containing the identifier of the user starting the process. This variable can be used, for example, in the BPMN configuration (candidate users) for a user task, so that the user creating the process has access to that task. ## Action to complete a user task in the process The COMPLETE\_TASK\_AND\_RESUME action is responsible for completing the user task and redirecting to the next task.

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

## Action to redirect to a new form The LOAD\_NEW\_FORM action enables redirection to a new form. As part of the action, define the form name (**formName**) to which you want to redirect. You can also add additional parameters that will be passed to the new form (currently this is not possible from the Designer, use the "Source" tab for this purpose 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 page exit | |

| 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 | ## Example components receiving events | Component handling actions | Form action type | Description | | ----------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | Checkbox | CHECK | Checkbox checked | |

| UNCHECK | Checkbox unchecked | |

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

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

| REDIRECT | Redirection 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 | Form parking | | Trigger | START\_APPLICATION | Starting the process (the process set as the start point) of the application specified in the applicationName parameter **applicationName** application | | Trigger | START\_FORM\_BASED\_ON\_PROCESS | Action to enter a new form (formName parameter) populated with the model from the specified 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` 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 what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.