IA-Connect SAP GUI (Preview)

IA-Connect is a Robotic Process Automation (RPA) platform which adds RPA functionality from the Cloud to on-premises virtual machines or over Citrix or Microsoft Remote Desktop (RDS) connections. This is the module for automating the SAP GUI application.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Ultima Labs
URL https://www.ultima.com/ultima-labs
Email IAConnect@ultima.com
Connector Metadata
Publisher Ultima Labs
Website https://www.ultima.com/ultima-labs
Privacy policy https://www.ultima.com/privacy-policy
Categories IT Operations;Productivity

IA-Connect is a Robotic Process Automation (RPA) platform which adds RPA functionality from Power Automate Cloud Flows to on-premises virtual machines or over Citrix or Microsoft Remote Desktop (RDS) connections. The IA-Connect Connectors provide over 650 actions, allowing you to automate every type of on-premise application directly from a Power Automate Cloud Flow. All IA-Connect actions are available directly from your Power Automate Cloud Flow providing easy integration between Cloud based and on-premises applications, the ability to leverage existing Power Automate conditions, loops, dynamic content, expressions and exception handling in your RPA processes. Utilising the IA-Connect Connectors also provides full execution history and auditability from the Flow run history whilst also removing the need to have a separate application/console/studio for developing your RPA processes.

Prerequisites

To use any of the IA-Connect Connectors, you must install the IA-Connect software. This is free to test for 30 days, following which you will require an IA-Connect license.

The IA-Connect software consists of two main components:

  • The IA-Connect Orchestrator, which is an Azure WebApp which you would host in your own Azure tenant. This handles the routing and security of RPA Flows to one or more on-premises or cloud-based virtual machines.

  • The IA-Connect Agent and Director, which is installed onto the virtual machines where the software you wish to automate is accessible. Additionally, the IA-Connect Agent can run inside a Citrix or Microsoft Remote Desktop Services (RDS) session, where the RPA commands are passed down a virtual channel into the remote session for execution. The IA-Connect Agent can be run from a network share and does not require installation.

Available IA-Connect Connectors

The available IA-Connect Connectors are:

  • IA-Connect Dynamic Code
  • IA-Connect Java
  • IA-Connect Mainframe
  • IA-Connect Microsoft Office
  • IA-Connect SAP GUI
  • IA-Connect Session
  • IA-Connect UI
  • IA-Connect Web Browser

How to get credentials

In order to receive your license and begin your 30-day free trial, please submit a request on our website (https://www.ultima.com/IA-Connect/Power-Automate).

Once a trial request is received, we will contact you via the email address provided to assist with setting up the IA-Connect software and to provide you with the trial license. This is a fully featured trial and will enable you to test any of the 650 actions across all 8 IA-Connect Connectors within your own environment during the trial period.

Get started with your connector

After submitting a trial request for IA-Connect, you will be able to download a ZIP file containing the IA-Connect software and documentation covering the installation and setup. We will also contact you to offer support and guidance through the installation process as required.

Support

During the trial period, you can contact Ultima Labs (IAConnect@ultima.com) for support and assistance.

Upon purchasing IA-Connect licenses you will receive support tokens which can be redeemed for bespoke training or support from Ultima's UK-based Technical Service Centre (TSC).

Known issues, common errors and FAQs

Our Knowledge Base contains a number of articles covering any known issues, common errors that may occur when using the IA-Connect Connectors and frequently asked questions. This is accessible at https://support.ultima.com/ultimalabs and an account to access these resources is provided during the IA-Connect trial and upon purchasing an IA-Connect license.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True
IA-Connect Orchestrator address string Specify the IA-Connect Orchestrator address without the HTTP(S) component True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Attach to SAP session

Attaches IA-Connect to an open SAP session. This action can be used to switch control to any new SAP sessions that are opened within an existing connection.

Attach to SAPGUI instance

Attaches to an instance of SAP GUI which is already running. This is the first step towards automating SAP GUI if SAP GUI was already running.

Bring SAP window to the front

Brings a SAP window to the front.

Check SAP element

Sets the state of an SAP element (typically a checkbox or radio box) to either checked or unchecked.

Check SAP grid view cell checkbox

Check or uncheck a checkbox in a grid view cell at the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Check SAP table visible checkbox cell

Check or uncheck a checkbox in a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to check or uncheck visible cells.

Check SAP tree item

Checks a SAP tree item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Click link on SAP tree item

Clicks a link on a SAP tree item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Click SAP grid view cell

Clicks a grid view cell in the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Close SAP session

Closes an open SAP session.

Close SAP window

Closes an SAP window.

Deselect all on SAP grid view

Deselects everything in a SAP grid view.

Deselect all SAP tree nodes

Deselect all nodes in a SAP tree.

Detach from SAPGUI

Detaches IA-Connect from the running instance of SAPGUI.

Double click SAP grid view cell

Double clicks a grid view cell in the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Double click SAP tree item

Double clicks a node or item in a SAP tree. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Draw rectangle around SAP element

Draws a rectangle around the perimeter of an SAP element to aid in identifying that the element found is the one required. The rectangle is automatically removed after 5 seconds.

Draw rectangle around SAP grid view cell

Draws a rectangle around the perimeter of an SAP grid view cell to aid in identifying that the cell found is the one required. The rectangle is automatically removed after 5 seconds.

Enable SAP scripting

Enables SAP scripting in the SAP GUI. This setting must also be enabled on the SAP server by setting the 'sapgui/user_scripting' parameter value to TRUE.

Enter SAP T-code

Enters an SAP transaction code (T-code). This is the same as entering a T-code into the SAP command box.

Expand SAP tree node

Expands or collapses a node in a SAP tree. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Focus SAP calendar date

Focusses the specified calendar date (YYYYMMDD) in a SAP calendar element.

Focus SAP element

Focusses an SAP element which makes it the active element for keyboard focus and brings the SAP window to the foreground.

Get all SAP child element properties

Returns all properties of all SAP child elements. This can be useful if you are uncertain which field holds the property values required.

Get attached session properties

Returns information about the SAP session that IA-Connect is attached to.

Get SAP element at screen coordinate

If a SAP element exists at the specified coordinates, this action will identify the element and return the element ID.

Get SAP element properties

Returns all properties of an SAP element. This can be useful if you are uncertain which field holds the property values required.

Get SAP element properties as collection

Returns the properties of an SAP element as a single line list (single line collection / data table) instead of individual items, this maybe useful depending on how you intend to use the data.

Get SAP element text value

Returns the text value of an SAP element. A text value is usually associated with a text element, but many elements can have this property.

Get SAP grid view cell contents

Gets the contents of a grid view cell in the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Get SAP grid view cell properties

Returns all properties of a grid view cell in the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Get SAP grid view column headers

Returns a list of column headers in a grid view. The name or title of the column headers can be used for the 'Search column name' or 'Search column title' input in many SAP grid view actions.

Get SAP grid view properties

Returns the properties of an SAP grid view element. This is an element with an element type of 'GridView'.

Get SAP grid view text contents

Returns all the text contents of a SAP grid view.

Get SAP parent element Id

Returns the SAP element Id of the parent element of an SAP element.

Get SAP selection list items

Returns a list of child element items found under the specified SAP element (typically dropdown / menu items).

Get SAP session top level element properties

Returns the properties of the SAP element at the top-level of the active SAP session, typically the GuiMainWindow element.

Get SAP sessions

Returns a list of running SAP sessions. This information is useful if you wish to attach to an existing SAP connection / session but you don't know which ones are available.

Get SAP shell toolbar elements

Returns a list of elements (usually buttons) in a GuiShell toolbar.

Get SAP table properties

Returns the properties of an SAP table element. This is an element with an element type of 'GuiTableControl'. For gridview elements (these are similar to tables but provide additional functionality via a built-in toolbar), use the alternative action 'Get SAP grid view properties'.

Get SAP table visible cell properties

Returns all properties of a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to retrieve the properties of visible cells.

Get SAP table visible cell text contents

Gets the contents of a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to retrieve the contents of visible cells.

Get SAP table visible text contents

Gets the contents of all visible table cells within a table. This action can only be used to retrieve the contents of visible cells.

Get SAP tree column headers

Returns a list of column headers in a tree. The name or title of the column headers can be used for the 'Search column name' or 'Search column title' input in many SAP tree actions.

Get SAP tree item properties

Returns the properties of a SAP tree item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Get SAP tree nodes

Returns a list of all nodes in an SAP tree element.

Get SAP tree text contents

Returns the text contents of all nodes in a SAP tree.

Get SAPGUI attach status

Returns information about the current IA-Connect connection to SAP GUI.

Global double left click SAP grid view cell

Moves the mouse to the centre of an SAP grid view cell and double clicks the left mouse button.

Global double left mouse click on SAP element

Moves the mouse to the centre of an SAP element and double clicks the left mouse button.

Global input password into SAP element

Moves the mouse to centre of the SAP element, focusses it, left clicks, and presses keys. Typically used with a password input that will not accept native input methods.

Global input text into SAP element

Moves the mouse to centre of the SAP element, focusses it, left clicks, and presses keys. Typically used with a text input that will not accept native input methods.

Global left click SAP grid view cell

Moves the mouse to the centre of an SAP grid view cell and clicks the left mouse button.

Global left mouse click on SAP element

Moves the mouse to the centre of an SAP element and clicks the left mouse button.

Global middle mouse click on SAP element

Moves the mouse to the centre of an SAP element and clicks the middle mouse button.

Global right click SAP grid view cell

Moves the mouse to the centre of an SAP grid view cell and clicks the right mouse button.

Global right mouse click on SAP element

Moves the mouse to the centre of an SAP element and clicks the right mouse button.

Input password into SAP element

Inputs a password into an SAP element (typically a password entry field).

Input text into SAP element

Inputs text into an SAP element (typically a text entry field), either replacing the existing text or inserting the new value at a specific position.

Launch SAPGUI

Enables SAP scripting and launches SAP GUI. This is the first step towards automating SAP GUI if it was not already running.

Maximise SAP window

Maximises a SAP window.

Minimise SAP window

Minimises a SAP window.

Modify SAP grid view cell value

Modifies the contents of a grid view cell at the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Open SAP connection

Open a SAP connection using either the description of the SAP system (i.e. the name in the list of SAP connections) or the address of the SAP system (e.g. /H/address/S/3200).

Open SAP grid view context menu

Opens the SAP grid view context menu.

Open SAP tree item context menu

Opens the context menu for a SAP tree node or item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Press button on SAP tree item

Presses a button on a SAP tree item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Press key on SAP tree

Press a key on a SAP tree. There are a limited built-in list of keys you can press, for example 'F1', 'F4', 'Delete', 'Insert', 'Enter', 'Cut', 'Copy' or 'Paste'.

Press SAP element

Presses an SAP element (typically a button).

Press SAP grid view cell button

Presses a button in a grid view cell at the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Press SAP grid view column header

Presses a column header in a SAP grid view.

Press SAP shell toolbar context button

Presses a context button on a SAP element in a toolbar. The specific element to press the context button on can be searched using one of either the element Id, the text value or the element index.

Press SAP shell toolbar element

Presses an SAP element (usually a button) in a toolbar. The specific element to press can be searched using one of either the element Id, the text value or the element index.

Press SAP table visible cell

Presses a button in a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to press visible cells.

Restore SAP window

Restores a SAP window from being maximised or minimised.

Scroll SAP table

Scrolls an SAP table element either horizontally, vertically or both.

Select all on SAP grid view

Selects everything in a SAP grid view.

Select SAP calendar date range

Selects the specified date range (from YYYYMMDD to YYYYMMDD) in a SAP calendar element. This selection replaces any existing date selections.

Select SAP calendar month

Selects the specified month (1 to 12) in the specified year in a SAP calendar element. The month is selected in addition to any existing selection.

Select SAP calendar week

Selects the specified week (starting at 1) in the specified year in a SAP calendar element. The week is selected in addition to any existing selection.

Select SAP element

Selects an SAP element (typically a tab element or item in a list or drop-down).

Select SAP grid view column

Selects a single SAP column in a grid view. If a different column or columns are currently selected, they will remain selected unless the 'Clear selection first' parameter is set to true.

Select SAP grid view multiple rows

Selects multiple SAP rows in a grid view. If a different row or rows are currently selected, they will become deselected.

Select SAP grid view row

Selects a single SAP row in a grid view. If a different row or rows are currently selected, they will become deselected.

Select SAP list item by key

Selects the list element with the specified key. This is typically used to select an item in a dropdown / menu item.

Select SAP list item by name

Selects the list element with the specified name. This is typically used to select an item in a dropdown / menu item.

Select SAP shell toolbar menu item

Selects a menu item in a shell toolbar. The specific element to select can be searched using one of either the element Id, the text value or the element index.

Select SAP table visible column

Selects the visible table column at the specified column index within a table. Column index 1, represents the first visible column in the table. This action can only be used to select visible columns.

Select SAP table visible row

Selects the visible table row at the specified row index within a table. Row index 1, represents the first visible row in the table. This action can only be used to select visible rows.

Select SAP tree item

Select or deselect a node or item in a SAP tree. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Send enter virtual key

Sends the enter virtual key to an SAP element. Virtual keys can only be sent to a GUI Frame window, for example 'wnd[0]'.

Send SAP command

Inputs and submits a SAP command. This is the same as entering a command or transaction code into the command box.

Send virtual key

Sends a virtual key to an SAP element. Virtual keys can only be sent to a GUI Frame window, for example 'wnd[0]'.

Set SAP grid view current cell

Sets the current cell in a grid view to the cell at the specified row and column. Row index 1 represents the top row of cells in the grid view.

Set SAP grid view current column

Sets the current column within a grid view. The current row will remain unchanged.

Set SAP grid view current row index

Sets the current row index within a grid view. The current column will remain unchanged.

Set SAP grid view first visible column

Scrolls a SAP grid view until the specified column is the first visible column.

Set SAP grid view first visible row index

Scrolls a SAP grid view until the specified row index (starting at 1) is the first visible row. If you set a row index higher than the number of rows in the grid view then it will scroll down as far as possible.

Set SAP tree column width

Set the width (in pixels) of a SAP tree column. The specific column can be searched using one of either the column name or column title. The column name or title values can be determined by using the action 'Get SAP tree column headers'.

Visualise SAP element

Tells the SAP GUI to draw a red rectangle around the element. This is a built-in SAP feature and not the same as asking IA-Connect to display a highlighting rectangle. The element will remain visualised until it is interacted with.

Wait for attached SAP session not busy

Waits for the attached SAP session to report that it is no longer busy.

Wait for SAP element

Waits for an SAP element (typically an individual element within a window such as a button or a text input area) to exist.

Wait for SAP window

Waits for a SAP window with the specified title.

Write to SAP table visible text cell

Writes to a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to set the contents of visible cells.

Attach to SAP session

Attaches IA-Connect to an open SAP session. This action can be used to switch control to any new SAP sessions that are opened within an existing connection.

Parameters

Name Key Required Type Description
Search SAP connection name
SearchConnectionName string

The name of the SAP connection to connect to. If you are unsure of the connection name, this can be returned from the action 'Get SAP sessions'.

Search SAP session name
SearchSessionName string

The name of the SAP session to connect to. If you are unsure of the session name, this can be returned from the action 'Get SAP sessions'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Attached connection name
AttachedConnectionName string

The name of the connection that was attached to.

Attached session name
AttachedSessionName string

The name of the session that was attached to.

Attach to SAPGUI instance

Attaches to an instance of SAP GUI which is already running. This is the first step towards automating SAP GUI if SAP GUI was already running.

Parameters

Name Key Required Type Description
SAPGUI prog Id
SAPProgId string

The SAP program ID. This defaults to 'SAPGUI' and should only be changed if advised by your SAP administrator.

Disable system messages
DisableSystemMessages boolean

Should system messages be disabled? These are typically sent by the SAP administrator and create additional popup dialogs so therefore should be disabled for automation.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of SAP connections
NumberOfSAPConnections integer

Returns the number of SAP connections that are currently open.

SAPGUI major version
SAPGUIMajorVersion integer

The SAPGUI major version, for example 7400.

SAPGUI revision
SAPGUIRevision integer

The SAPGUI revision, for example 3.

SAPGUI patch level
SAPGUIPatchLevel integer

The SAPGUI patch level, for example 11.

SAPGUI minor version
SAPGUIMinorVersion integer

The SAPGUI minor version, for example 257.

SAPGUI using new visual design
SAPGUINewVisualDesign boolean

Returns true if SAPGUI is using the new visual design, or false if not.

Bring SAP window to the front

Brings a SAP window to the front.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Detect parent window element
DetectParentWindowElement boolean

If set to true and a SAP ID for an element is provided (for example a text box or button) then the associated SAP window will be automatically detected and the command will be sent to the window. If set to False then the SAP window element Id itself must be specified (for example 'wnd[0]') or an exception will be raised.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Check SAP element

Sets the state of an SAP element (typically a checkbox or radio box) to either checked or unchecked.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Check element
CheckElement boolean

Should the element be checked (true) or unchecked (false)?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Check SAP grid view cell checkbox

Check or uncheck a checkbox in a grid view cell at the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Check cell element
CheckCellElement boolean

If set to true then the grid view cell will be checked. If set to false, it will be unchecked.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Check SAP table visible checkbox cell

Check or uncheck a checkbox in a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to check or uncheck visible cells.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Visible row index
VisibleRowIndex integer

The row index of the visible table cell, starting from 1.

Visible column index
VisibleColumnIndex integer

The column index of the visible table cell, starting from 1.

Check cell element
CheckCellElement boolean

If set to true, the visible table cell will be checked. If set to false, it will be unchecked.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Check SAP tree item

Checks a SAP tree item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search node key
SearchNodeKey string

The key of the node to be clicked. If you have provided a value for the key, you do not need to provide a value for the path or text.

Search node path
SearchNodePath string

The path of the node to be clicked. If you have provided a value for the path, you do not need to provide a value for the key or text.

Search node text
SearchNodeText string

The text of the node to be clicked. If you have provided a value for the text, you do not need to provide a value for the path or key.

Search node text is regular expression
SearchNodeTextIsRegularExpression boolean

If set to true, the search node text is treated as a regular expression. For example, ^S for a node that starts with S or P$ for a node that ends with P. If set to false (the default), the search node text is treated as an exact match.

Search node text is case sensitive
SearchNodeTextIsCaseSensitive boolean

Should the node text search be case sensitive?

Search column name
SearchColumnName string

The internal name of the column that the node or item is within. If you have provided a column name, the column title is not required. This can be determined by using the action 'Get SAP tree column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the node or item is within. If you have provided a column title, the column name is not required. This can be determined by using the action 'Get SAP tree column headers' and provide the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Check item
CheckItem boolean

If set to true then the tree node or item will be checked. If set to false, it will be unchecked.

Force
Force boolean

If the tree item is not a checkbox or radio button then the IA-Connect Agent will not attempt to check it. If you wish to attempt to check the element anyway, this should be set to True.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Clicks a link on a SAP tree item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search node key
SearchNodeKey string

The key of the node to be clicked. If you have provided a value for the key, you do not need to provide a value for the path or text.

Search node path
SearchNodePath string

The path of the node to be clicked. If you have provided a value for the path, you do not need to provide a value for the key or text.

Search node text
SearchNodeText string

The text of the node to be clicked. If you have provided a value for the text, you do not need to provide a value for the path or key.

Search node text is regular expression
SearchNodeTextIsRegularExpression boolean

If set to true, the search node text is treated as a regular expression. For example, ^S for a node that starts with S or P$ for a node that ends with P. If set to false (the default), the search node text is treated as an exact match.

Search node text is case sensitive
SearchNodeTextIsCaseSensitive boolean

Should the node text search be case sensitive?

Search column name
SearchColumnName string

The internal name of the column that the node or item is within. If you have provided a column name, the column title is not required. This can be determined by using the action 'Get SAP tree column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the node or item is within. If you have provided a column title, the column name is not required. This can be determined by using the action 'Get SAP tree column headers' and provide the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Force
Force boolean

If the tree item is not a clickable link then the IA-Connect Agent will not attempt to click it. If you wish to attempt to click the element anyway, this should be set to True.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Click SAP grid view cell

Clicks a grid view cell in the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Close SAP session

Closes an open SAP session.

Parameters

Name Key Required Type Description
Close attached session
CloseAttachedSession boolean

If set to true then the session that IA-Connect is currently attached to will be closed, as opposed to searching for a specific session.

Search SAP connection name
SearchConnectionName string

The name of the SAP connection containing the session to close to (or leave blank to close a session in the first connection).

Search SAP session name
SearchSessionName string

The name of the SAP session to close (or leave blank to close the first session). As sessions are contained within connections, the SAP connection must have been found.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Close SAP window

Closes an SAP window.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Detect parent window element
DetectParentWindowElement boolean

If set to true and a SAP ID for an element is provided (for example a text box or button) then the associated SAP window will be automatically detected and the command will be sent to the window. If set to False then the SAP window element Id itself must be specified (for example 'wnd[0]') or an exception will be raised.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Deselect all on SAP grid view

Deselects everything in a SAP grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Deselect all SAP tree nodes

Deselect all nodes in a SAP tree.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Detach from SAPGUI

Detaches IA-Connect from the running instance of SAPGUI.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Double click SAP grid view cell

Double clicks a grid view cell in the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Double click SAP tree item

Double clicks a node or item in a SAP tree. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search node key
SearchNodeKey string

The key of the node to be clicked. If you have provided a value for the key, you do not need to provide a value for the path or text.

Search node path
SearchNodePath string

The path of the node to be clicked. If you have provided a value for the path, you do not need to provide a value for the key or text.

Search node text
SearchNodeText string

The text of the node to be clicked. If you have provided a value for the text, you do not need to provide a value for the path or key.

Search node text is regular expression
SearchNodeTextIsRegularExpression boolean

If set to true, the search node text is treated as a regular expression. For example, ^S for a node that starts with S or P$ for a node that ends with P. If set to false (the default), the search node text is treated as an exact match.

Search node text is case sensitive
SearchNodeTextIsCaseSensitive boolean

Should the node text search be case sensitive?

Search column name
SearchColumnName string

The optional internal name of the column that the item is within. This can be determined by using the action 'Get SAP tree column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The optional title of the column that the item is within. This can be determined by using the action 'Get SAP tree column headers' and provide the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Draw rectangle around SAP element

Draws a rectangle around the perimeter of an SAP element to aid in identifying that the element found is the one required. The rectangle is automatically removed after 5 seconds.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Pen colour
PenColour string

The colour of the rectangle to be drawn (e.g. red, green, blue, yellow, purple or orange) or a string hex code e.g. #FF0000.

Pen thickness pixels
PenThicknessPixels integer

The thickness (in pixels) of the highlight rectangle border.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Draw rectangle around SAP grid view cell

Draws a rectangle around the perimeter of an SAP grid view cell to aid in identifying that the cell found is the one required. The rectangle is automatically removed after 5 seconds.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Pen colour
PenColour string

The colour of the rectangle to be drawn (e.g. red, green, blue, yellow, purple or orange) or a string hex code e.g. #FF0000.

Pen thickness pixels
PenThicknessPixels integer

The thickness (in pixels) of the highlight rectangle border.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Enable SAP scripting

Enables SAP scripting in the SAP GUI. This setting must also be enabled on the SAP server by setting the 'sapgui/user_scripting' parameter value to TRUE.

Parameters

Name Key Required Type Description
Notify when script attaches to GUI
NotifyWhenScriptAttachesToGUI boolean

Should SAPGUI notify the user when a script attaches to the GUI? This presents a popup box and therefore should be disabled for automation.

Notify when script opens connection
NotifyWhenScriptOpensConnection boolean

Should SAPGUI notify the user when a script attaches to the GUI? This presents a popup box and therefore should be disabled for automation.

Show native windows dialogs
ShowNativeWindowsDialogs boolean

Should native Windows dialogs be displayed (e.g. Save As, Open) rather than the replacement SAP dialogs?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Enter SAP T-code

Enters an SAP transaction code (T-code). This is the same as entering a T-code into the SAP command box.

Parameters

Name Key Required Type Description
SAP T-code
SAPTCode True string

The SAP transaction code (T-code) to be sent, for example 'SLICENSE'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Expand SAP tree node

Expands or collapses a node in a SAP tree. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search node key
SearchNodeKey string

The key of the node to be clicked. If you have provided a value for the key, you do not need to provide a value for the path or text.

Search node path
SearchNodePath string

The path of the node to be clicked. If you have provided a value for the path, you do not need to provide a value for the key or text.

Search node text
SearchNodeText string

The text of the node to be clicked. If you have provided a value for the text, you do not need to provide a value for the path or key.

Search node text is regular expression
SearchNodeTextIsRegularExpression boolean

If set to true, the search node text is treated as a regular expression. For example, ^S for a node that starts with S or P$ for a node that ends with P. If set to false (the default), the search node text is treated as an exact match.

Search node text is case sensitive
SearchNodeTextIsCaseSensitive boolean

Should the node text search be case sensitive?

Expand
Expand boolean

If set to true then the tree node or item will be expanded. If set to false, it will be collapsed.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Focus SAP calendar date

Focusses the specified calendar date (YYYYMMDD) in a SAP calendar element.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Date
DateYYYYMMDD True string

The date to be focussed, in the format YYYYMMDD.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Focus SAP element

Focusses an SAP element which makes it the active element for keyboard focus and brings the SAP window to the foreground.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Get all SAP child element properties

Returns all properties of all SAP child elements. This can be useful if you are uncertain which field holds the property values required.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

First item to return
FirstItemToReturn integer

The element index of the first item to return, starting from 1. If you wish to return the elements in the reverse order (from the bottom of the tree), you can alternatively specify a negative index starting from -1. For example, an index of -10 would return the tenth item from the bottom.

Max items to return
MaxItemsToReturn integer

The maximum number of child elements to return. This parameter can be used to return large sets of elements in smaller chunks, for example large tables. Instead of attempting to return the entire table which may cause a timeout for extremely large tables, you could instead return 500 rows at a time.

Search SAP element type
SearchSAPElementType string

The type of SAP element to search for (for example, GuiButton) or leave blank for all element types.

Max text length
MaxTextLength integer

The maximum length of any text field. Setting a maximum value can increase search speed as some properties can contain large amounts of text. By default, there is no maximum text length so full values will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of child elements returned
NumberOfChildElementsReturned integer

The number of child elements returned.

More elements available
MoreElementsAvailableAtCurrentDepth boolean

Returns true if there were more child elements available but the inputs 'First item to return' or 'Max items to return' limited the search results.

SAP child elements JSON
SAPChildElementsJSON string

A list of all located child elements (and their properties), in JSON format.

Get attached session properties

Returns information about the SAP session that IA-Connect is attached to.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Connected to session
ConnectedToSession boolean

Returns true if IA-Connect is currently connected to an SAP session.

Session connection error
SessionError string

Returns any error messages reported by the SAP session.

Session name
SessionName string

The name of the session IA-Connect is connected to.

Session system name
SessionSystemName string

The name of the system that the currently connected session is connected to, for example NPL.

Session is busy
Busy boolean

Returns true if the SAP session is reporting that it is currently busy.

Session number
SessionNumber integer

The SAP session number.

Logged in user
LoggedInUser string

The username of the logged in user.

Screen number
ScreenNumber integer

The SAP screen number.

Active transaction
ActiveTransaction string

The name of the active transaction if one is currently running.

Get SAP element at screen coordinate

If a SAP element exists at the specified coordinates, this action will identify the element and return the element ID.

Parameters

Name Key Required Type Description
X
ScreenX True integer

The screen X coordinate in pixels to locate the SAP element at.

Y
ScreenY True integer

The screen Y coordinate in pixels to locate the SAP element at.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
SAP element Id
SAPElementId string

The SAP element ID of the element, if one was found at the specified coordinates. This element ID can be used as an input to many other SAP actions.

Get SAP element properties

Returns all properties of an SAP element. This can be useful if you are uncertain which field holds the property values required.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element type
SAPElementType string

The SAP type of the element, for example 'GuiTextField'.

Element type code
SAPElementTypeCode integer

The SAP type code, for example 31 for 'GuiTextField'.

Element name
SAPElementName string

The SAP name of the element.

Element Id
SAPElementId string

The SAP ID of the element.

Element sub type
SAPElementSubType string

The SAP sub type of the element. This is dependant on the element type and some elements may not have a sub type.

Element text value
SAPElementTextValue string

The text value of the SAP element.

Element is container
SAPElementIsContainer boolean

Returns true if the element is a container (for example a GuiMainWindow or GuiUserArea), or false if not.

Number of children
SAPElementNumberOfChildren integer

The number of child elements, if the element is a container.

Element is changeable
SAPElementIsChangeable boolean

Returns true if the element is changeable or false if not.

Element is modified
SAPElementIsModified boolean

Returns true if the element has been modified or false if not.

Element is selected
SAPElementIsSelected boolean

Returns true if the element is currently selected (e.g. for radio buttons or checkboxes) or false if not.

Element is highlighted
SAPElementIsHighlighted boolean

Returns true if the element is currently highlighted (e.g. for labels or text boxes) or false if not.

Element is visible
SAPElementIsVisible boolean

Returns true if the element is currently visible or false if not.

Element left edge
SAPElementLeftEdge integer

The distance in pixels between the left edge of the element or window and the left edge of the display.

Element top edge
SAPElementTopEdge integer

The distance in pixels between the top edge of the element or window and the top edge of the display.

Element width
SAPElementWidth integer

The width of the element in pixels.

Element height
SAPElementHeight integer

The height of the element in pixels.

Element right edge
SAPElementRightEdge integer

The distance in pixels between the right edge of the element or window and the right edge of the display.

Element bottom edge
SAPElementBottomEdge integer

The distance in pixels between the bottom edge of the element or window and the bottom edge of the display.

Get SAP element properties as collection

Returns the properties of an SAP element as a single line list (single line collection / data table) instead of individual items, this maybe useful depending on how you intend to use the data.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Max text length
MaxTextLength integer

The SAP element text property could potentially be very long, so this option allows you to limit the maximum size which will be returned (and the field 'ElementTextTrimmed' will inform you if the text was trimmed). By default, this value is 0 which does not limit the maximum size.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of elements returned
NumberOfElementsReturned integer

The number of elements returned.

SAP element properties JSON
SAPElementsJSON string

The SAP properties of the element, in JSON format.

Get SAP element text value

Returns the text value of an SAP element. A text value is usually associated with a text element, but many elements can have this property.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element text value
SAPElementTextValue string

The text value of the element.

Get SAP grid view cell contents

Gets the contents of a grid view cell in the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Cell text contents
CellTextContents string

The text contents of the cell.

Cell is changeable
CellIsChangeable boolean

Returns true if the cell contents can be changed or false if not.

Cell type
CellType string

The type of the cell.

Cell is checked
CellIsChecked boolean

Returns true if the cell is checked or false if not.

Get SAP grid view cell properties

Returns all properties of a grid view cell in the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Cell text contents
CellTextContents string

The text contents of the cell.

Cell is changeable
CellIsChangeable boolean

Returns true if the cell contents can be changed or false if not.

Cell type
CellType string

The type of the cell.

Cell is checked
CellIsChecked boolean

Returns true if the cell is checked or false if not.

Cell is visible
CellIsVisible boolean

Returns true if the cell is currently visible or false if not.

Cell left edge
LeftEdge integer

The distance in pixels between the left edge of the cell and the left edge of the display.

Cell top edge
TopEdge integer

The distance in pixels between the top edge of the cell and the top edge of the display.

Cell right edge
RightEdge integer

The distance in pixels between the right edge of the cell and the left edge of the display.

Cell bottom edge
BottomEdge integer

The distance in pixels between the bottom edge of the cell and the top edge of the display.

Cell width
Width integer

The width of the cell in pixels.

Cell height
Height integer

The height of the cell in pixels.

Cell clickable point X
ClickablePointX integer

The X coordinate of the centre of the cell.

Cell clickable point Y
ClickablePointY integer

The Y coordinate of the centre of the cell.

Cell state
CellState string

The cell state.

Cell colour
CellColour integer

The cell colour.

Cell colour info
CellColourInfo string

The cell colour represented as hex.

Cell is link
CellIsLink boolean

Returns true if the cell is a link or false if not.

Get SAP grid view column headers

Returns a list of column headers in a grid view. The name or title of the column headers can be used for the 'Search column name' or 'Search column title' input in many SAP grid view actions.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
SAP grid view column headers JSON
SAPGridViewColumnHeadersJSON string

A list of all column headers in the grid view, in JSON format.

Number of column headers
NumberOfColumnHeaders integer

The number of column headers in the grid view.

Get SAP grid view properties

Returns the properties of an SAP grid view element. This is an element with an element type of 'GridView'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of rows
NumberOfRows integer

The number of rows in the gridview.

Number of visible rows
NumberOfVisibleRows integer

The number of visible rows in the grid view.

First visible row index
FirstVisibleRowIndex integer

The index of the first visible row in the grid view.

Current cell row index
CurrentCellRowIndex integer

The row index of the currently selected cell in the grid view.

Number of columns
NumberOfColumns integer

The number of columns in the grid view.

First visible column name
FirstVisibleColumnName string

The internal name of the first visible column in the grid view.

Current cell column name
CurrentCellColumnName string

The internal column name of the currently selected cell in the grid view.

Number of frozen columns
NumberOfFrozenColumns integer

The number of columns that are frozen in the grid view.

Number of toolbar buttons
NumberOfToolbarButtons integer

The number of toolbar buttons in the gridview.

Selection mode
SelectionMode string

The selection mode of the grid view, for example RowsAndColumns.

Grid view title
GridViewTitle string

The title of the grid view. Some grid view elements may not have a title.

Get SAP grid view text contents

Returns all the text contents of a SAP grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

First row to return
FirstRowToReturn integer

The row index of the first grid view row to return, starting from 1.

Max rows to return
MaxRowsToReturn integer

The maximum number of rows to return, or 0 to return all rows.

First search column name
FirstSearchColumnName string

The internal name of the first column to read from. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

First search column title
FirstSearchColumnTitle string

The title of the first column to read from. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
FirstSearchColumnTitleIsRegularExpression boolean

If set to true, the first search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
FirstSearchColumnTitleIsCaseSensitive boolean

Should the first column title search be case sensitive?

Max columns to return
MaxColumnsToReturn integer

The maximum number of columns to return, or 0 to return all columns.

Use column headers from grid view
UseColumnHeadersFromTable boolean

If set to true then the IA-Connect Agent will attempt to setup the returned columns to match the column names in the SAP grid view.

Return row index in output collection
ReturnRowIndexInOutputCollection boolean

If set to true then the IA-Connect Agent will return the row index in the output collection as an additional column. This is useful if you plan to filter the data since you will be able to track which row this originally came from. By default, the column name for the row index will be 'Row_index' but you can change it by providing an alternative value in the input 'Name of column to store row index'.

Name of column to store row index
NameOfColumnToStoreRowIndex string

If 'Return row index in output collection' is set to true then you can override the default column name of '_Row_Index' by providing an alternative value here.

Checked element value
CheckedElementValue string

For GuiRadioBox or GuiCheckBox elements contained within the grid view, what value should be returned if they are selected / checked? By default, this is 'True' (as text).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
SAP grid view text contents JSON
SAPGridViewTextContentsJSON string

The text contents of all the cells in the grid view, in JSON format.

Number of rows returned
NumberOfRowsReturned integer

The number of rows returned. This may be limited by the 'First visible row to return' or 'Max rows to return' inputs.

Number of columns returned
NumberOfColumnsReturned integer

The number of columns returned. This may be limited by the 'First visible column to return' or 'Max columns to return' inputs.

Get SAP parent element Id

Returns the SAP element Id of the parent element of an SAP element.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
SAP parent element Id
SAPParentElementId string

The SAP element ID of the parent element.

SAP parent element type
SAPParentElementType string

The SAP type of the parent element, for example 'GuiMainWindow'.

SAP parent element type code
SAPParentElementTypeCode integer

The SAP type code of the parent element, for example 21 for 'GuiMainWindow'.

Get SAP selection list items

Returns a list of child element items found under the specified SAP element (typically dropdown / menu items).

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of items in list
NumberOfItemsInList integer

The number of items in the list.

Selection list items JSON
SAPSelectionListItemsJSON string

The properties of the selection list items, in JSON format.

Currently selected value
CurrentlySelectedValue string

The value of the currently selected item.

Currently selected key
CurrentlySelectedKey string

The key of the currently selected item.

Value required
ValueRequired boolean

Returns true if a value must be selected, or false if not.

Get SAP session top level element properties

Returns the properties of the SAP element at the top-level of the active SAP session, typically the GuiMainWindow element.

Parameters

Name Key Required Type Description
First item to return
FirstItemToReturn integer

The element index of the first item to return, starting from 1. If you wish to return the elements in the reverse order (from the bottom of the tree), you can alternatively specify a negative index starting from -1. For example, an index of -10 would return the tenth item from the bottom.

Max items to return
MaxItemsToReturn integer

The maximum number of child elements to return. This parameter can be used to return large sets of elements in smaller chunks, for example large tables. Instead of attempting to return the entire table which may cause a timeout for extremely large tables, you could instead return 500 rows at a time.

Search SAP element type
SearchSAPElementType string

The type of SAP element to search for (for example, GuiButton) or leave blank for all element types.

Max text length
MaxTextLength integer

The maximum length of any text field. Setting a maximum value can increase search speed as some properties can contain large amounts of text. By default, there is no maximum text length so full values will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of top level elements returned
NumberOfChildElementsReturned integer

The number of top level elements returned.

More elements available
MoreElementsAvailableAtCurrentDepth boolean

Returns true if there were more top level elements available but the inputs 'First item to return' or 'Max items to return' limited the search results.

SAP top level elements JSON
SAPChildElementsJSON string

A list of all top level elements (and their properties), in JSON format.

Get SAP sessions

Returns a list of running SAP sessions. This information is useful if you wish to attach to an existing SAP connection / session but you don't know which ones are available.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of SAP connections
NumberOfSAPConnections integer

Returns the number of SAP connections that are currently open.

SAP connections JSON
SAPConnectionsJSON string

The properties of the open SAP connections, in JSON format. This list will contain properties such as the connection name, the connection description and the number of sessions that are currently open in the connection.

Number of SAP sessions
NumberOfSAPSessions integer

Returns the number of SAP sessions that are currently open. It is possible for a single SAP connection to have multiple sessions, for example if the active SAP connection opens a second session.

SAP sessions JSON
SAPSessionsJSON string

The properties of the open SAP sessions, in JSON format. This list will contain many properties such as the session name, the connection name that owns the session and the name of the user.

Get SAP shell toolbar elements

Returns a list of elements (usually buttons) in a GuiShell toolbar.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of toolbar buttons
NumberOfToolbarButtons integer

The number of buttons in the toolbar.

SAP toolbar elements JSON
SAPShellToolbarElementsJSON string

A list of all elements in the toolbar, in JSON format.

Get SAP table properties

Returns the properties of an SAP table element. This is an element with an element type of 'GuiTableControl'. For gridview elements (these are similar to tables but provide additional functionality via a built-in toolbar), use the alternative action 'Get SAP grid view properties'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of visible rows
NumberOfVisibleRows integer

The number of visible rows in the table.

Number of visible columns
NumberOfVisibleColumns integer

The number of visible columns in the table.

Vertical scrollbar minimum
VerticalScrollbarMinimum integer

The minimum value of the vertical scrollbar.

Vertical scrollbar maximum
VerticalScrollbarMaximum integer

The maximum value of the vertical scrollbar.

Vertical scrollbar position
VerticalScrollbarPosition integer

The current position of the vertical scrollbar.

Vertical scrollbar page size
VerticalScrollbarPageSize integer

The page size of the vertical scrollbar.

Estimated number of rows
EstimatedNumberOfRows integer

The estimated number of rows in the table, including rows that are not currently visible.

Horizontal scrollbar minimum
HorizontalScrollbarMinimum integer

The minimum value of the horizontal scrollbar.

Horizontal scrollbar maximum
HorizontalScrollbarMaximum integer

The maximum value of the horizontal scrollbar.

Horizontal scrollbar position
HorizontalScrollbarPosition integer

The current position of the horizontal scrollbar.

Horizontal scrollbar page size
HorizontalScrollbarPageSize integer

The page size of the horizontal scrollbar.

Estimated number of columns
EstimatedNumberOfColumns integer

The estimated number of columns in the table, including rows that are not currently visible.

Row selection mode
RowSelectMode string

The current row selection mode, for example 'No selection' or 'Single selection'.

Column selection mode
ColumnSelectMode string

The current column selection mode, for example 'No selection' or 'Single selection'.

Get SAP table visible cell properties

Returns all properties of a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to retrieve the properties of visible cells.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Visible row index
VisibleRowIndex integer

The row index of the visible table cell, starting from 1.

Visible column index
VisibleColumnIndex integer

The column index of the visible table cell, starting from 1.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element type
SAPElementType string

The SAP type of the element, for example 'GuiTextField'.

Element type code
SAPElementTypeCode integer

The SAP type code, for example 31 for 'GuiMainWindow'.

Element name
SAPElementName string

The SAP name of the element.

Element Id
SAPElementId string

The SAP ID of the element.

Element sub type
SAPElementSubType string

The SAP sub type of the element. This is dependant on the element type and some elements may not have a sub type.

Element text value
SAPElementTextValue string

The text value of the SAP element.

Element is container
SAPElementIsContainer boolean

Returns true if the element is a container (for example a GuiMainWindow or GuiUserArea), or false if not.

Number of children
SAPElementNumberOfChildren integer

The number of child elements, if the element is a container.

Element is changeable
SAPElementIsChangeable boolean

Returns true if the element is changeable or false if not.

Element is modified
SAPElementIsModified boolean

Returns true if the element has been modified or false if not.

Element is selected
SAPElementIsSelected boolean

Returns true if the element is currently selected (e.g. for radio buttons or checkboxes) or false if not.

Element is highlighted
SAPElementIsHighlighted boolean

Returns true if the element is currently highlighted (e.g. for labels or text boxes) or false if not.

Element is visible
SAPElementIsVisible boolean

Returns true if the element is currently visible or false if not.

Element left edge
SAPElementLeftEdge integer

The distance in pixels between the left edge of the element or window and the left edge of the display.

Element top edge
SAPElementTopEdge integer

The distance in pixels between the top edge of the element or window and the top edge of the display.

Element width
SAPElementWidth integer

The width of the element in pixels.

Element height
SAPElementHeight integer

The height of the element in pixels.

Element right edge
SAPElementRightEdge integer

The distance in pixels between the right edge of the element or window and the left edge of the display.

Element bottom edge
SAPElementBottomEdge integer

The distance in pixels between the bottom edge of the element or window and the top edge of the display.

Cell column name
CellColumnName string

The name of the column which contains the visible cell.

Horizontal scrollbar position
HorizontalScrollbarPosition integer

The current position of the horizontal scrollbar.

Vertical scrollbar position
VerticalScrollbarPosition integer

The current position of the vertical scrollbar.

Estimated actual row index
EstimatedActualRowIndex integer

The estimated actual row index in the table, including rows that are not currently visible.

Estimated actual column index
EstimatedActualColumnIndex integer

The estimated actual colmun index in the table, including columns that are not currently visible.

Get SAP table visible cell text contents

Gets the contents of a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to retrieve the contents of visible cells.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Visible row index
VisibleRowIndex integer

The row index of the visible table cell, starting from 1.

Visible column index
VisibleColumnIndex integer

The column index of the visible table cell, starting from 1.

Checked element value
CheckedElementValue string

For GuiRadioBox or GuiCheckBox elements contained within a table, what value should be returned if they are selected / checked? By default, this is 'True' (as text).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Cell text contents
CellTextContents string

The contents of the visible cell.

Cell column name
CellColumnName string

The name of the column which contains the visible cell.

Horizontal scrollbar position
HorizontalScrollbarPosition integer

The current position of the horizontal scrollbar.

Vertical scrollbar position
VerticalScrollbarPosition integer

The current position of the vertical scrollbar.

Estimated actual row index
EstimatedActualRowIndex integer

The estimated actual row index in the table, including rows that are not currently visible.

Estimated actual column index
EstimatedActualColumnIndex integer

The estimated actual colmun index in the table, including columns that are not currently visible.

Get SAP table visible text contents

Gets the contents of all visible table cells within a table. This action can only be used to retrieve the contents of visible cells.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

First visible row to return
FirstVisibleRowToReturn integer

The row index of the first visible table row to return, starting from 1.

Max rows to return
MaxRowsToReturn integer

The maximum number of rows to return, or 0 to return all rows.

First visible column to return
FirstVisibleColumnToReturn integer

The column index of the first visible table column to return, starting from 1.

Max columns to return
MaxColumnsToReturn integer

The maximum number of columns to return, or 0 to return all columns.

Use column headers from table
UseColumnHeadersFromTable boolean

If set to true then the IA-Connect Agent will attempt to setup the returned table columns to match the column names in the SAP table.

Return row index in output collection
ReturnRowIndexInOutputCollection boolean

If set to true then the IA-Connect Agent will return the row index in the output collection as an additional column. This is useful if you plan to filter the data since you will be able to track which row this originally came from. By default, the column name for the row index will be 'Row_index' but you can change it by providing an alternative value in the input 'Name of column to store row index'.

Name of column to store row index
NameOfColumnToStoreRowIndex string

If 'Return row index in output collection' is set to true then you can override the default column name of '_Row_Index' by providing an alternative value here.

Checked element value
CheckedElementValue string

For GuiRadioBox or GuiCheckBox elements contained within a table, what value should be returned if they are selected / checked? By default, this is 'True' (as text).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
SAP table text contents JSON
SAPTableTextContentsJSON string

The text contents of all the visible cells in the table, in JSON format.

Number of rows returned
NumberOfRowsReturned integer

The number of rows returned. This may be limited by the 'First visible row to return' or 'Max rows to return' inputs.

Number of columns returned
NumberOfColumnsReturned integer

The number of columns returned. This may be limited by the 'First visible column to return' or 'Max columns to return' inputs.

Get SAP tree column headers

Returns a list of column headers in a tree. The name or title of the column headers can be used for the 'Search column name' or 'Search column title' input in many SAP tree actions.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
SAP tree column headers JSON
SAPTreeColumnHeadersJSON string

A list of all tree column headers in the tree, in JSON format.

Number of column headers
NumberOfColumnHeaders integer

The number of column headers in the tree.

Get SAP tree item properties

Returns the properties of a SAP tree item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search node key
SearchNodeKey string

The key of the node to be clicked. If you have provided a value for the key, you do not need to provide a value for the path or text.

Search node path
SearchNodePath string

The path of the node to be clicked. If you have provided a value for the path, you do not need to provide a value for the key or text.

Search node text
SearchNodeText string

The text of the node to be clicked. If you have provided a value for the text, you do not need to provide a value for the path or key.

Search node text is regular expression
SearchNodeTextIsRegularExpression boolean

If set to true, the search node text is treated as a regular expression. For example, ^S for a node that starts with S or P$ for a node that ends with P. If set to false (the default), the search node text is treated as an exact match.

Search node text is case sensitive
SearchNodeTextIsCaseSensitive boolean

Should the node text search be case sensitive?

Search column name
SearchColumnName string

The internal name of the column that the node or item is within. If you have provided a column name, the column title is not required. This can be determined by using the action 'Get SAP tree column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the node or item is within. If you have provided a column title, the column name is not required. This can be determined by using the action 'Get SAP tree column headers' and provide the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Item type
ItemType string

The type of the tree item, for example 'Text'.

Item text value
ItemTextValue string

The text value of the tree item.

Item is enabled
ItemEnabled boolean

Returns true if the tree item is enabled, or false if not.

Item is highlighted
ItemHighlighted boolean

Returns true if the tree item is highlighted, or false if not.

Item is checked
ItemChecked boolean

Returns true if the tree item is checked, or false if not.

Item is visible
ItemVisible boolean

Returns true if the tree item is visible, or false if not.

Item left edge
ItemLeftEdge integer

The distance in pixels between the left edge of the tree item and the left edge of the display.

Item top edge
ItemTopEdge integer

The distance in pixels between the top edge of the tree item and the top edge of the display.

Item width
ItemWidth integer

The width of the tree item in pixels.

Item height
ItemHeight integer

The height of the tree item in pixels.

Item right edge
ItemRightEdge integer

The distance in pixels between the right edge of the tree item and the right edge of the display.

Item bottom edge
ItemBottomEdge integer

The distance in pixels between the bottom edge of the tree item and the bottom edge of the display.

Item text colour hex
ItemTextColourHex string

A hex code representation of the text colour of the tree item.

Item style
ItemStyle integer

The item style code.

Get SAP tree nodes

Returns a list of all nodes in an SAP tree element.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Parent node key
ParentNodeKey string

If specified then the tree will be processed from the specified node key (note that you can obtain node keys by calling this action with a blank parent node key - that will provide the keys at the top-level). If not specified then the top-level of the tree will be processed.

Process sub nodes
ProcessSubNodes boolean

If set to true, all nodes in the tree (including subnodes) will be returned. If set to false, only the top-level nodes will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of tree nodes
NumberOfNodesInTree integer

The number of nodes in the tree.

SAP tree nodes JSON
SAPTreeNodesJSON string

A list of all nodes in the tree, in JSON format.

Number of selected nodes
NumberOfSelectedNodes integer

The number of nodes in the tree.

Currently selected node
CurrentlySelectedNode string

The node key of the currently selected node.

Tree type
TreeType string

The type of tree, Simple (0), List (1) or Column (2).

Tree selection mode
TreeSelectionMode string

The tree selection mode, Single node (0), Multiple node (1), Single item (2) or Multiple item (3).

Get SAP tree text contents

Returns the text contents of all nodes in a SAP tree.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

First row to return
FirstRowToReturn integer

The row index of the first tree item row to return, starting from 1.

Max rows to return
MaxRowsToReturn integer

The maximum number of rows to return, or 0 to return all rows.

First column to return
FirstColumnToReturn integer

The column index of the first tree item column to return, starting from 1.

Max columns to return
MaxColumnsToReturn integer

The maximum number of columns to return, or 0 to return all columns.

Use column headers from tree
UseColumnHeadersFromTree boolean

If set to true then the IA-Connect Agent will attempt to setup the returned table columns to match the column names in the SAP table.

Return row index in output collection
ReturnRowIndexInOutputCollection boolean

If set to true then the IA-Connect Agent will return the row index in the output collection as an additional column. This is useful if you plan to filter the data since you will be able to track which row this originally came from. By default, the column name for the row index will be 'Row_index' but you can change it by providing an alternative value in the input 'Name of column to store row index'.

Name of column to store row index
NameOfColumnToStoreRowIndex string

If 'Return row index in output collection' is set to true then you can override the default column name of '_Row_Index' by providing an alternative value here.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
SAP tree text contents JSON
SAPTreeTextContentsJSON string

The text contents of the tree, in JSON format.

Number of rows returned
NumberOfRowsReturned integer

The number of rows returned. This may be limited by the 'First visible row to return' or 'Max rows to return' inputs.

Number of columns returned
NumberOfColumnsReturned integer

The number of columns returned. This may be limited by the 'First visible column to return' or 'Max columns to return' inputs.

Get SAPGUI attach status

Returns information about the current IA-Connect connection to SAP GUI.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Connected to SAPGUI
Connected boolean

Returns true if IA-Connect is currently connected to SAPGUI.

SAPGUI connection error
ConnectionError string

Returns any error messages reported by SAPGUI.

Number of SAP connections
NumberOfSAPConnections integer

Returns the number of SAP connections that are currently open.

SAPGUI major version
SAPGUIMajorVersion integer

The SAPGUI major version, for example 7400.

SAPGUI revision
SAPGUIRevision integer

The SAPGUI revision, for example 3.

SAPGUI patch level
SAPGUIPatchLevel integer

The SAPGUI patch level, for example 11.

SAPGUI minor version
SAPGUIMinorVersion integer

The SAPGUI minor version, for example 257.

SAPGUI using new visual design
SAPGUINewVisualDesign boolean

Returns true if SAPGUI is using the new visual design, or false if not.

Connected to session
ConnectedToSession boolean

Returns true if IA-Connect is currently connected to an SAP session.

Session connection error
SessionError string

Returns any error messages reported by the SAP session.

Session name
SessionName string

The name of the session IA-Connect is connected to.

Session system name
SessionSystemName string

The name of the system that the currently connected session is connected to, for example NPL.

Global double left click SAP grid view cell

Moves the mouse to the centre of an SAP grid view cell and double clicks the left mouse button.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Set element window topmost
SetElementWindowTopMost boolean

Should IA-Connect set the SAP window containing the element topmost (on top of all other windows) before interacting with it? This helps ensure that no other windows are in front but will not work if using published applications (for example with Citrix) because the topmost setting in the remote session does not impact the local session.

Bring element window to front
BringElementWindowToFront boolean

Should IA-Connect bring the SAP window containing the element to the front before interacting with it? This helps ensure that no other windows are in front.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Click offset X
ClickOffsetX integer

The number of X pixels to offset the click action by. This parameter supports both positive (right) and negative (left) offset values.

Click offset Y
ClickOffsetY integer

The number of Y pixels to offset the click action by. This parameter supports both positive (down) and negative (up) offset values.

Offset relative to
OffsetRelativeTo string

The relative position of the element to offset from (Center / Centre / Middle, Left, Right, Top, Bottom, Top Left, Top Right, Bottom Left, Bottom Right).

Double click delay in milliseconds
DoubleClickDelayInMilliseconds integer

The delay (in milliseconds) between each of the clicks.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global double left mouse click on SAP element

Moves the mouse to the centre of an SAP element and double clicks the left mouse button.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Set element window topmost
SetElementWindowTopMost boolean

Should IA-Connect set the SAP window containing the element topmost (on top of all other windows) before interacting with it? This helps ensure that no other windows are in front but will not work if using published applications (for example with Citrix) because the topmost setting in the remote session does not impact the local session.

Bring element window to front
BringElementWindowToFront boolean

Should IA-Connect bring the SAP window containing the element to the front before interacting with it? This helps ensure that no other windows are in front.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Click offset X
ClickOffsetX integer

The number of X pixels to offset the click action by. This parameter supports both positive (right) and negative (left) offset values.

Click offset Y
ClickOffsetY integer

The number of Y pixels to offset the click action by. This parameter supports both positive (down) and negative (up) offset values.

Offset relative to
OffsetRelativeTo string

The relative position of the element to offset from (Center / Centre / Middle, Left, Right, Top, Bottom, Top Left, Top Right, Bottom Left, Bottom Right).

Double click delay in milliseconds
DoubleClickDelayInMilliseconds integer

The delay (in milliseconds) between each of the clicks.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global input password into SAP element

Moves the mouse to centre of the SAP element, focusses it, left clicks, and presses keys. Typically used with a password input that will not accept native input methods.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Set element window topmost
SetElementWindowTopMost boolean

Should IA-Connect set the SAP window containing the element topmost (on top of all other windows) before interacting with it? This helps ensure that no other windows are in front but will not work if using published applications (for example with Citrix) because the topmost setting in the remote session does not impact the local session.

Bring element window to front
BringElementWindowToFront boolean

Should IA-Connect bring the SAP window containing the element to the front before interacting with it? This helps ensure that no other windows are in front.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Global left mouse click on element
GlobalMouseClickOnElement boolean

Should a global mouse click be performed at the element coordinates (to focus the element) before entering text?

Replace existing value using double mouse click delete
ReplaceExistingValueUsingDoubleClickDelete boolean

Should any existing value be replaced by double clicking the mouse (to highlight it) and then deleting?

Replace existing value using CTRL-A delete
ReplaceExistingValueUsingCTRLADelete boolean

Should any existing value be replaced by pressing Ctrl-A (to highlight all) and then deleting? Some elements may not support highlighting with Ctrl-A in which case the alternative option of 'Replace existing value using double mouse click delete' should be tried.

Password to input
PasswordToInput True password

The password value to global input.

Use send key events
SendKeyEvents boolean

If set to true then send key events (a lower level API which sends simulated keystrokes to the operating system) will be used. If set to false then send keys (a higher level API which sends keystrokes to the focused element) will be used instead.

Key interval in milliseconds
KeyIntervalInMilliseconds integer

The number of milliseconds between each key press.

Double click interval in milliseconds
DoubleClickIntervalInMilliseconds integer

The number of milliseconds between each click if the parameter 'Replace existing value using double mouse click delete' is set to true.

Dont interpret symbols
DontInterpretSymbols boolean

Should symbols in the 'Password to input' not be interpreted as special keys (e.g. + for Shift, ^ for Ctrl)? This should be set to true if you are attempting to input the actual symbols.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global input text into SAP element

Moves the mouse to centre of the SAP element, focusses it, left clicks, and presses keys. Typically used with a text input that will not accept native input methods.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Set element window topmost
SetElementWindowTopMost boolean

Should IA-Connect set the SAP window containing the element topmost (on top of all other windows) before interacting with it? This helps ensure that no other windows are in front but will not work if using published applications (for example with Citrix) because the topmost setting in the remote session does not impact the local session.

Bring element window to front
BringElementWindowToFront boolean

Should IA-Connect bring the SAP window containing the element to the front before interacting with it? This helps ensure that no other windows are in front.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Global left mouse click on element
GlobalMouseClickOnElement boolean

Should a global mouse click be performed at the element coordinates (to focus the element) before entering text?

Replace existing value using double mouse click delete
ReplaceExistingValueUsingDoubleClickDelete boolean

Should any existing value be replaced by double clicking the mouse (to highlight it) and then deleting?

Replace existing value using CTRL-A delete
ReplaceExistingValueUsingCTRLADelete boolean

Should any existing value be replaced by pressing Ctrl-A (to highlight all) and then deleting? Some elements may not support highlighting with Ctrl-A in which case the alternative option of 'Replace existing value using double mouse click delete' should be tried.

Text to input
TextToInput True string

The text value to global input.

Use send key events
SendKeyEvents boolean

If set to true then send key events (a lower level API which sends simulated keystrokes to the operating system) will be used. If set to false then send keys (a higher level API which sends keystrokes to the focused element) will be used instead.

Key interval in milliseconds
KeyIntervalInMilliseconds integer

The number of milliseconds between each key press.

Double click interval in milliseconds
DoubleClickIntervalInMilliseconds integer

The number of milliseconds between each click if the parameter 'Replace existing value using double mouse click delete' is set to true.

Dont interpret symbols
DontInterpretSymbols boolean

Should symbols in the 'Text to input' not be interpreted as special keys (e.g. + for Shift, ^ for Ctrl)? This should be set to true if you are attempting to input the actual symbols.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global left click SAP grid view cell

Moves the mouse to the centre of an SAP grid view cell and clicks the left mouse button.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Set element window topmost
SetElementWindowTopMost boolean

Should IA-Connect set the SAP window containing the element topmost (on top of all other windows) before interacting with it? This helps ensure that no other windows are in front but will not work if using published applications (for example with Citrix) because the topmost setting in the remote session does not impact the local session.

Bring element window to front
BringElementWindowToFront boolean

Should IA-Connect bring the SAP window containing the element to the front before interacting with it? This helps ensure that no other windows are in front.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Click offset X
ClickOffsetX integer

The number of X pixels to offset the click action by. This parameter supports both positive (right) and negative (left) offset values.

Click offset Y
ClickOffsetY integer

The number of Y pixels to offset the click action by. This parameter supports both positive (down) and negative (up) offset values.

Offset relative to
OffsetRelativeTo string

The relative position of the element to offset from (Center / Centre / Middle, Left, Right, Top, Bottom, Top Left, Top Right, Bottom Left, Bottom Right).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global left mouse click on SAP element

Moves the mouse to the centre of an SAP element and clicks the left mouse button.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Set element window topmost
SetElementWindowTopMost boolean

Should IA-Connect set the SAP window containing the element topmost (on top of all other windows) before interacting with it? This helps ensure that no other windows are in front but will not work if using published applications (for example with Citrix) because the topmost setting in the remote session does not impact the local session.

Bring element window to front
BringElementWindowToFront boolean

Should IA-Connect bring the SAP window containing the element to the front before interacting with it? This helps ensure that no other windows are in front.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Click offset X
ClickOffsetX integer

The number of X pixels to offset the click action by. This parameter supports both positive (right) and negative (left) offset values.

Click offset Y
ClickOffsetY integer

The number of Y pixels to offset the click action by. This parameter supports both positive (down) and negative (up) offset values.

Offset relative to
OffsetRelativeTo string

The relative position of the element to offset from (Center / Centre / Middle, Left, Right, Top, Bottom, Top Left, Top Right, Bottom Left, Bottom Right).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global middle mouse click on SAP element

Moves the mouse to the centre of an SAP element and clicks the middle mouse button.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Set element window topmost
SetElementWindowTopMost boolean

Should IA-Connect set the SAP window containing the element topmost (on top of all other windows) before interacting with it? This helps ensure that no other windows are in front but will not work if using published applications (for example with Citrix) because the topmost setting in the remote session does not impact the local session.

Bring element window to front
BringElementWindowToFront boolean

Should IA-Connect bring the SAP window containing the element to the front before interacting with it? This helps ensure that no other windows are in front.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Click offset X
ClickOffsetX integer

The number of X pixels to offset the click action by. This parameter supports both positive (right) and negative (left) offset values.

Click offset Y
ClickOffsetY integer

The number of Y pixels to offset the click action by. This parameter supports both positive (down) and negative (up) offset values.

Offset relative to
OffsetRelativeTo string

The relative position of the element to offset from (Center / Centre / Middle, Left, Right, Top, Bottom, Top Left, Top Right, Bottom Left, Bottom Right).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global right click SAP grid view cell

Moves the mouse to the centre of an SAP grid view cell and clicks the right mouse button.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Set element window topmost
SetElementWindowTopMost boolean

Should IA-Connect set the SAP window containing the element topmost (on top of all other windows) before interacting with it? This helps ensure that no other windows are in front but will not work if using published applications (for example with Citrix) because the topmost setting in the remote session does not impact the local session.

Bring element window to front
BringElementWindowToFront boolean

Should IA-Connect bring the SAP window containing the element to the front before interacting with it? This helps ensure that no other windows are in front.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Click offset X
ClickOffsetX integer

The number of X pixels to offset the click action by. This parameter supports both positive (right) and negative (left) offset values.

Click offset Y
ClickOffsetY integer

The number of Y pixels to offset the click action by. This parameter supports both positive (down) and negative (up) offset values.

Offset relative to
OffsetRelativeTo string

The relative position of the element to offset from (Center / Centre / Middle, Left, Right, Top, Bottom, Top Left, Top Right, Bottom Left, Bottom Right).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global right mouse click on SAP element

Moves the mouse to the centre of an SAP element and clicks the right mouse button.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Set element window topmost
SetElementWindowTopMost boolean

Should IA-Connect set the SAP window containing the element topmost (on top of all other windows) before interacting with it? This helps ensure that no other windows are in front but will not work if using published applications (for example with Citrix) because the topmost setting in the remote session does not impact the local session.

Bring element window to front
BringElementWindowToFront boolean

Should IA-Connect bring the SAP window containing the element to the front before interacting with it? This helps ensure that no other windows are in front.

Toggle window
ToggleWindow boolean

Should the window be toggled by attempting to focus or click it? This helps to ensure that the window is reliably brought to the foreground.

Toggle uses global left mouse click agent
ToggleUsesGlobalLeftMouseClickAgent boolean

If choosing to toggle the window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.

Toggle delay in seconds
ToggleDelay double

If choosing to toggle the window, this specifies the pause after toggling.

Click offset X
ClickOffsetX integer

The number of X pixels to offset the click action by. This parameter supports both positive (right) and negative (left) offset values.

Click offset Y
ClickOffsetY integer

The number of Y pixels to offset the click action by. This parameter supports both positive (down) and negative (up) offset values.

Offset relative to
OffsetRelativeTo string

The relative position of the element to offset from (Center / Centre / Middle, Left, Right, Top, Bottom, Top Left, Top Right, Bottom Left, Bottom Right).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Input password into SAP element

Inputs a password into an SAP element (typically a password entry field).

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Password to input
PasswordToInput True password

The password value to input.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Input text into SAP element

Inputs text into an SAP element (typically a text entry field), either replacing the existing text or inserting the new value at a specific position.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Text to input
TextToInput True string

The text value to input.

Replace existing value
ReplaceExistingValue boolean

If there is existing text in the element, should this be replaced?

Insert position
InsertPosition integer

The position (index) to begin inserting text. If there is existing text, the insert position can be used to insert at a specific position within the existing text.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Launch SAPGUI

Enables SAP scripting and launches SAP GUI. This is the first step towards automating SAP GUI if it was not already running.

Parameters

Name Key Required Type Description
SAPLogon EXE
SAPLogonEXE string

The full path to SAPLogon.exe. If left blank, IA-Connect will attempt to detect it automatically.

SAPLogon arguments
SAPLogonArguments string

Provide any optional command-line arguments for SAPLogon.exe here, if required.

Enable SAP scripting
EnableSAPScripting boolean

Should SAP scripting be enabled? If set to true (the default), SAP scripting will be enabled. If set to false, the current SAP scripting setting will be used.

Notify when script attaches to GUI
NotifyWhenScriptAttachesToGUI boolean

Should SAPGUI notify the user when a script attaches to the GUI? This presents a popup box and therefore should be disabled for automation.

Notify when script opens connection
NotifyWhenScriptOpensConnection boolean

Should SAPGUI notify the user when a script attaches to the GUI? This presents a popup box and therefore should be disabled for automation.

Show native windows dialogs
ShowNativeWindowsDialogs boolean

Should native Windows dialogs be displayed (e.g. Save As, Open) rather than the replacement SAP dialogs?

Attach after launch
AttachAfterLaunch boolean

Should IA-Connect attempt to attach to SAPGUI automatically? By default, this is set to true.

Seconds to wait
SecondsToWait double

The number of seconds that IA-Connect will wait for SAPGUI to launch before attempting to attach to it.

SAPGUI prog Id
SAPProgId string

The SAP program ID. This defaults to 'SAPGUI' and should only be changed if advised by your SAP administrator.

Disable system messages
DisableSystemMessages boolean

Should system messages be disabled? These are typically sent by the SAP administrator and create additional popup dialogs so therefore should be disabled for automation.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
SAPGUI major version
SAPGUIMajorVersion integer

The SAPGUI major version, for example 7400.

SAPGUI revision
SAPGUIRevision integer

The SAPGUI revision, for example 3.

SAPGUI patch level
SAPGUIPatchLevel integer

The SAPGUI patch level, for example 11.

SAPGUI minor version
SAPGUIMinorVersion integer

The SAPGUI minor version, for example 257.

SAPGUI using new visual design
SAPGUINewVisualDesign boolean

Returns true if SAPGUI is using the new visual design, or false if not.

Maximise SAP window

Maximises a SAP window.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Detect parent window element
DetectParentWindowElement boolean

If set to true and a SAP ID for an element is provided (for example a text box or button) then the associated SAP window will be automatically detected and the command will be sent to the window. If set to False then the SAP window element Id itself must be specified (for example 'wnd[0]') or an exception will be raised.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Minimise SAP window

Minimises a SAP window.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Detect parent window element
DetectParentWindowElement boolean

If set to true and a SAP ID for an element is provided (for example a text box or button) then the associated SAP window will be automatically detected and the command will be sent to the window. If set to False then the SAP window element Id itself must be specified (for example 'wnd[0]') or an exception will be raised.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Modify SAP grid view cell value

Modifies the contents of a grid view cell at the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

New value
NewValue True string

The value to input.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Modified value
ModifiedValue string

The contents of the cell after it has been modified.

Open SAP connection

Open a SAP connection using either the description of the SAP system (i.e. the name in the list of SAP connections) or the address of the SAP system (e.g. /H/address/S/3200).

Parameters

Name Key Required Type Description
SAP connection description
SAPConnectionDescription string

The name / description of the SAP connection as seen in the list of connections in SAP GUI, for example Test SAP system.

SAP connection address
SAPConnectionAddress string

The connection address of the SAP system, for example /H/address/S/3200.

Connect synchronous
ConnectSynchronous boolean

Should IA-Connect wait for the login window to open before connecting?

Connect to session
ConnectToSession boolean

Should IA-Connect automatically connect to the first available session on this connection?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Opened connection name
OpenedConnectionName string

The internal name of the connection that was opened, for example con[0].

Scripting disabled by server
ScriptingDisabledByServer boolean

Returns true if SAP scripting has been disabled on the SAP server.

Number of SAP sessions
NumberOfSAPSessions integer

The number of SAP sessions that are open in the connection.

Connected session name
ConnectedSessionName string

The internal name of the connection that was opened, for example ses[0].

Open SAP grid view context menu

Opens the SAP grid view context menu.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the row to open the SAP grid view context menu on, starting from 1.

Search column name
SearchColumnName string

The internal name of the column to open the SAP grid view context menu on in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column to open the SAP grid view context menu on in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Open SAP tree item context menu

Opens the context menu for a SAP tree node or item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search node key
SearchNodeKey string

The key of the node to be clicked. If you have provided a value for the key, you do not need to provide a value for the path or text.

Search node path
SearchNodePath string

The path of the node to be clicked. If you have provided a value for the path, you do not need to provide a value for the key or text.

Search node text
SearchNodeText string

The text of the node to be clicked. If you have provided a value for the text, you do not need to provide a value for the path or key.

Search node text is regular expression
SearchNodeTextIsRegularExpression boolean

If set to true, the search node text is treated as a regular expression. For example, ^S for a node that starts with S or P$ for a node that ends with P. If set to false (the default), the search node text is treated as an exact match.

Search node text is case sensitive
SearchNodeTextIsCaseSensitive boolean

Should the node text search be case sensitive?

Search column name
SearchColumnName string

The optional internal name of the column that the node or item is within. This can be determined by using the action 'Get SAP tree column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The optional title of the column that the node or item is within. This can be determined by using the action 'Get SAP tree column headers' and provide the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press button on SAP tree item

Presses a button on a SAP tree item. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search node key
SearchNodeKey string

The key of the node to be clicked. If you have provided a value for the key, you do not need to provide a value for the path or text.

Search node path
SearchNodePath string

The path of the node to be clicked. If you have provided a value for the path, you do not need to provide a value for the key or text.

Search node text
SearchNodeText string

The text of the node to be clicked. If you have provided a value for the text, you do not need to provide a value for the path or key.

Search node text is regular expression
SearchNodeTextIsRegularExpression boolean

If set to true, the search node text is treated as a regular expression. For example, ^S for a node that starts with S or P$ for a node that ends with P. If set to false (the default), the search node text is treated as an exact match.

Search node text is case sensitive
SearchNodeTextIsCaseSensitive boolean

Should the node text search be case sensitive?

Search column name
SearchColumnName string

The internal name of the column that the node or item is within. If you have provided a column name, the column title is not required. This can be determined by using the action 'Get SAP tree column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the node or item is within. If you have provided a column title, the column name is not required. This can be determined by using the action 'Get SAP tree column headers' and provide the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Force
Force boolean

If the tree item is not a button then the IA-Connect Agent will not attempt to press it. If you wish to attempt to press the element anyway, this should be set to True.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press key on SAP tree

Press a key on a SAP tree. There are a limited built-in list of keys you can press, for example 'F1', 'F4', 'Delete', 'Insert', 'Enter', 'Cut', 'Copy' or 'Paste'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Key
Key True string

The key to press, for example 'F1', 'F4', 'Delete', 'Insert', 'Enter', 'Cut', 'Copy' or 'Paste'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press SAP element

Presses an SAP element (typically a button).

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press SAP grid view cell button

Presses a button in a grid view cell at the specified row and column within a grid view. Row index 1 represents the top row of cells in the grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press SAP grid view column header

Presses a column header in a SAP grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search column name
SearchColumnName string

The internal name of the column to press in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column to press in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press SAP shell toolbar context button

Presses a context button on a SAP element in a toolbar. The specific element to press the context button on can be searched using one of either the element Id, the text value or the element index.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search toolbar element Id
SearchToolbarElementId string

The Id of the toolbar element to press the context button on. The list of Ids for the elements in a toolbar can be obtained using the action 'Get SAP shell toolbar elements'.

Search toolbar element text
SearchToolbarElementText string

The search text for an element in a toolbar to press the context button on. The list of text values for the elements in a toolbar can be obtained using the action 'Get SAP shell toolbar elements'.

Search toolbar element index
SearchToolbarElementIndex integer

The index (starting at 1) of the toolbar element to press the context button on. The list of elements in a toolbar can be obtained using the action 'Get SAP shell toolbar elements'.

Search toolbar element text is regular expression
SearchToolbarTextIsRegularExpression boolean

If set to true, the search toolbar text is treated as a regular expression. For example, ^S for a toolbar text that starts with S or P$ for a toolbar text that ends with P. If set to false (the default), the toolbar text is treated as an exact match.

Search toolbar element text is case sensitive
SearchToolbarTextIsCaseSensitive boolean

Should the toolbar text search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press SAP shell toolbar element

Presses an SAP element (usually a button) in a toolbar. The specific element to press can be searched using one of either the element Id, the text value or the element index.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search toolbar element Id
SearchToolbarElementId string

The Id of the toolbar element to press. The list of Ids for the elements in a toolbar can be obtained using the action 'Get SAP shell toolbar elements'.

Search toolbar element text
SearchToolbarElementText string

The search text for an element in a toolbar to be pressed. The list of text values for the elements in a toolbar can be obtained using the action 'Get SAP shell toolbar elements'.

Search toolbar element index
SearchToolbarElementIndex integer

The index (starting at 1) of the toolbar element. The list of elements in a toolbar can be obtained using the action 'Get SAP shell toolbar elements'.

Search toolbar element text is regular expression
SearchToolbarTextIsRegularExpression boolean

If set to true, the search toolbar text is treated as a regular expression. For example, ^S for a toolbar text that starts with S or P$ for a toolbar text that ends with P. If set to false (the default), the toolbar text is treated as an exact match.

Search toolbar element text is case sensitive
SearchToolbarTextIsCaseSensitive boolean

Should the toolbar text search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press SAP table visible cell

Presses a button in a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to press visible cells.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Visible row index
VisibleRowIndex integer

The row index of the visible table cell, starting from 1.

Visible column index
VisibleColumnIndex integer

The column index of the visible table cell, starting from 1.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Restore SAP window

Restores a SAP window from being maximised or minimised.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Detect parent window element
DetectParentWindowElement boolean

If set to true and a SAP ID for an element is provided (for example a text box or button) then the associated SAP window will be automatically detected and the command will be sent to the window. If set to False then the SAP window element Id itself must be specified (for example 'wnd[0]') or an exception will be raised.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Scroll SAP table

Scrolls an SAP table element either horizontally, vertically or both.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Move horizontal scrollbar
MoveHorizontalScrollbar boolean

Should the horizontal scrollbar be moved?

New horizontal scrollbar position
HorizontalScrollbarPosition integer

The new horizontal scrollbar position to move to. The minimum and maximum positional values of the table scrollbars can be retrieved from the action 'Get SAP table properties'.

Move vertical scrollbar
MoveVerticalScrollbar boolean

Should the vertical scrollbar be moved?

New vertical scrollbar position
VerticalScrollbarPosition integer

The new vertical scrollbar position to move to. The minimum and maximum positional values of the table scrollbars can be retrieved from the action 'Get SAP table properties'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select all on SAP grid view

Selects everything in a SAP grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP calendar date range

Selects the specified date range (from YYYYMMDD to YYYYMMDD) in a SAP calendar element. This selection replaces any existing date selections.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

From date
FromDateYYYYMMDD True string

The start date of the selection, in the format YYYYMMDD.

To date
ToDateYYYYMMDD True string

The end date of the selection, in the format YYYYMMDD.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP calendar month

Selects the specified month (1 to 12) in the specified year in a SAP calendar element. The month is selected in addition to any existing selection.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Month
Month True integer

The month (from 1 to 12) to be selected.

Year
Year True integer

The year to be selected.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP calendar week

Selects the specified week (starting at 1) in the specified year in a SAP calendar element. The week is selected in addition to any existing selection.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Week
Week True integer

The week (from 1 to 52) to be selected.

Year
Year True integer

The year to be selected.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP element

Selects an SAP element (typically a tab element or item in a list or drop-down).

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP grid view column

Selects a single SAP column in a grid view. If a different column or columns are currently selected, they will remain selected unless the 'Clear selection first' parameter is set to true.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search column name
SearchColumnName string

The internal name of the column to be selected in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column to be selected in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Select column
SelectColumn boolean

If set to true, the specified column will be selected. If set to false, the column will be deselected.

Set as current column
SetAsCurrentColumn boolean

If set to true then this column will also be set as the current column. If set to false, the current column will remain unchanged.

Clear selection first
ClearSelectionFirst boolean

If set to true, the entire grid view will be deselected before selecting the chosen column.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP grid view multiple rows

Selects multiple SAP rows in a grid view. If a different row or rows are currently selected, they will become deselected.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Rows to select
RowsToSelect True string

The row indexes of the row to be selected, starting from 1. These can be provided either as individual rows (for example 1,3,7) or ranges (for example 1-2,5,7-9).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP grid view row

Selects a single SAP row in a grid view. If a different row or rows are currently selected, they will become deselected.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the row to be selected, starting from 1.

Set as current row
SetAsCurrentRow boolean

If set to true then this row will also be set as the current row. If set to false, the current row will remain unchanged.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP list item by key

Selects the list element with the specified key. This is typically used to select an item in a dropdown / menu item.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

List item key
ListItemKey True string

The key of the list of the item to be selected. If you do not know the list item key, you can retrieve this from the output of the action 'Get SAP selection list items'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP list item by name

Selects the list element with the specified name. This is typically used to select an item in a dropdown / menu item.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

List item name
ListItemName True string

The name of the element item to be selected.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP shell toolbar menu item

Selects a menu item in a shell toolbar. The specific element to select can be searched using one of either the element Id, the text value or the element index.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search toolbar element Id
SearchToolbarElementId string

The Id of the toolbar element to select. The list of Ids for the elements in a toolbar can be obtained using the action 'Get SAP shell toolbar elements'.

Search toolbar element text
SearchToolbarElementText string

The search text for an element in a toolbar to be selected. The list of text values for the elements in a toolbar can be obtained using the action 'Get SAP shell toolbar elements'.

Search toolbar element index
SearchToolbarElementIndex integer

The index (starting at 1) of the toolbar element to select. The list of elements in a toolbar can be obtained using the action 'Get SAP shell toolbar elements'.

Search toolbar element text is regular expression
SearchToolbarTextIsRegularExpression boolean

If set to true, the search toolbar text is treated as a regular expression. For example, ^S for a toolbar text that starts with S or P$ for a toolbar text that ends with P. If set to false (the default), the toolbar text is treated as an exact match.

Search toolbar element text is case sensitive
SearchToolbarTextIsCaseSensitive boolean

Should the toolbar text search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP table visible column

Selects the visible table column at the specified column index within a table. Column index 1, represents the first visible column in the table. This action can only be used to select visible columns.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Visible column index
VisibleColumnIndex integer

The index of the visible table column, starting from 1.

Select
Select boolean

If set to true then the column will be selected. If set to false, it will be deselected.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP table visible row

Selects the visible table row at the specified row index within a table. Row index 1, represents the first visible row in the table. This action can only be used to select visible rows.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Visible row index
VisibleRowIndex integer

The index of the visible table row, starting from 1.

Select
Select boolean

If set to true then the row will be selected. If set to false, it will be deselected.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select SAP tree item

Select or deselect a node or item in a SAP tree. The specific node or item can be searched using one of either the node key, node path or node text. The key, path or text values can be determined by using the action 'Get SAP tree nodes'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search node key
SearchNodeKey string

The key of the node to be clicked. If you have provided a value for the key, you do not need to provide a value for the path or text.

Search node path
SearchNodePath string

The path of the node to be clicked. If you have provided a value for the path, you do not need to provide a value for the key or text.

Search node text
SearchNodeText string

The text of the node to be clicked. If you have provided a value for the text, you do not need to provide a value for the path or key.

Search node text is regular expression
SearchNodeTextIsRegularExpression boolean

If set to true, the search node text is treated as a regular expression. For example, ^S for a node that starts with S or P$ for a node that ends with P. If set to false (the default), the search node text is treated as an exact match.

Search node text is case sensitive
SearchNodeTextIsCaseSensitive boolean

Should the node text search be case sensitive?

Search column name
SearchColumnName string

The optional internal name of the column that the node or item is within. This can be determined by using the action 'Get SAP tree column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The optional title of the column that the node or item is within. This can be determined by using the action 'Get SAP tree column headers' and provide the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Select
Select boolean

If set to true then the tree node or item will be selected. If set to false, it will be deselected.

Deselect all first
DeselectAllFirst boolean

Should all nodes in the tree be deselected before selecting this node? This will result in this node being the only selected node in the tree.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Send enter virtual key

Sends the enter virtual key to an SAP element. Virtual keys can only be sent to a GUI Frame window, for example 'wnd[0]'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Detect parent window element
DetectParentWindowElement boolean

If set to true and a SAP ID for an element is provided (for example a text box or button) then the associated SAP window will be automatically detected and the virtual key will be sent to the window. If set to False then the SAP window element Id itself must be specified (for example 'wnd[0]') or an exception will be raised.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Send SAP command

Inputs and submits a SAP command. This is the same as entering a command or transaction code into the command box.

Parameters

Name Key Required Type Description
SAP command
SAPCommand True string

The full SAP command or transaction code to be sent.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Send virtual key

Sends a virtual key to an SAP element. Virtual keys can only be sent to a GUI Frame window, for example 'wnd[0]'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Virtual key
SAPVKey True integer

The SAP virtual key to be sent, for example 'V1' to display the Help window.

Detect parent window element
DetectParentWindowElement boolean

If set to true and a SAP ID for an element is provided (for example a text box or button) then the associated SAP window will be automatically detected and the virtual key will be sent to the window. If set to False then the SAP window element Id itself must be specified (for example 'wnd[0]') or an exception will be raised.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Set SAP grid view current cell

Sets the current cell in a grid view to the cell at the specified row and column. Row index 1 represents the top row of cells in the grid view.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the grid view cell, starting from 1.

Search column name
SearchColumnName string

The internal name of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the cell is within. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Set SAP grid view current column

Sets the current column within a grid view. The current row will remain unchanged.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search column name
SearchColumnName string

The internal name of the column to set as the current column in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column to set as the current column in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Set SAP grid view current row index

Sets the current row index within a grid view. The current column will remain unchanged.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Row index
RowIndex True integer

The row index of the current row to set in the grid view, starting from 1.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Set SAP grid view first visible column

Scrolls a SAP grid view until the specified column is the first visible column.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search column name
SearchColumnName string

The internal name of the column to set as the first visible column in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column to set as the first visible column in the grid view. This can be determined by using the action 'Get SAP grid view column headers' and providing the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Actual first visible column name
ActualFirstVisibleColumnName string

The name of the first visible column that was set.

Set SAP grid view first visible row index

Scrolls a SAP grid view until the specified row index (starting at 1) is the first visible row. If you set a row index higher than the number of rows in the grid view then it will scroll down as far as possible.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

First visible row index
FirstVisibleRowIndex True integer

The index of the row to make the first visible row in the grid view. Starts at 1.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Actual first visible row index
ActualFirstVisibleRowIndex integer

The index of the first visible row. If you provided a 'First visible row index' value that was greater than the number of rows in the grid view, this output will tell you how far the grid view was scrolled.

Set SAP tree column width

Set the width (in pixels) of a SAP tree column. The specific column can be searched using one of either the column name or column title. The column name or title values can be determined by using the action 'Get SAP tree column headers'.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Search column name
SearchColumnName string

The internal name of the column that the node or item is within. This can be determined by using the action 'Get SAP tree column headers' and providing the values shown in the 'ColumnName' column.

Search column title
SearchColumnTitle string

The title of the column that the node or item is within. This can be determined by using the action 'Get SAP tree column headers' and provide the values shown in the 'ColumnTitle' column.

Search column title is regular expression
SearchColumnTitleIsRegularExpression boolean

If set to true, the search column title is treated as a regular expression. For example, ^S for a column title that starts with S or P$ for a column title that ends with P. If set to false (the default), the column title is treated as an exact match.

Search column title is case sensitive
SearchColumnTitleIsCaseSensitive boolean

Should the column title search be case sensitive?

Column width in pixels
ColumnWidthInPixels integer

The width to set the column to (in pixels).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Visualise SAP element

Tells the SAP GUI to draw a red rectangle around the element. This is a built-in SAP feature and not the same as asking IA-Connect to display a highlighting rectangle. The element will remain visualised until it is interacted with.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Visualise on
VisualiseOn boolean

If set to true, the SAP element will be visualised. If set to false, this will clear the visible rectangle if one is already being displayed.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Wait for attached SAP session not busy

Waits for the attached SAP session to report that it is no longer busy.

Parameters

Name Key Required Type Description
Seconds to wait
SecondsToWait True double

The number of seconds to wait for the attached SAP session to report that it is no longer busy.

Raise exception if busy after wait
RaiseExceptionIfBusyAfterWait boolean

Should IA-Connect raise an exception if the attached SAP session is still reporting that it is busy after the wait period?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Session busy after wait
BusyAfterWait boolean

Returns true if the attached SAP session is still reporting that it is busy after the wait period, or false if not.

Wait for SAP element

Waits for an SAP element (typically an individual element within a window such as a button or a text input area) to exist.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Seconds to wait
SecondsToWait double

The number of seconds to wait for the SAP element to exist.

Raise exception if element not found
RaiseExceptionIfElementNotFound boolean

Should IA-Connect raise an exception if the SAP element does not exist after the wait period?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element exists
SAPElementExists boolean

Returns true if the element exists.

Element type
SAPElementType string

The SAP type of the element, for example 'GuiTextField'.

Element type code
SAPElementTypeCode integer

The SAP type code, for example 31 for 'GuiTextField'.

Element name
SAPElementName string

The SAP name of the element.

Element sub type
SAPElementSubType string

The SAP sub type of the element. This is dependant on the element type and some elements may not have a sub type.

Wait for SAP window

Waits for a SAP window with the specified title.

Parameters

Name Key Required Type Description
Search SAP window title
SearchSAPWindowTitle True string

The title of the SAP window.

Search is regular expression
SearchIsRegularExpression boolean

If set to true, the search window name is treated as a regular expression. For example, ^S for a window title that starts with S or P$ for a window title that ends with P. If set to false (the default), the search window name is treated as an exact match.

Search is case sensitive
SearchIsCaseSensitive boolean

Should the window title search be case sensitive?

Seconds to wait
SecondsToWait double

The number of seconds to wait for the SAP window to exist.

Raise exception if element not found
RaiseExceptionIfElementNotFound boolean

Should IA-Connect raise an exception if the SAP window does not exist after the wait period?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Window exists
SAPWindowExists boolean

Returns true if a window with the specified title exists.

Element Id
SAPElementId string

The SAP ID of the element.

Element type
SAPElementType string

The SAP type of the element, for example 'GuiMainWindow'.

Element type code
SAPElementTypeCode integer

The SAP type code, for example 21 for 'GuiMainWindow'.

Element name
SAPElementName string

The SAP name of the element.

Element sub type
SAPElementSubType string

The SAP sub type of the element. This is dependant on the element type and some elements may not have a sub type.

Write to SAP table visible text cell

Writes to a visible table cell at the specified row and column index within a table. Row index 1, column index 1 represents the top left corner of the visible cells in the table. This action can only be used to set the contents of visible cells.

Parameters

Name Key Required Type Description
Search SAP element Id
SearchSAPElementId True string

The SAP element ID of the element to interact with. This can be discovered via Inspection.

Visible row index
VisibleRowIndex integer

The row index of the visible table cell, starting from 1.

Visible column index
VisibleColumnIndex integer

The column index of the visible table cell, starting from 1.

Text to input
TextToInput True string

The text value to input.

Replace existing value
ReplaceExistingValue boolean

If there is existing text in the element, should this be replaced?

Insert position
InsertPosition integer

The position (index) to begin inserting text. If there is existing text, the insert position can be used to insert at a specific position within the existing text.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns