Form Buttons

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Process wizard > Define Forms >

Form Buttons

Overview

By default Bizagi displays two buttons on the footer of each activity; this buttons are Save and Next.

 

Form buttons is a feature that allow users to customize these default buttons and/or add new ones.

These buttons can execute business rules, validate data, save the form and advance the activities.

 

You can define their behavior according to the project's needs. The appearance of these buttons (text, colors) can be customized in order to provide friendly user interfaces in any device.

 

You can customize the Form buttons only in Activity Forms.

 

CustomButtons14

 

Properties available

The following are the available properties for each Form button:

 

 

PROPERTY

DESCRIPTION

Button caption

The text entered in the Button caption will appear inside the button

Button execution

Defines the behavior associated to the button:

 

Rule: scripting expression associated with the button. When the end user clicks the button the expression will be executed.

 

Interface: interface associated with the button. When the end user clicks the button the interface will be executed.

 

None: Executes no behavior.

Actions

Defines the actions associated to the button:

 

None: Executes no action.

 

Save Data:  Saves the information entered in the form.

The rules defined On Save are executed.

This action does not validate the data entered in the form.

 

Validate: Verifies that information entered is correct (required controls, minimum and maximum values and Actions & Validations).

This action does not execute table's validations.

This action does not save the form.

 

Next: Moves the case to the next activity. This action saves and validates the information before proceeding with the case.

oRules defined On Exit are executed.

oRules On save are not executed.

oThis action validates required controls, minimum, maximum , table's validations and Actions & Validations.

Visible

Sets the visibility of the button. This can also be determined by an expression.

Format

Define the font size, font color and background color for the button.

 

You can combine between button execution and actions as desired.

For instance, you can execute an expression and then execute Next. Then, with a single click of the button an expression will be executed and then the case will move forward.

If you only require an action, leave the Button execution None.

If you only require a button execution, leave the Actions None.

 

CustomButtons5

 

How to create a Form button

1. Go to the form where you need to create the Form button and enable the Form buttons option on the ribbon.

 

CustomButtons7

2. A new panel will display at the bottom of the form.

 

CustomButtons8

3. Click the Add icon to include a new button.

A new button will appear to the right.

 

CustomButtons9

4. Click the new button to display its properties.

 

CustomButtons10

5. Define the required properties according to your needs.

 

 

How to edit a Custom button

To edit a custom button:

1. Go to the form where the button to be edited is found. Enable the Form buttons option on the ribbon.

 

CustomButtons7

2. A new panel will display at the bottom of the form. Click the button to be edited in order to display its properties.

 

CustomButtons11

3. Change the button properties as you need.

 

How to remove a Custom button

1. Go to the form where the button to be deleted is found. Enable the Form buttons option on the ribbon.

 

CustomButtons7

2. A new panel will display at the bottom of the form. Click the button to be deleted.

 

CustomButtons12

3. Click the Delete icon that will appear on the upper right corner of the button to remove it.

 

CustomButtons13

 

Example

In a Vacation Leave Request process, the boss of the person requesting vacations has to approve the request. The boss should be able to approve or reject the request just by clicking a button.

To meet this requirement Custom Buttons are used. Follow the next steps to create them:

1. Go to the form of the Approve Vacations activity and enable the Form buttons option on the ribbon.

 

CustomButtons2

2. In the panel displayed at the bottom of the form click the Add icon to include a new button.

 

CustomButtons3

 

3. Click the new button. In the button properties define the following:

Button caption: "Approve"- This button will be used to approve the request.

Button execution: Rule - Once clicked, the button will execute a rule to identify the request as approved.

Action: Next - Once clicked the button, the case will move to the next activity.

 

CustomButtons4

4. Now define the rule associated to the button execution by clicking the expression icon.

 

CustomButtons5

 

5. To identify if the request is approved or rejected, the process uses a Boolean attribute called Approved. If this attribute is in TRUE, the request is approved, otherwise is rejected.

This button will approve the request. Create an assignment element to set the Approved attribute to TRUE.

 

CustomButtons16

6. Repeat the steps 2-5 to create a new button called Reject. In the expression assign the value FALSE to the attribute.

 

CustomButtons17

7. Finally remove the Save and Next buttons. Select the button and then click the delete icon.

 

CustomButtons6

In the Work Portal, the new buttons will display and the configured actions will be executed clicking them.

 

CustomButtons15