Click Toolbar Button

Estimated reading: 3 minutes

The ClickToolbarButton activity clicks a toolbar button or toolbar menu item in the SAP user interface. It locates the target control within the active SAP session using the element captured through Select Element or the SAP function code provided in the Button Id property, and then performs the click action.

Prerequisites

Execute the SAP Logon activity to establish or attach to an SAP session before using ClickToolbarButton to interact with SAP toolbar elements.

Activity Designer Options

Select Element: Opens the SAP UI spy tool to visually capture the target toolbar button, and the menu entry if applicable, on the SAP screen.

Button Id: Specifies the SAP function code of the toolbar button to click. This value is populated automatically when a toolbar button is captured using Select Element, or it can be entered manually.

Menu Item: Specifies the menu entry to select when the target toolbar button contains a dropdown menu. This value is populated automatically when a menu item is captured using Select Element, or it can be entered manually if required.

Properties

Execution

Delay After: Specifies the pause duration (in milliseconds) after the activity executes. The default value is 300.

Delay Before: Specifies the pause duration (in milliseconds) before the activity begins executing. The default value is 200.

Use Anchor: Boolean checkbox indicating whether an anchor element should be used to reliably locate the target toolbar button. Checked (True) by default.

Wait Time: Specifies the maximum duration (in milliseconds) to wait for the toolbar button to become available before timing out. The default value is 30000 (30 seconds).

Input

Button Id: Specifies the function code or identifier of the target toolbar button (e.g., SAVE, BACK, or the button ID captured automatically via Select Element).

Menu Item: Specifies the exact menu entry to click if the target toolbar button opens a dropdown menu. This field is automatically populated when captured using Select Element.

MISC

DisplayName: The display name of the activity in the workflow designer. The default value is ClickToolbarButton.

SkipOnError: Specifies whether workflow execution continues when the activity encounters an error.
True: Continues workflow execution when an error occurs.
False: Stops workflow execution when an error occurs.
None: Uses the default value, False

Version: Displays the version number of the SAP Automation activity package being used (1.1.9).

Output

Result: Returns a Boolean value indicating the activity’s execution status.
True: The activity executed successfully.
False: The activity failed due to an unexpected error.

How It Works

1. The ClickToolbarButton activity identifies the target SAP toolbar button using the configured Button Id or the information captured through Select Element.
2. If a toolbar menu item is specified, the activity locates the parent toolbar button and identifies the configured Menu Item.
3. During execution, the activity searches for the target control within the active SAP session.
4. It waits for the configured Wait Time while attempting to locate the toolbar button or menu item.
5. Once the target control is found, the activity performs the click operation.
6. If the target is a menu item, the activity opens the toolbar menu and selects the specified entry.
7. The outcome of the operation is returned through the Result output property for use in subsequent workflow steps.

Share this Doc

Click Toolbar Button

Or copy link

CONTENTS
Robility Chatbot
Robility Assistant
Online