UiPath Documentation
activities
latest
false

UI Automation activities

Element Scope

Important:

The modern Element Scope activity is only available in Preview.

UiPath.UIAutomationNext.Activities.NElementScope

Description

The Element Scope activity identifies a single UI element once and then exposes it as the scope for every activity placed in its body. All child activities (for example, Click, Type Into, Get Text, Get Attribute) target elements relative to the element you indicated, instead of searching the whole screen again.

Use it when you want to run several actions inside the same container — a table row, a form section, a card, or a panel — while keeping selectors short, stable, and fast.

The body of the activity is a container. Child activities that should target the indicated element (or its descendants) are placed inside the body. Every child activity runs against the element captured by the scope, so you only indicate the parent element once.

Note:

Element Scope can be placed inside a Use Application/Browser activity, so the element is resolved within that application/browser scope and child activities can inherit its settings. It can also be used on its own by indicating an element directly.

Project compatibility

Windows | Cross-platform

Configuration

  • Indicate on screen - Indicate the UI element you want to attach to. Once indicated, the activity card displays a preview of the target element and its anchors.
    After you indicate the target, manage the target by selecting the menu options button and choosing one of the following options:
    • Indicate target - Indicate the target again. If the Descriptor is defined in Object Repository, you have to unlink it before you can indicate a Descriptor only for the current activity.
    • Edit target - Open the Selection Helper to configure the target element.
    • Remove Informative Screenshot - Removes the screenshot of the target element.
    • Change Informative Screenshot - Changes the screenshot of the target element.
    • Show in Object Repository - Opens the Object Repository panel with the Descriptor selected.
    • Unlink from Object Repository - Unlinks the Descriptor from Object Repository.
    • Add to Object Repository - Adds the current UI element to a library project, from where it can be reused throughout your automation process.

Properties panel

Target

The UI element the scope attaches to. The target is configured when you indicate the element on screen and can be refined using the following options:

  • Window selector (Application instance) - The selector for the application window (application/browser).
  • Strict selector - The selector generated for the indicated element. A selector is an XML fragment that identifies the element by its attributes.

Options

  • Healing Agent mode - Configures the behavior of the Healing Agent for this activity, based on Governance or Orchestrator settings at process or job level.
    • Same as App/Browser - Inherits the configuration from the parent Use Application/Browser activity.
    • Inherit job settings - Applies the settings defined in Governance or in Orchestrator at the process or job level.
    • Disabled - Turns off the Healing Agent for this activity.
    • Recommendation only - Enables the Healing Agent to provide recommendations on how to fix UI automation issues on running jobs, but only if permitted by Governance or Orchestrator settings.
  • Continue on error - Specifies whether the automation should continue even when the activity throws an error. This field only supports Boolean (True, False) values. The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
  • Input mode - Specifies which technology is used to interact with the target element. Child activities inside the scope can inherit this mode. The available options are:
    • Hardware Events - Acts like a real user, using the mouse and keyboard through the operating system. Emulates human behavior fully, but some events may be lost, and the target application must be in focus.
    • Simulate - Simulates the action using accessibility APIs. Recommended for browsers, Java-based apps, and SAP. Usually more reliable than Hardware Events, sends all text in a single action, and works even when the target app is not in focus. Verify that the target element supports it.
    • Chromium API - Performs actions using debugger APIs. Works for Chromium elements only. Sends all text in one go, and works when the target app is not in focus.
    • Window Messages - Uses Win32 messages. Recommended for desktop apps. Usually more reliable than Hardware Events, sends all text at once, and works even when the target app is not in focus. Verify that the target element supports it.
    • Background - Runs in the background. Uses Simulate where possible; complex activities (image, native text) still run in the foreground.

Timings

  • Timeout - Specifies the amount of time (in seconds) to wait for the target element to be found before an error is thrown. The default value is 30 seconds.
Note:

The Delay before and Delay after properties are not used by Element Scope and are hidden in the Designer. Project-level delay settings are intentionally not applied to this activity.

Input/Output

  • Input element - The UI element on which the activity is executed, stored in a UiElement object. This field supports only UiElement objects. This object can be obtained from the Output element property field of other UI Automation activities.
  • Output element - The resolved UI element, stored in a UiElement object. This variable can then be passed to other activities that accept UiElement as input.
  • Description
  • Project compatibility
  • Configuration
  • Target
  • Options
  • Timings
  • Input/Output

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated