Breadcrumbs

Button

The Element Button

Element Icon in Sidebar

icon_button.png

Form Field

button.png

Function

Buttons are necessary to leave a form and access the next process step. They are also used to invoke other models.

Default

A newly created button does not contain any functionality. Buttons must be configured appropriately.

Example

The button Close triggers saving of data, the input is also validated and after that the execution is stopped (the open form is closed, the process stops):

close_button.png

The following options were activated for this button:

config_close_button.png

Configuration Options

The form element may be edited via the Edit Sidebar.

button_name.png

Name

Field name shown in the form.

model_id.png

ID

The read-only field contains the model ID of the element. Designers can use the ID for example in the search to link the element in other models.

form_description.png

Description

When a user hovers over a form element during execution, the content of the commentary field is shown as a quick info:

grafik-20241022-074156.png
form_hashtags.png

Hashtags

Possibility to insert your own key terms . The leading hashtag sign # (hash) will be inserted automatically. Use the spacebar to insert multiple hashtags:

hashtag_example.png?version=2&modificationDate=1550039322000&cacheVersion=1&api=v2

One hashtag may be issued for multiple elements:

grafik-20241022-074334.png
form_css_classes.png

Additional CSS Classes

Enables a field-acurate layout customization.

form_read_only.png

Read Only

This button can not be clicked.

form_focus_on_element.png

Focus on Element

The button can be executed directly in the browser by pressing ENTER.

highlight_as_default.png


Highlight as Default

The button will be colored to distinguish it from other buttons. This indicates to the user that this button is the default button in the current form.


go_to_next_step.png

Go to Next Step

A click on a button with this configuration transfers the user to the next process step or the next form (if available).


go_to_previous_step.png

Go to Previous Step

This option allows you to jump back to the previous process step.

Use this button to configure a Back button.
Attention:In this case, Back relates to the process history, not to the browser history. The jump will therefore always return you to the previous process step containing a form.


stop_execution.png

Stop Execution

Aborts the execution of the entire process.

Use this option to close forms (see page Configuring Buttons). If you wish to save the entered data prior to closing the form, then also activate the additional button option Save Instance.

Attention: All following process steps will no longer be executed, the process will stop at this position.

save_instance.png


  

Save Instance

Activating this option results in saving all instance data in the database. Only the data from form elements with activated option Save Value in Instance is saved.
If Save Instance was not chosen, then none of the form's data is saved permanently - even if Save Value in Instance was previously selected in the form elements.

An authorization check will always be performed while saving.

to_overview.png

To Overview

Enables a jump to the Process App Overview. This option is a presetting of the standard button Go to Overview which exists in each new form.

 

open_new_instance.png

Open New Instance

Use this option to enable the user to create a new instance. A click on the button will open the corresponding Process App - Create, where you can immediately create a new instance. This option is used in the New Button of each Overview Model to enable users to create new instances directly out of the search.

Save the reference model you wish to open in the field Run Model After Click. Whether the new instance is saved or not depends on the user and his decision to click the Save Button in the reference model.

delete_instance.png


Delete Instance

If this option was chosen for a button, then clicking it will result in marking the instance as deleted. The dataset can no longer be retrieved via the search function. It is however still archived and not deleted from the database.

always_active.png

Always active

Choosing this option will enable the user to click the button even if the rest of the form is write-protected, for example because the user role has read-only authorization.

validate_fields.png

 

Validate Fields

The validation defined in the form element is triggered by the click on this button. It is checked if all defined mandatory fields were completed and if the used Regular Expressions are valid.

Empty:

function_after_click.png

Containing Content:

function_after_click_full.png

Function: After Click

Clicking on the gear wheel opens an editor. Code saved in this function will be executed right after clicking the button - even before the start of a possibly added model in field Run Model After Click.

The color of the gear wheel shows, whether an element is empty (light grey) or if content has already been saved (dark grey).

form_run_model_after_click.png

Run Model After Click

Option to insert a different EPC model from a current BPaaS project.

Clicking the button triggers execution of the model saved here.

Empty:

function_after_model_execution.png

Containing Content:

function_after_model_execution_full.png

Function: After Model Execution

A click on the gear wheel opens an editor. The coding saved here is executed last, after execution of a possibly added entry in the field Run Model After Click.

The color of the gear wheel shows, whether an element is empty (light grey) or if content has already been saved (dark grey).

form_field_name_in_container.png

Field Name in Container

Defines the name under which the form element will be saved in the data container. If the Field Name in Container remains empty, then the field identifier (name) will be used. If two form elements share the same Field Name in Container, then both will access the same value.

The Field Name in Container is a technical identifier. It is often used for extended coding. Therefore the Field Name in Container should not contain any spaces, special characters or umlaut. For further information please visit page The Container Principle.

Related Pages: