Trigger Form Button

UiPath.Form.Activities.TriggerFormButton

Description

Use this activity to trigger the execution of the Do block of an external process.

You provide the ID of the process you want to execute externally and the key of the button that executes the Do block in the external form. At runtime, the activity searches for the indicated form process ID and clicks on the specified button key to execute the Do block. To find out a Form Process Id, use the Output field of the Start Form Activity in the corresponding workflow.

Project compatibility

Winodows - Legacy | Windows

Properties panel

Common

The properties in this category refer to common activity settings.

• Display Name (String) - Sets the name for this activity. For example, "Trigger Approve Button On Form".

Input

The properties in this category refer to the identifiers of the form that is triggered externally.

• Button Key (String) - Enter the key of the button used to trigger the Do block. The value must match the field key value of the button component in the referenced form.
• Form Process Id (Int32) - Enter the ID of the process that generates the form containing the triggering button. You can retrieve the process ID through the Output field of the Start Activity. Make sure you are in the correct process when you use this option, as you need to collect the ID of the process that needs to be triggered externally.

Misc

The property in this category refers to miscellaneous settings.

• Private (Boolean) - To skip logging variables and arguments at Verbose level, check this box. By default, the checkbox is cleared (set to false).

Workflow example

The example below demonstrates how to configure trigger form buttons.

1. For example, you design a button (Approve) in the Form1 form of the Process1 process. While in Process1, make sure to check the following:

   • You use "approve" as the Field Key value of the button component.
   • You use the Start Form activity to retrieve the Process1 process ID: you create a variable process_id in the activity Output > Form Process Id field.
2. You have another process, called Process2, and you need it to trigger the Approve button of the Form1 form (which is generated by the Process1 process). Process1 is a process external to Process2. While in Process2, make sure to check the following:
   • You use the Trigger Form Button activity.
   • For the Button Key property, enter the field key of the Approve button from Process1 (for example, "approve").
   • For the Form Process Id, enter the Process1 process ID returned by the Start Activity (for example, the variable process_id).

Result: The Trigger Form Button activity searches for the indicated process ID and clicks on the specified button, thus executing the Do block in the Form1 form (externally triggered from Process2).