- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- Types of Workflows
- Control Flow
- File Comparison
- Automation Best Practices
- Source Control Integration
- Debugging
- Logging
- The Diagnostic Tool
- Workflow Analyzer
- About Workflow Analyzer
- ST-NMG-001 - Variables Naming Convention
- ST-NMG-002 - Arguments Naming Convention
- ST-NMG-004 - Display Name Duplication
- ST-NMG-005 - Variable Overrides Variable
- ST-NMG-006 - Variable Overrides Argument
- ST-NMG-008 - Variable Length Exceeded
- ST-NMG-009 - Prefix Datatable Variables
- ST-NMG-011 - Prefix Datatable Arguments
- ST-NMG-012 - Argument Default Values
- ST-NMG-016 - Argument Length Exceeded
- ST-NMG-017 - Class name matches default namespace
- ST-DBP-002 - High Arguments Count
- ST-DBP-003 - Empty Catch Block
- ST-DBP-007 - Multiple Flowchart Layers
- ST-DPB-010 - Multiple instances of [Workflow] or [Test Case]
- ST-DBP-020 - Undefined Output Properties
- ST-DBP-021 - Hardcoded Timeout
- ST-DBP-023 - Empty Workflow
- ST-DBP-024 - Persistence Activity Check
- ST-DBP-025 - Variables Serialization Prerequisite
- ST-DBP-026 - Delay Activity Usage
- ST-DBP-027 - Persistence Best Practice
- ST-DBP-028 - Arguments Serialization Prerequisite
- ST-USG-005 - Hardcoded Activity Arguments
- ST-USG-009 - Unused Variables
- ST-USG-010 - Unused Dependencies
- ST-USG-014 - Package Restrictions
- ST-USG-020 - Minimum Log Messages
- ST-USG-024 - Unused Saved for Later
- ST-USG-025 - Saved Value Misuse
- ST-USG-026 - Activity Restrictions
- ST-USG-027 - Required Packages
- ST-USG-028 - Restrict Invoke File Templates
- ST-USG-032 - Required Tags
- ST-USG-034 - Automation Hub URL
- Variables
- Arguments
- Imported Namespaces
- Coded automations
- Introduction
- Registering custom services
- Before and After contexts
- Generating code
- Generating coded test case from manual test cases
- Trigger-based Attended Automation
- Recording
- UI Elements
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Automating Citrix Technologies
- RDP Automation
- VMware Horizon Automation
- Salesforce Automation
- SAP Automation
- macOS UI Automation
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- Extensions
- About extensions
- SetupExtensions tool
- UiPathRemoteRuntime.exe is not running in the remote session
- UiPath Remote Runtime blocks Citrix session from being closed
- UiPath Remote Runtime causes memory leak
- UiPath.UIAutomation.Activities packages and UiPath Remote Runtime versions mismatch
- The required UiPath extension is not installed on the remote machine
- Screen resolution settings
- Chrome Group Policies
- Cannot communicate with the browser
- Chrome extension is removed automatically
- The extension may have been corrupted
- Check if the extension for Chrome is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and Incognito mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Chrome
- Chrome Extension on Mac
- Edge Group Policies
- Cannot communicate with the browser
- Edge extension is removed automatically
- The extension may have been corrupted
- Check if the Extension for Microsoft Edge is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and InPrivate mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Edge
- Extension for Safari
- Extension for VMware Horizon
- Extension for Amazon WorkSpaces
- SAP Solution Manager plugin
- Excel Add-in
- Test Suite - Studio
- Troubleshooting
UI Explorer
UiPath.UIAutomation.Activities
package is installed as a dependency to the project.
Using UI Explorer as a standalone tool does not require you to install Studio. This comes in handy when you want to make sure that an application can be automated with selectors. It enables you to simply inspect elements without building a process. The standalone package also contains the SetupExtensions utility, thus making it possible to install browser extensions and the JavaBridge to inspect elements across all your automation needs.
To open the UI Explorer window, click the button in the Selectors section, in the Design tab, or from the advanced editor in the selection screen of all the selectors of the target and anchors attributes, after indicating the target UI element.
UiPath.UIAutomation.Activities
pack installed as a dependency for the current project, the UI Explorer button does not appear in the Ribbon.
Alternatively, the UI Explorer can be launched from the Tools page in the Studio backstage view. UI Explorer from the context menu uses the UI automation libraries shipped with the current version of Studio.
To be sure that you choose the best selector, remember to:
- Add or remove attributes
- Add parent or children tags
-
Use wild cards to replace changing values
Field |
Description |
---|---|
Validate |
The button shows the status of the selector by checking the validity of the selector definition and the visibility of the target element on the screen. The Validate button has three states:
|
Indicate Element |
Indicates a new UI element to replace the previous one. |
Indicate Anchor |
Enables you to choose an anchor relative to the target UI element. |
Repair |
Enables you to re-indicate the same target UI element and repair the selector. This operation does not completely replace the previous selector. The button is available only when the selector is invalid. |
Highlight |
Brings the target element in the foreground. The highlight stays on until it's switched off. The button is enabled only if the selector is valid. |
Inspect Events | Opens the Event Inspection Tool. |
Options |
Contains several options:
Click here to read more about Active Accessibility and UI Automation.
|
Displays a tree of the UI hierarchy and enables you to navigate through it, by clicking the arrows in front of each node.
By default, the first time when you open UI Explorer, this panel displays all opened applications, in alphabetical order.
Double-clicking a UI element (or right-clicking and selecting Set as Target Element) from the tree, populates the Selector Editor, Selector Attributes and Property Explorer panels.
Field |
Description |
---|---|
Highlight |
Highlights the selected element from the Visual Tree in real time. The highlight stays on until it's switched off. |
Show Search Options |
Displays the search box and search filter options. |
Search Box |
Enables you to look for a specific string. If an exact match is not found, nodes containing the nearest match are displayed. Wildcards are supported. Depending on the attribute selected from the Search by drop-down list, the search can be case sensitive. Note: The search only looks for matches in the tree structure under the selected UI object.
|
Search by |
Filters your search to a selected attribute or a selector. The contents of this drop-down list change according to the selected UI element. Note: If Search by is set to Selector, you can only input one node in the
<attribute name1='value1' ... /> format.
|
Children Only |
Limit your search to the first level children of the selected node. By default, this check box is not selected. |
Displays the selector for the specified UI object and enables you to customize it.
The bottom part of the panel displays the actual XML fragment that you have to use in a project. Once you find the selector you want, you can copy it from here and paste it in the Properties panel of an activity, in the Selector field.
The top part of this panel enables you to view all the nodes in a selector and eliminate the ones that are not necessary by clearing the check box in front of them. An element in the list of selector nodes becomes active when you enable or disable an attribute, or when editing a selector in the bottom panel. Only one node is active at a time.
Selecting a node here displays its attributes in the Selector Attributes and Property Explorer panels.
CTRL+K
hotkey to create a variable in the selector itself, or by specifying an already created variable with the CTRL+Space
combination. Using the CTRL+K
hotkey enables you to specify a value and a name for the variable. Please note that only string
variables can be used.
Displays all the available attributes of a selected node (from the Selector Editor panel).
You can add or eliminate some of the node attributes by selecting or clearing the check box in front of each attribute.
Additionally, you can change the value of each attribute yet this modification is retained only if the new selector points at the originally selected UI object.
In the context of trigger-based attended automation, the Event Inspection Tool can be used to identify the type of native events triggered when you interact with certain UI elements in an application, and then it can be used for configuring the Application Event Trigger activity. The tool captures and monitors all the selected event types, such as Click, Key pressed, Focus gained, Focus lost, and other relevant interactions, enabling you to analyze the actions performed and, if applicable, diagnose issues.
The Event Inspection Tool can be opened from the UI Explorer, once a valid UI element is selected, by clicking the Inspect Events toolbar button.
- Record - The events generated by interacting with the UI element are recorded and added to the events list.
- Pause - The events generated by the UI element when you interact with it are no longer recorded.
- Highlight - Shows the contour of the target element and brings it to the foreground for a few seconds. The highlight stays on until it is disabled.
- Open in UI Explorer - The monitored element is opened in UI Explorer where you can observe the selector of that element.
- Clear - Deletes all the recorded events.
- CSV - The captured events can be exported to a
.csv
file for further analysis.
- Event filter - Allows selecting the types of events you want to monitor for the target element.
- Event list - Displays information about captured events.
You can filter event types to be captured by enabling or disabling the checkboxes from the list of event types. The list may vary based on the selected element technology.
All mouse event types (Mouse move, Mouse pressed, Mouse released, Mouse entered, Mouse exited), specific for Web or Java UI elements, are disabled by default because the event list, in such cases, can become quite large. Our recommendation is to enable the mouse event types only if you have a specific need to monitor them.
It is worth also mentioning that event types can be enabled or disabled even after you started the event recording.
- Event Name - The event type.
- Time Stamp - The date and hour when the event was performed.
- Event Data - The associated data and parameters for a certain event.
.csv
file. To start
monitoring again, close the window and open another instance of the Event Inspection
Tool.