Actions

Actions section

A section Actions allows adding actions to the application for selected components that trigger events.

To define an action in the application, first add in the form the component for which you want to define the action (e.g. Trigger) and the component to which the action applies (e.g. Popup).

Figure 1. Section with defined actions

Adding an action

After clicking the button Add an action at the top of the section above the remaining actions (if there were already any in the application), an empty row is added, in which we first select 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 2. Row for defining a new action

Figure 3. Example SHOW_POPUP action row 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 execute when the condition specified for the action is not met, otherwise the user would not be able to go 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 that opens 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

Demo application: demoPopup

Defining an action for the Statements component

For Statements - Statements 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; clicking it will show a popup.

Figure 6. Example of a statement with a defined action

Demo application: demoStatementsPopup

Defined events for the Slider

Slider 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 in turn is defined in the validator implementation.

Defined events for the contextual help of the Text Field and the Value Selection from List Field

For components: Text Field - TextField and Select field from list - Combobox 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

Demo applications: demoTextField, demoCombobox, demoPopup

PageService as an action

If we define a PageService in the application, we can select it in the section Properties - after selecting it, it is possible to choose the CALL action.

Redirect action to the defined returnUrl

It is possible to attach an action (e.g. on a Trigger click) that will start 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).

Redirect action to the defined URL

It is possible to attach an action (e.g. on a Trigger click) that will start a redirect to the URL provided by the user, whose value is determined when defining the action - REDIRECT.

The action will execute even if some 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 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 for entering a new application with a data model populated from the specified process

It is possible to define an action for entering a new application that will initially be populated with the data model from a specific process. Then specify the START_FORM_BASED_ON_PROCESS action on the Trigger component. As part of the action, configure the application 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; you need to use the "Source" tab. Below is an example configuration.

<formAction id="5392a77a-5b2b-4664-b918-b2b65004736f" handler="START_FORM_BASED_ON_PROCESS" event="CLICK">
  <formActionSources>
    <formActionSource>GesTrigger1</formActionSource>
  </formActionSources>
  <formActionParameters>
    <formActionParameter name="formName" value="esg_test_preview_wniosek"/>
    <formActionParameter name="processInstanceId" value="nazwaZmiennejSesyjnej"/>
  </formActionParameters>
</formAction>

Actions - starting Applications

Availability of functionality depends on the license and may not be available in all deployments.

The START_APPLICATION action is responsible for starting the process set as the starting point.

Figure 8. Row 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. Indicates whether automatic redirect to the next user task should occur. Default value: false

Action for 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. Row 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 that task.

Action for approving 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 defining the COMPLETE_TASK_AND_RESUME action

Redirect action to a new application

The LOAD_NEW_FORM action enables redirecting to a new application. As part of the action, you need to define the application name (formName) to which you should redirect. You can also add additional parameters that will be passed to the new application (currently this is not possible from the Designer; for this purpose, 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 application page
	ON_EXIT	Action on page exit
	ON_PAGE_ENTER	Action on entering a specific page
	SAVE_DRAFT	Action on clicking the temporary save button of the application
Popup	SAVE	Action on clicking the save button on the Popup component
	HIDDEN
Statements	EDIT	Action on clicking the edit button on the statements component
Statements populated from service (FedStatements)	EXPAND_STATEMENT	Action on clicking the expander on the populated statements component
Text field (GesTextField)	TOOLTIP_CLICKED	Action on clicking the component tooltip
Value selection from list field (GesCombobox)	TOOLTIP_CLICKED	Action on clicking the component tooltip
	VALUE_CHANGED	Action on combobox value change
Trigger	CLICK	Action on clicking the component
Checkbox	CLICK_MORE_INFO	Action on clicking the checkbox component's more info link
	CHECK	Action on checking the checkbox
	UNCHECK	Action on unchecking the checkbox
RadioGroup	VALUE_CHANGED	Action on component value change
TileGroup	VALUE_CHANGED	Action on component value change
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	Checking the checkbox
	UNCHECK	Unchecking the checkbox
	TOGGLE	Changing the checkbox value to the opposite
Statements populated from service (FedStatements)	CHECK_FED_STATEMENT	Selects the required statement from the list of statements
Page (page)	FORWARD_PAGE	Go to the next page (equivalent to clicking the button Next, Submit application etc.)
	BACKWARD_PAGE	Go to the previous page (equivalent to clicking the button 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
	SAVE_DRAFT	Temporary save of the application
PageService	CALL	Service call
Popup	SHOW_POPUP	Opening a popup component defined in the field Component handling the action
	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 parameter applicationName application
Trigger	START_FORM_BASED_ON_PROCESS	Action for entering a new application (formName parameter) populated with a model from the specified process instance (processInstanceId parameter).

Demo applications: demoAkcje, demoTooltipy