18.3 Callouts & Forms for Attended Guidance
Key Takeaways
A callout is a uiform form bound to a UI element and displayed next to it with Show Callout.
Callouts can also be handled with Form.Activities because they are uiform files.
Show Callout passes values to the callout's components, and Instance Name distinguishes several visible callouts or forms.
Callout button events are handled with Form Event Trigger workflows in a Run Local Triggers design.
Keep callouts short, attached to stable elements, and closed when no longer relevant.
18.3 Callouts & Forms for Attended Guidance
Core Concept: A callout is a form bound to a UI element and displayed next to it. Callouts guide users inside the applications they already use: they point to the right field, validate input, pre-fill values, or start automations from a button. The exam description lists callouts among attended automation topics.
What a Callout Is
- A callout is a .uiform file designed with the Form Builder, like any form.
- The Show Callout activity (Callout.Activities package) displays it next to an indicated UI element in an application, website, or form.
- Because callouts are uiform files, they can also be handled with the Form.Activities package, just like regular forms.
| Form | Callout | |
|---|---|---|
| Position | A window of its own | Anchored next to a UI element |
| Typical use | Collect or show larger amounts of information | Short hints, validations, and buttons in context |
| Activity to show it | Show Form | Show Callout |
Show Callout Essentials
| Property | Purpose |
|---|---|
| Target | The UI element the callout attaches to |
| Callout (uiform) file | The callout to display |
| Arguments | A dictionary of values passed to the callout's components, for example the value to show in a label |
| Instance Name | A unique name so that several callouts or forms can be shown and addressed separately |
Values set through Arguments fill the callout's components when it opens. Components such as buttons can raise events that a Form Event Trigger workflow handles.
Common Callout Patterns
- Guidance: point at a field the user often gets wrong, with a short explanation.
- Validation: when the user leaves a field, a trigger workflow checks the value and shows a callout if it is invalid, for example "Policy number must have 10 digits".
- Pre-filling: a callout offers a suggested value with a "Use this value" button that fills the field.
- Starting automations: a callout button such as "Create refund" starts a trigger workflow that does the work in the background.
- AI summaries: a callout shows a short summary produced by a GenAI activity next to a long record.
Wiring a Callout into Trigger-Based Automation
A typical validation flow:
- The main workflow runs Run Local Triggers.
- A trigger workflow starts with an Application Event Trigger for the Focus lost event of the "Policy number" field, found with the Event Inspection Tool.
- The workflow reads the field value and checks it.
- If the value is invalid, Show Callout displays
PolicyHint.uiformnext to the field, passing the message through Arguments. - A Form Event Trigger on the callout's "Fix it" button formats the number and writes it back.
Designing Good Callouts
- Keep them short. One message and at most one or two buttons.
- Attach to stable elements. Use reliable, strict selectors for the target, because a callout that appears in the wrong place confuses users.
- Use Instance Names when more than one callout or form can be visible.
- Close them deliberately. Close the callout when the user fixes the value or moves to another screen, so stale callouts do not pile up.
- Test in the real application. Screen scaling and window positions affect where the callout appears.
Forms Recap for Attended Scenarios
Forms and callouts share the Form Builder and many activities:
| Activity | Use |
|---|---|
| Show Form / Show Callout | Display a form or a callout |
| Get Form Values / Set Form Values | Read or change values at run time |
| Change Form Properties | Change properties such as title or size at run time |
| Run Form Script | Run custom JavaScript in the form |
| Close Form | Close a form instance |
| Form Event Trigger | Start a workflow on a form or callout event |
Worked Example: Refund Approval Hint
A service agent issues refunds in a web back office. The automation:
- Watches the refund amount field with a trigger workflow.
- When the amount exceeds the agent's approval limit, shows a callout next to the Submit button: "Amounts above your limit need supervisor approval".
- The callout offers Request approval, which starts a workflow that creates an approval task and records its ID in the ticket.
- The callout closes once the request is sent.
The agent stays in the back office the whole time, and the rule is enforced where the mistake would happen.
Common Traps
- A callout is not a separate application window; it needs a target UI element.
- Callout events are handled by Form Event Trigger workflows, not by polling.
- Forgetting unique Instance Names makes it hard to update or close the right callout.
- Showing callouts from a workflow that does not run triggers; the callout's buttons then have no Form Event Trigger listening.
What is a callout in UiPath attended automation?
A pop-up message box created with the Message Box activity.
An Orchestrator alert shown in Assistant.
A form bound to a UI element and displayed next to it with the Show Callout activity.
A comment attached to an activity in Studio.
How does a workflow pass the message text to show in a callout?
Through the Show Callout Arguments dictionary, which fills the callout's components.
By editing the uiform file at run time with Write Text File.
By setting a global Orchestrator asset.
Callouts can only show static text.
A callout has a "Fix it" button. How should the automation respond when the user clicks it?
Poll the button's state in a loop.
Use a Form Event Trigger workflow for the callout's button event.
Wait for an Orchestrator queue item.
Use a Click activity on the button.
Sections you finish are checked off in the contents.