UiPath Documentation
apps
2022.10
false
Apps User Guide for Automation Suite

About Events and Rules

When designing your app, you often want to provide logic for when X happens do Y. Apps provides the ability for these dynamic actions:

  • X is called an Event.
  • Y is called a Rule.

Here are a few examples:

  • When the "Submit deposit" button is clicked, run an automation.
  • When the value of the "Cash In" textbox changes, change the label color to red if the value is < 0.
  • When the help icon is clicked, open the browser to show a documentation page.
  • When a tab button is clicked, change the page container to show a different page.

By specifying what rules to execute when an event occurs, your app transforms from being a simple display of information to an interactive console.

Events

Events are triggers that happen when a user interacts with an app or control. Each control supports a single event:

EventControl(s)
Clicked OnButton, Header, Label, Icon, Image
Value ChangedCheckbox, Date picker, Dropdown, Slider, Switch, Text Area, Textbox, List
LoadedPage, Table

Rules

Rules allow your app to take an action when a certain event occurs. Below is a list of the rules that Apps provides:

RuleDescription
Rule: If-Then-ElseProvides support for conditional statements in the rules builder
Rule: Open a PageOpens a page of the app as a pop-over or as the contents of a page container
Rule: Open URLOpens a URL in the browser
Rule: Close Pop-Over/Bottom SheetCloses the current Pop-Over
Rule: Show MessageShow a message as a toast notification
Rule: Show/Hide SpinnerShow or hide a spinner overlay to show the app as busy
Rule: Set ValuesSet the value of a property
Rule: Start ProcessStarts an Automation
Rule: Upload File to Storage BucketUploads files to a selected storage bucket.
Rule: Get File From Storage BucketDownloads files from a selected storage bucket.
Rule: Reset ValuesReverts a control to a default value, or clears it if a default value is not configured.
Rule: Create/Update Entity RecordCreate or updates an entity.
Rule: Delete Entity RecordDeletes an entity from Data Service.
Rule: Add to QueueAdds an item to queue.

Reordering Rules

You can reorder rules by clicking and dragging the "gripper" on the colored chip next to the rule's name:

  • Events
  • Rules
  • Reordering Rules

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated