Actions

Actions Section

Section Actions allows adding actions to the form for selected components that initiate events.

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

Illustration 1. Section with defined actions

Add action

After clicking the Add action an empty row is added at the top of the section above the other actions (if any were already on the form), in which we first select the action source in the field Select action source. The list will contain only those form components for which an action can be defined.

Illustration 2. Row for defining a new action

Illustration 2. Row for defining a new action

Illustration 3. Row of an example 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 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 inverse condition for the FORWARD_PAGE action.

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

Illustration 5. Example of an action for the inverse condition allowing standard navigation forward from Page1

Demo form: demoPopup

Defining actions for the Statements component

For Statements - Statements in a specific statement you should in actionBindings add an event equal to EDIT. A statement that has such an event defined will display a special data edit option whose click will show a popup.

Illustration 6. Example of a statement with a defined action

Demo form: demoStatementsPopup

Defined events for the Slider

Slider is able to handle an event defined in the validator (it must send an EMIT_EVENT action in the error message). When adding an action, in the action dropdown select the item from the list of allowed events, which in turn is defined in the validator implementation.

Defined events for the contextual help of Text Field and Combobox

For components: Text field - TextField and Value selection 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 a contextual help (tooltip) to the component.

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

Demo forms: demoTextField, demoCombobox, demoPopup

PageService as an action

If we define a PageService on the form, we can select it in the 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. to a Trigger click) that will initiate 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).

Action redirecting to a defined URL

It is possible to attach an action (e.g. to a Trigger click) that will initiate a redirect to a user-provided URL, whose value is determined at the time of defining the action - REDIRECT.

The action will execute even if some validator highlights some data as invalid.

Park action when entering a specific page

It is possible to define a park action when entering a specific page: PARK_FORM_WITH_PROVIDED_HASH. You must then 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 session variable value hashForUnparking, which is required to unpark the form.

Action to enter a new form seeded with the data model from a given process

It is possible to define an action to enter a new form that will be initially seeded with the data model from a specific process. You should then specify the START_FORM_BASED_ON_PROCESS action on the Trigger component. Within this action you must configure 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.

<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="sessionVariableName"/>
  </formActionParameters>
</formAction>

Actions - starting Applications

The availability of features 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 start point.

Illustration 8. Row defining the START_APPLICATION action

The START_APPLICATION action accepts the following parameters:

Application name	Reference to the process that should be started.
Redirect to the next process step	JAVASCRIPT condition. Indicates whether to automatically redirect to the next user task. Default value: false

Example components sending events

Component (Action source)	Possible event	Description
Page	NEXT	Action for clicking the next button on the form page
	ON_EXIT	Action on exiting the page
	ON_PAGE_ENTER	Action on entering a specific page
	SAVE_DRAFT	Action for clicking the save draft button on the form
Popup	SAVE	Action for clicking the save button on the Popup component
	HIDDEN
Statements	EDIT	Action for clicking the edit button on the statements component
Statements supplied by a service (FedStatements)	EXPAND_STATEMENT	Action for clicking the expander on the supplied statements component
Text field (GesTextField)	TOOLTIP_CLICKED	Action for clicking the component tooltip
Value selection field from list (GesCombobox)	TOOLTIP_CLICKED	Action for clicking the component tooltip
	VALUE_CHANGED	Action on combobox value change
Trigger	CLICK	Action on component click
Checkbox	CLICK_MORE_INFO	Action on clicking the more info link of the checkbox component
	CHECK	Action on checking the checkbox
	UNCHECK	Action on unchecking the checkbox
RadioGroup	VALUE_CHANGED	Action on component value change
ComboBox	VALUE_CHANGED	Action on component value change
ComboBox	TILE_CLICKED	Action on clicking an individual 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
	TOGGLE	Changing the checkbox value to the opposite
Statements supplied by a service (FedStatements)	CHECK_FED_STATEMENT	Marks the required statement from the list of statements
Page	FORWARD_PAGE	Going to the next page (equivalent to clicking the Next, Submit the form etc.)
	BACKWARD_PAGE	Going to the previous page (equivalent to clicking the Back, Return etc.)
	REDIRECT_TO_RETURN_URL	Redirect to the URL defined in a session variable returnUrl
	REDIRECT	Redirect to the URL provided in the field available after selecting the REDIRECT action type
	SAVE_DRAFT	Temporary save of the form
PageService	CALL	Service invocation
Popup	SHOW_POPUP	Open the popup component defined in the field Component handling the action
	CLOSE_POPUP	Close the popup component
	SAVE_POPUP	Save the popup component
Attachments (Uploadfile)	CLEAR_UPLOAD_FILE	Clearing the added attachment (works for 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) specified in the applicationName application
Trigger	START_FORM_BASED_ON_PROCESS	Action to enter a new form (parameter formName) seeded with the model from the given process instance (parameter processInstanceId).

Demo forms: demoActions, demoTooltips