Form link

<< Click to Display Table of Contents >>

Navigation:  Low-code Process Automation > Studio Cloud - Authoring environment > Bizagi Studio > Process wizard > Define Forms > Form Controls > Control list >

Form link

Use

The Form link control displays as a link in the Work Portal. When users click the link, a defined form will open.

This control is very useful if you want to have information available for end users, in an informative way, but you don't want to include this information as part of the activities' form.

 

Considerations

This control displays a link that opens a form created in Bizagi, thus all controls available in Bizagi can be used. If you wish to create links to URL addresses, please refer to Link.

Forms associated with the Form Link control should always be reusable; that is, they should always be entity forms.

If the form related contains mandatory controls, Bizagi will not validate them as the end user clicks Next on the parent form.

 

Related to attribute types

This control does not reference any attributes. It is directly related to a specific form.

 

Properties

Every control has a set of properties that allow to customize its behavior in the Work Portal. However, some properties are exclusive to a specific control. The following are properties exclusive to the Form link control:

 

Basic tab

 

PROPERTY

DESCRIPTION

Data source

It determines the Context of the form opened. The form related must be available through XPath navigation, for Bizagi to be able to present the information within it.

This property is not required, but we strongly recommend you set a Data source to avoid errors in the Work Portal.

Open maximized

When enabled, the form is opened in full-screen mode.

Add Form

It defines the form associated with the link when users click it. You can create a new form or select an existing one. The available forms displayed to select depend on the Data source selected.

 

Advanced tab

 

PROPERTY

DESCRIPTION

Use as button

It defines if the control is presented in the Work Portal as a button. By default, this property is disabled. When enabled, the control will display as a button, otherwise it will display as a link.

Data Rule on Entry

It defines the execution of a rule to perform calculations and validations before the form is opened.

Data Rule on Exit

It defines the execution of a rule to perform calculations and validations when the form is closed.

 

Form link Example

A Sales Opportunity Management Process handles all the necessary activities to convert business opportunities into closed deals. In order to show only the relevant information to the sales agents, the detailed information of the Potential Customer is displayed in an additional form.

 

To access this contact form, it is necessary to include a form link control in the Process activities forms.

 

1. Open the Forms Designer to drag and drop a Form link control.

 

FormsComponents61

 

2. Go to the Basic tab in the control's Properties, select the Data source and expand the Add Form drop-down list.

 

FormsComponents62

 

3. Then, a new form will be created. If your form has been created previously, select it from the list.

Click on the New Form option.

 

FormsComponents63

 

4. In the new form, include all the necessary information from the data model.

Open the Properties option of the form (located on the Ribbon) and give it a display name.

Save the child form and close the window to return to the parent Form.

 

FormsComponents64

 

5. Return to the main form and assign the form link a display name.

Save the form.

 

FormsComponents65

 

6. Go to the Work Portal to test the control.

Click on the form link. Note the child form previously created will display in a new window.

 

FormsComponents66

 

Column Form link Example

In the same process as in the example above, the Customers table only displays the first name and last name columns. Each contact's information can be viewed or edited by the sales agent. The additional information will be displayed in another Form.

 

To view this customer form, it is necessary to include a Column Form link control on the Contacts table.

 

1. Open the Forms Designer, edit the Contacts table columns and drag and drop a Form link control.

 

FormsComponents225

 

2. Go to the Basic tab in the control's properties. We will create a new form. If your form has been created previously, select it from the list.

Expand the Add Form drop-down list and click the New Form option.

 

FormsComponents227

 

3. In the new form include all the necessary information from the data model.

Open the Properties option of the form (located on the Ribbon) and give it a display name.

Save the child form and close the window to return to the parent Form.

 

FormsComponents228

 

4. Set the Display name for the control, and it will use this name for both the column header and the link label.

Save the form.

When the control is a table column, the new form will take the context of the collection, so it is not necessary to set any value for this property.

 

FormsComponents226

 

note_pin

Keep in mind that setting the table Editable property to No will result in hiding the Save button of the Form Link created.

Setting the Form Link column Editable property as No will result in hiding the Save button of the Form Link created.

 

5. Go to the Work Portal to test the control.

Click on the form link. Note the child form previously created will display in a new window.

 

FormsComponents229


Last Updated 1/23/2023 12:04:28 PM