UiPath Documentation
activities
latest
false
UI Automation activities

Click Picture on Screen

Click Picture on Screen activity that clicks the picture displayed on a SAP GUI screen.

UiPath.UIAutomationNext.Activities.NSAPClickPictureOnScreen

Description​

Clicks the picture displayed on a SAP GUI screen.

Project compatibility​

Windows - Legacy | Windows | Cross-platform

Windows and Cross-platform configuration​

  • Work in scope - Select the browser tab or application window that hosts the application to automate, when the activity is placed inside nested Use Application/Browser activities.

  • Indicate on screen - Indicate the UI element to use as target. After you indicate the target, select the hamburger menu next to the informative screenshot to access the following options:

    • Indicate target - Indicate the target again. If the Descriptor is defined in the Object Repository, you must first unlink it from the Object Repository if you want to specify a Descriptor only for the current activity.
    • Edit target - Open the selection mode to configure the target.
    • Remove Informative Screenshot - Remove the screenshot of the target application or web page.
    • Change Informative Screenshot - Change the screenshot of the target application or web page.
    • Add to Object Repository - Add the current UI element to the Object Repository, from where it can be reused throughout your automation process. This option is only displayed when the object has not yet been added to the Object Repository.
    • Show in Object Repository - Open the Object Repository panel with the Descriptor selected. This option is only displayed when the object has been added to the Object Repository.
    • Unlink from Object Repository - Unlink the Descriptor from the Object Repository. This option is only displayed when the object has been added to the Object Repository.
  • Click type - Select from the drop-down menu the type of mouse click to perform when simulating the click event: Single, Double, Down, or Up. The default option is Single.

Properties panel

Target​

  • Expand target properties/Collapse target properties button - Displays/hides the target container and its anchor(s) properties.

  • Targeting methods - The selector types that you want to use for identifying the element. This property can be set to any combination, and at least one targeting method must be selected:

    • Strict selector
    • Fuzzy selector
    • Image (only available for Windows projects)
    • Native text (only available for Windows projects)
    • Computer Vision
    • Semantic selector
  • Window selector (Application instance) - The selector that is used for the application window. Only applicable when the window attach mode is set to Application instance.

  • Strict selector - The strict selector generated for the UI element. It is only displayed if Strict selector targeting method has been selected.

  • Fuzzy selector - The parameters for the fuzzy selector. It is only displayed if Fuzzy selector targeting method has been selected.

  • Image - These properties are available only when the Image targeting method is selected.

    • Image accuracy - Specifies the confidence threshold used for image matching. The default value is 0.8.
    • Image occurrence - Specifies which match to use when multiple matching images are found.
  • Native - These properties are available only when the Native targeting method is selected.

    • Native text - Specifies the text used to identify the UI element.
    • Native text occurrence - Specifies which occurrence to use when multiple matches are found.
    • Native text case-sensitive - Specifies whether text matching is case-sensitive.
  • Computer Vision - These properties are available only when the Computer Vision targeting method is selected. To use Computer Vision as a targeting method, you need to go to Project Settings > Computer Vision and make sure to set the correct server endpoint.

    • CV Control type - Specifies the type of control identified using Computer Vision.
    • CV Text - Specifies the text identified using Computer Vision.
    • CV Text accuracy - Specifies the confidence threshold used for OCR text matching. The default value is 0.7.
    • CV Text occurrence - Specifies which occurrence to use when multiple matches are found.
  • Semantic selector - A semantic description that defines the target. This property is available only when the Semantic selector targeting method has been selected.

    • Semantic selector method - Specifies the method used to detect elements on screen.
      • Legacy - For desktop apps: Searches the elements found by the Computer Vision on screen. For web apps: Searches the elements available in the DOM. This method is deprecated.
      • DOM - Searches the DOM. Reaches any element, including off-screen. Less precise on visual details. Not available on non-web applications.
      • Image - Searches the screen image. Detects any object on the screen, including icons, colors, and styles. Limited to what's visible.
    • Semantic selector model - Indicates the underlying LLM model used for semantic processing. This value is read-only. It can be changed only from Project settings > UI Automation > Semantic Selector > Legacy - Model / DOM - Model / Image - Model.
  • Wait for page load - Before performing the action, waits for the application to become ready to accept input. You can choose one of three options from the drop-down menu:

    • None - Does not wait for the target to be ready.
    • Interactive - Waits until only a part of the app is loaded.
    • Complete - Waits for the entire app to be loaded.
  • Visibility check - Checks whether the UI element is visible or not. You can choose one of three options from the drop-down menu:

    • None - Does not check for visibility.
    • Interactive (for Fuzzy selector) - Default option. Checks if the element is potentially visible, ignoring page scroll and obstructions by other apps, or the fact that the application is minimized. This check is useful when trying to ensure that you are not targeting invisible elements that exist in the DOM but are hidden.
    • Fully visible - Checks if the UI element is visible or not.
  • Responsive websites - Enables responsive websites layout.

Target - Anchor (n)​
  • Targeting methods - The selector types that you want to use for identifying the element. This property can be set to any combination, and at least one targeting method must be selected:
    • Strict selector
    • Fuzzy selector
    • Image (only available for Windows projects)
    • Native text (only available for Windows projects)
    • Computer Vision
  • Strict selector - The strict selector generated for the UI element. It is only displayed if Strict selector targeting method has been selected.
  • Fuzzy selector - The parameters for the fuzzy selector. It is only displayed if Fuzzy selector targeting method has been selected.
  • Image - These properties are available only when the Image targeting method is selected.
    • Image accuracy - Specifies the confidence threshold used for image matching. The default value is 0.8.
    • Image occurrence - Specifies which match to use when multiple matching images are found.
  • Native - These properties are available only when the Native targeting method is selected.
    • Native text - Specifies the text used to identify the UI element.
    • Native text occurrence - Specifies which occurrence to use when multiple matches are found.
    • Native text case-sensitive - Specifies whether text matching is case-sensitive.
  • Computer Vision - These properties are available only when the Computer Vision targeting method is selected.
    • CV Control type - Specifies the type of control identified using Computer Vision.
    • CV Text - Specifies the text identified using Computer Vision.
    • CV Text accuracy - Specifies the confidence threshold used for OCR text matching. The default value is 0.7.
    • CV Text occurrence - Specifies which occurrence to use when multiple matches are found.
Target - Offset point​

Specifies an offset, which can be further configured.

  • Anchoring point - Describes the starting point of the cursor to which it offsets from Offset X and Offset Y properties are added. The following options are available: Top left, Top right, Bottom left, Bottom right, and Center (selected by default).
  • Offset X - Horizontal displacement of the cursor position according to the option selected in the Anchoring point field. This field supports only Int32 variables.
  • Offset Y - Vertical displacement of the cursor position according to the option selected in the Anchoring point field. This field supports only Int32 variables.

Options​

  • Activate - Brings the UI element to the foreground and activates it before clicking it. This field only supports Boolean values (True, False). The default value is True.
  • Alter disabled element - When selected, the activity executes the action even if the target element is disabled. This field only supports Boolean values (True, False). The default value is False.
  • Key modifiers - Add one or more key modifiers to use in combination with the click. The following options are available: Alt/Opt, Ctrl, Shift, and Win/Cmd.
  • 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 if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). 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.

Options - Offset point​

  • Enable offset point - Indicates whether the offset point is enabled at the activity level. When enabled, it takes precedence over the offset point configured on the target.
    • Anchoring point - Specifies the reference point of the cursor from which the Offset X and Offset Y values are applied. The following options are available: Top left, Top right, Bottom left, Bottom right, and Center (selected by default).
    • Offset X - Defines the horizontal displacement of the cursor position relative to the selected anchoring point.
    • Offset Y - Defines the vertical displacement of the cursor position relative to the selected anchoring point.

Timings​

  • Delay before - Delay (in seconds) between the time the previous activity is completed and the time this activity begins performing any operations. The default value is 0.2 seconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.

  • Delay after - Delay (in seconds) between the time this activity is completed and the time the next activity begins any operations. The default value is 0.3 seconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.

  • Timeout - Specifies the amount of time (in seconds) to wait for the operation to be performed before generating an error. The default value is 30 seconds.

Input/Output​

  • Input element - The UI element on which the activity is executed, stored in an UIElement object. This field supports only UIElement objects. This object can be obtained from the Output Element property field of other UI Automation activities.

Windows - Legacy configuration​

Designer panel​

  • Select Indicate in App/Browser to indicate the UI element to use as target.

After you indicate the target, select the Menudocs image button to access the following options:

  • Indicate target on screen - Indicate the target again.
  • Edit target - Open the selection mode to configure the target.
  • Remove informative screenshot - Remove the screenshot of the target application or web page.
  • Add to Object Repository - Add the current UI element to a library project, from where it can be reused throughout your automation process.
  • Click type - Select from the drop-down menu the type of click to perform when simulating the click event: Single, Double, Down, or Up. The default option is Single.

Properties panel​

Common​
  • Continue on error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). 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.
    Note:

    If this activity is included in Try Catch and the value of the ContinueOnError property is set to True, no error is caught when the project is executed.

  • Delay after - Delay (in seconds) between the time this activity is completed and the time the next activity begins any operations. The default value is 0.3 seconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.
  • Delay before - Delay (in seconds) between the time the previous activity is completed and the time this activity begins performing any operations. The default value is 0.2 seconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.
  • Display name - The display name of the activity.
  • Timeout - Specifies the amount of time (in seconds) to wait for the activity to be executed before throwing an error. The default value is 30 seconds.
Input​
  • Click type - Select from the drop-down menu the type of mouse click to perform when simulating the click event: Single, Double, Down, or Up. The default option is Single.

  • Target - The target element. Target element must be set. Before indicating on screen, this field is set to (null). Once the target is indicated, all properties regarding the element that was indicated are displayed.

    • Click offset - Specifies an offset for the click activity, which can be further configured.
      • Anchoring point - Describes the starting point of the cursor to which it offsets from Offset X and Offset Y properties are added. The following options are available: Top left, Top right, Bottom left, Bottom right, and Center. By default, Center is selected.
      • Offset X - Horizontal displacement of the cursor position according to the option selected in the Anchoring point field. This field supports only Int32 variables.
      • Offset Y - Vertical displacement of the cursor position according to the option selected in the Anchoring point field. This field supports only Int32 variables.
    • CV Control type - Indicates the type of control identified using Computer Vision.
    • CV Text - Indicates the text identified using Computer Vision.
    • Fuzzy selector - The parameters for the fuzzy selector.
    • Native text - The text that is used to identify the UI element.
    • Responsive websites - Enables responsive websites layout.
    • Strict selector - The strict selector generated for the UI element.
    • Targeting methods - The selector types that you want to use for identifying the element. This property can be set to any combination from the drop-down menu:
      • None
      • Strict selector
      • Fuzzy selector
      • Image
      • Native text
      • Computer Vision - To use Computer Vision as a targeting method, you need to go to Project Settings > Computer Vision and make sure to set the correct server endpoint. You can leave this field as it is and use UiPath Cloud, which is filled-in by default, or you can enter another value either by selecting any of the other public endpoints specific to a server region or your own on-premises server. Another way of using Computer Vision as a targeting method is to set Use Local Server to True. This implies that the UiPath.ComputerVision.LocalServer package is installed in your project. When Local Server is enabled, the server value is overwritten. However, the Local Server is not available in cross-platform projects.
    • Visibility check - Checks whether the UI element is visible or not. You can choose one of three options from the drop-down menu:
      • None - Does not check for visibility.
      • Interactive (for Fuzzy Selector) - Default option. Checks if the element is potentially visible, ignoring page scroll and obstructions by other apps, or the fact that the application is minimized. This check is useful when trying to ensure that you are not targeting invisible elements that exist in the DOM but are hidden.
      • Fully visible
        • Checks if the UI element is visible or not.
    • Wait for page load - Before performing the action, waits for the application to become ready to accept input. You can choose one of three options from the drop-down menu:
      • None - Does not wait for the target to be ready.
      • Interactive - Waits until only a part of the app is loaded.
      • Complete - Waits for the entire app to be loaded.
    • Window selector (Application instance) - The selector that is used for the application window. Only applicable when the window attach mode is set to Application instance.
Input/Output Element​
  • Input element - The UI element on which the activity is executed, stored in an 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 - Outputs a target UI Element and stores it in a UIElement object, which can be further used to target the same element with other activities.
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level. This field supports only Boolean (True, False) values. The default value is False.
Options​
  • Activate - Brings the UI element to the foreground and activates it before clicking it. This field only supports Boolean values (True, False). The default value is False.
  • Alter disabled element - If selected, the activity executes the action even if the specified UI element is disabled. This field only supports Boolean values (True, False). The default value is False.

This property does not apply if the Input Mode property is set to Hardware Events.

  • Key modifiers - Add one or more key modifiers to use in combination with the action of the activity. The following options are available: None, Alt, Ctrl, Shift, and Win. The default option is None. Key modifiers cannot be used with the Simulate input mode.

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated