Edit

SAP automation actions

The SAP automation actions provide a set of tools to help streamline and automate your SAP workflows. By using these actions, you can easily launch the SAP GUI app, create new sessions, select menu items, start and end transactions, and more.

With the actions of the SAP automation group, you can easily interact with SAP UI elements by clicking on them, filling in text fields, and extracting their data. Just enter the SAP UI element ID attribute value. If you don't know the ID value, you can use the Power Automate for desktop UI element picker to capture the required SAP element and retrieve its ID value. When you capture an SAP UI element in this way, only the element's ID value is recovered, and no UI element is added to the desktop flow's UI element repository.

Our SAP automation actions can also be integrated seamlessly with other actions available in Power Automate for desktop, including the UI automation group of actions. This group of actions allows you to capture all SAP GUI UI elements and add them to the desktop flow's UI element repository. By combining our SAP GUI automation actions with the UI automation group of actions, you can create powerful RPA workflows that automate even the most complex SAP processes.

Note

Power Automate for desktop supports automation with SAP GUI version 750 or later.

Known limitations

SAP Web UIs

UI or Web Automation actions or SAP actions don't work on SAP forms that open in SAP's embedded browser (Web Dynpro). One workaround for that limitation is to try to open that page directly to a standalone browser and automate it by using Web Automation actions.

Launch SAP

Open the SAP GUI application and connect to an SAP system.

You have two connection mode options:

  • Use the SAP name or IP address in the server description. To use this option, you need the necessary login credentials and access permissions. The server description is a human-readable name or description of the SAP system.
  • Use the server connection string. The server connection string typically includes the server's name or IP address, the instance number, and the system ID. The server connection string is a specific format for identifying and connecting to an SAP system.

You have multiple logon options:

  • Terminate this logon: This option terminates the specific action's logon.
  • Continue this logon and end any other logons: This option replaces the existing SAP instance with the specific logon.
  • Continue this logon without ending any other logons in the system: This option creates a new SAP session.

Note

SAP GUI doesn't allow more than six active connections (sessions) to an SAP system.

Input parameters

Argument Optional Accepts Default Value Description
Connection mode N/A Server description and server connection string Server description Specify how to connect to the SAP GUI server.
Login mode N/A Manual login and single sign-on (SSO) Manual login Specify how to log in to the SAP GUI server, either log in to the server by manually entering your username and password or using single sign-on (SSO).
Server description Yes Text value Specifies SAP system name or IP address for connection.
Connection string Yes Text value Specifies the connection string for the SAP GUI server. The connection string is a unique identifier that specifies the server's name, system number, and other connection details.
Client No Text value Specifies the SAP client number for connection.
Username No Text value Specifies the SAP user ID for login.
Password Yes Text value Specifies the SAP user password for login.
Language No Text value Specifies the SAP login language for the user interface.
Multiple logon options No Terminate this logon, continue this logon and end any other logons, Continue this logon without ending any other logons in the system Terminate this logon Multiple logon options specify how the SAP system behaves when the user tries to log in when they're already logged in.

Variables produced

Argument Type Description
SAPInstance SAP instance The SAP instance to use with SAP automation actions. The SAP instance refers to the specific SAP window.
CurrentSAPLoginTerminated Boolean value Whether the SAP login being performed with the specific action is terminated or not.
OtherSAPLoginTerminated Boolean value Whether the other SAP logins are terminated or not.

Exceptions

Exception Description
SAP GUI login action fails Indicates a problem logging in to an SAP GUI system.

Attach

Attach the running SAP GUI application to an SAP instance.

Input parameters

Argument Optional Accepts Default Value Description
Attach mode No Foreground or last activated, Window title Window title Specifies the mode for attaching the SAP instance to a window. If you select the Foreground or last activated option, the SAP instance attaches to the SAP session in the foreground. If there's no SAP session in the foreground, it attaches to the last SAP session that you launched and isn't closed yet.
Window title Yes Text Specifies the title of the SAP window to which the instance is attached. You can select the window title from the drop-down list of existing SAP sessions or enter it manually.

Variables produced

Argument Type Description
SAPInstance SAP instance The SAP instance to use with SAP automation actions. The SAP instance refers to the specific SAP window.

Exceptions

Exception Description
Attach to SAP error Indicates a problem attaching to an SAP instance.

Create new SAP session

Creates a new SAP session based on the same SAP instance.

Note

SAP GUI doesn't allow more than six active connections (sessions) to an SAP system.

Input parameters

Argument Optional Accepts Default Value Description
SAPInstance No SAP instance Select the variable that holds the SAP instance you want to work with. Define this variable in a previous SAP login action.

Variables produced

Argument Type Description
SAPInstance SAP instance The SAP instance to use with SAP automation actions. The SAP instance refers to the specific SAP window.

Exceptions

Exception Description
Create new SAP session action fails Indicates a problem creating a new SAP session.

Select SAP navigation item

Select an SAP menu item in the application toolbar of the SAP window.

Input parameters

Argument Optional Accepts Default Value Description
SAPInstance No SAP instance Select the variable that holds the SAP instance you want to work with. Define this variable in a previous SAP login action.
Navigation item name No Text value The name of the item in the navigation toolbar to select, such as 'System'. You can also specify an option from a submenu by using the '>' symbol to indicate the parent-child relationship. For example, 'Program > Execute' means that the 'Execute' option, which is part of the submenu under 'Program', is selected.

Variables produced

This action doesn't produce any variables.

Exceptions

Exception Description
SAP GUI select navigation toolbar item error Indicates a problem selecting a navigation toolbar item.

Select SAP menu item

Select an SAP menu item in the window tool bar. Enter the name of the item in the respective input parameter manually, in the same language as the SAP GUI screen is being displayed.

Input parameters

Argument Optional Accepts Default Value Description
SAPInstance No SAP instance Select the variable that holds the SAP instance you want to work with. Define this variable in a previous SAP login action.
Menu item name No Text value The name of the menu item in the toolbar to be selected, such as 'Save'. Insert the name of the menu item as it's displayed in the machine's SAP installation.

Variables produced

This action doesn't produce any variables.

Exceptions

Exception Description
Select SAP menu item action fails Indicates a problem selecting a menu item.

Close SAP connection

Closes the SAP connection for the selected SAP instance. When you close the connection, you terminate all instances related to that specific connection.

Input parameters

Argument Optional Accepts Default Value Description
SAPInstance No SAP instance Select the variable that holds the SAP instance you want to work with. Define this variable in a previous SAP login action.

Variables produced

This action doesn't produce any variables.

Exceptions

Exception Description
Close SAP session action fails Indicates a problem closing an SAP session.

Start SAP transaction

Opens a specific transaction code in an existing session.

Input parameters

Argument Optional Accepts Default Value Description
SAPInstance No SAP instance Select the variable that holds the SAP instance you want to work with. Define this variable in a previous SAP login action.
Transaction code No Text value The transaction code that you want to execute.

Variables produced

This action doesn't produce any variables.

Exceptions

Exception Description
Start SAP transaction action fails Indicates a problem starting an SAP transaction.

End SAP transaction

Closes the SAP transaction in a specific SAP instance and returns to the SAP easy access menu. You must start an SAP transaction before for the specific SAP session.

Input parameters

Argument Optional Accepts Default Value Description
SAPInstance No SAP instance Select the variable that holds the SAP instance you want to work with. Define this variable in a previous SAP login action.

Variables produced

This action doesn't produce any variables.

Exceptions

Exception Description
End SAP transaction action fails Indicates a problem ending an SAP transaction.

Click SAP UI element

Interacts through click action on any UI element of an SAP window.

Input parameters

Argument Optional Accepts Default Value Description
SAPInstance No SAP instance Select the variable that holds the SAP instance you want to work with. Define this variable in a previous SAP login action.
Element type No Basic SAP element, Checkbox, Label, Drop-down list, Grid element Basic SAP element Select the SAP element type you want to interact with. The 'Click SAP element' option performs a click action on any SAP element like buttons, radio buttons, tabs, text fields, or trees.
SAP element ID No Numeric The SAP element's ID. This parameter determines the UI element in SAP that action interacts with. Use the following button to indicate the SAP UI element in the SAP screen or insert the value manually.
SAP element ID No Numeric The SAP element's ID. This parameter determines the UI element in SAP that action interacts with. Use the following button to indicate the SAP UI element in the SAP screen or insert the value manually.
Set SAP checkbox state to Yes Checked, Unchecked Checked Specify whether the checkbox becomes checked or unchecked.
SAP label operation Yes Expand, Collapse, Choose Expand Specify whether to expand or collapse the SAP label.
Drop-down option value Yes Text value Specify the drop-down option is selected.
SAP grid element Yes Cell, Row, Header, List, Button, Toolbar Button, Checkbox, Radio Button Cell Select the SAP grid element type you want to interact with.

Variables produced

This action doesn't produce any variables.

Exceptions

Exception Description
Click Sap GUI Element error Indicates that the click failed.

Get details of SAP UI element

Gets the value of an SAP UI element's attribute in an SAP window.

Input parameters

Argument Optional Accepts Default Value Description
SAPInstance No SAP instance Select the variable that holds the SAP instance you want to work with. Define this variable in a previous SAP login action.
SAP element ID No Numeric The SAP element's ID. This parameter determines the UI element in SAP that action interacts with. Use the following button to indicate the SAP UI element in the SAP screen or insert the value manually.
Attribute name No Text value Own text The attribute whose value is retrieved.

Variables produced

Argument Type Description
AttributeValue Text value The value of the SAP UI element's attribute.

Exceptions

Exception Description
Get SAP element detail error Indicates a problem retrieving the UI element's attribute.

Populate SAP text field in element

Fills a text box in an SAP window with the specified text.

Input parameters

Argument Optional Accepts Default Value Description
SAPInstance No SAP instance Select the variable that holds the SAP instance you want to work with. Define this variable in a previous SAP login action.
SAP element ID No Numeric The SAP element's ID. This parameter determines the UI element in SAP that action interacts with. Use the following button to indicate the SAP UI element in the SAP screen or insert the value manually.
Text to fill in No Direct encrypted input or Text value The text to fill in the SAP text field
If field isn't empty Yes Replace text, Append text Replace text Specify whether to replace existing content, or to append.

Variables produced

This action doesn't produce any variables.

Exceptions

Exception Description
Populate Sap Text Field Value error Indicates a problem populating the specified SAP text field.
  • Last updated on