IA-Connect UI

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 Windows application User Interface Automation (UIA).

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 connection	100	60 seconds

Actions

Check multiple UIA elements	Sets the state of multiple elements (typically a checkbox or radio box) to either checked or unchecked.
Check UIA element	Sets the state of an element (typically a checkbox or radio box) to either checked or unchecked.
Click UIA list element item by index	Clicks the list element that matches the specified index. This is typically used to select an item in a dropdown / menu item.
Click UIA list element item by name	Clicks the list element with the specified name. This is typically used to select an item in a dropdown / menu item.
Close UIA element window	Closes the element window. Typically only works on windows or dialogs.
Collapse UIA element	Collapses an element (typically a menu / dropdown item). If the item is already collapsed, nothing will happen.
Does process have Win32 window	A simple and fast Win32 action which reports whether a process (specified by name) has any visible windows. The window must exist: IA-Connect will not wait. It is recommended to use the action 'Wait for desktop element' which is more powerful.
Does top level Win32 window exist	A simple and fast Win32 action which reports whether a top-level window exists. A top-level window is one that is directly connected to the desktop. The window must exist: IA-Connect will not wait. It is recommended to use the action 'Wait for desktop element' which is more powerful.
Does UIA desktop element exist	Reports whether a desktop element exists and provides some basic element properties.
Does UIA element exist	Reports whether an element exists and returns some basic element properties.
Draw rectangle around UIA element	Draws a rectangle around the perimeter of an element to aid in identifying that the element found is the one required. The rectangle is automatically removed after 5 seconds.
Expand UIA element	Expands an element (typically a menu / dropdown item). If the item is already expanded, nothing will happen.
Focus UIA element	Focusses an element which makes it the active element for keyboard focus and, depending on the application, may bring the element window to the foreground.
Get multiple UIA element properties	Returns the properties of multiple elements. This can be useful if you are uncertain which fields holds the property values required.
Get multiple UIA elements as table	Enumerates the values of child elements of a specified parent element and returns in a table format. This can be used to returns 'Tables' of data which aren't technically tables.
Get multiple UIA parent element properties	Returns a hierarchal tree of parent elements of the specified element, all the way up to the desktop (root level). The parent element is defined as the element which is at the next level up the UIA 'tree' and is almost always a containing element.
Get UIA datagrid element contents	Returns the contents of a DataGrid element. This is an element with rows, columns, header and cells (i.e. a table).
Get UIA datagrid element properties	Returns table properties of a DataGrid element. This is an element with rows, columns, header and cells (i.e. a table).
Get UIA desktop elements	Returns a list of all windows and dialogs on the desktop.
Get UIA element at screen coordinates	Returns the UIA element located at the given screen coordinates.
Get UIA element label value	Returns the value of the label on the element.
Get UIA element properties	Returns all properties of an element. This can be useful if you are uncertain which field holds the property values required.
Get UIA element properties as list	Returns the properties of an 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 UIA element text value	Returns the text value of an element. A text value is usually associated with a label, but many elements can have this property.
Get UIA element value	Returns the value of an element. A value is usually associated with a text input area, but many elements can have this property.
Get UIA handle for desktop	Returns a handle for the desktop. This is an obsolete action because the handle '-2' can be used to refer to the desktop element but also because there are plenty of actions which can search relative to the desktop (e.g 'wait for desktop element').
Get UIA handle for focussed element	Returns a handle for the currently focused UIA element.
Get UIA handle for main window of focussed element	Returns a handle for the main window of the currently focused UIA element. The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window.
Get UIA handle for process Id main window	A simple and fast Win32 action which returns the handle for any main window of a process (specified by Process ID). The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window. It is recommended to use the action 'Wait for desktop element' which is more powerful.
Get UIA handle for process main window	A simple and fast Win32 action which returns the handle for any main window of a process (specified by name). The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window. The window must exist: IA-Connect will not wait. It is recommended to use the action 'Wait for desktop element' which is more powerful.
Get UIA handle for top level Win32 window	A simple and fast Win32 action which returns the handle for any top-level window which has the specified class name or window title. A top-level window is one that is directly connected to the desktop. The window must exist: IA-Connect will not wait. It is recommended to use the action 'Wait for desktop element' which is more powerful.
Get UIA list element items	Returns a list of child element items found under the specified element (typically dropdown / menu items).
Get UIA parent element handle	Returns a handle for the parent element of the specified element. The parent element is defined as the element which is at the next level up the UIA 'tree' and is almost always a containing element.
Global double left mouse click on UIA element	Moves the mouse to the centre of an element and double clicks the left mouse button.
Global input password into UIA element	Moves the mouse to centre of the element, focusses it, left clicks, and presses keys. Typically used with a password input that will not accept native UIA input methods.
Global input text into UIA element	Moves the mouse to centre of the element, focusses it, left clicks, and presses keys. Typically used with a text input that will not accept native UIA input methods.
Global left mouse click on UIA element	Moves the mouse to the centre of an element and clicks the left mouse button.
Global middle mouse click on UIA element	Moves the mouse to the centre of an element and clicks the middle mouse button.
Global right mouse click on UIA element	Moves the mouse to the centre of an element and clicks the right mouse button.
Input password into UIA element	UIA action which inputs a password into an element (typically a password entry field), replacing the existing text.
Input return into UIA element	Inputs a Windows return / new line () into an element (typically a text entry field), either replacing the existing text or inserting the return at a specific position.
Input text into multiple UIA elements	UIA Action which inputs different pieces of text into multiple elements (typically text entry fields), either replacing the existing text or inserting the new value at a specific position.
Input text into UIA element	UIA action which inputs text into an element (typically a text entry field), either replacing the existing text or inserting the new value at a specific position.
Is UIA element checked	This action returns true or false indicating whether an element (typically a checkbox or radio box) is checked.
Maximise UIA window	Maximises the window with the specified UIA handle.
Minimise UIA window	Minimises the window with the specified UIA handle.
Press UIA element	Presses an element (typically a button).
Reset all UIA element handles	Resets all UIA element handles currently stored by IA-Connect which can be useful if you have been identifying a lot of elements and have a large number of element handles stored. In scenarios with extremely high numbers of element handles (100,000+) this action can also be used to free up RAM usage.
Search for first UIA parent element	Searches up the UIA tree hierarchy for the first parent element which matches the search criteria. The parent element is defined as the element which is at the next level up the UIA 'tree' and is almost always a containing element.
Select UIA element	Selects an element (typically an item in a list or drop-down).
Set foreground UIA window	Brings a window to the foreground.
Set UIA element to numeric range value	Sets the value of the element which has a numeric range, for example a scrollbar.
Set UIA element to numeric value	Sets the value of the element which has a numeric input, for example a text field or a scrollbar.
Set UIA transaction timeout	Controls how long the UIA API will wait for an application to return the information about an element. This transaction timeout would typically only be reached if the application was non-responsive.
Set UIA window to normal	Normalises the window with the specified UIA handle (i.e. sets it to a normal sized window instead of minimised or maximised).
Take screenshot of UIA element location	Takes a screenshot of the location of an element and returns an image. The element should be brought to the front first as the screenshot is taking a copy of the screen at the elements location.
Toggle UIA element	Toggles an element (typically a checkbox or a radio box). This gives the element the opposite state to its current state (e.g. checked becomes unchecked and vice-versa). If you want to set a specific state, use the action 'Check element' instead.
Wait for UIA desktop element	Waits for a desktop element (typically a window) to exist.
Wait for UIA desktop element to not exist	Waits for a desktop element (typically a window) to no longer exist.
Wait for UIA element	Waits for an element (typically an individual element within a window such as a button or a text input area) to exist.
Wait for UIA element to not exist	Waits for an element (typically an individual element within a window such as a button or a text input area) to no longer exist.
Wait for UIA process Id main window	A simple and fast Win32 action which waits for a main window of a process (specified by Process ID) to exist and returns a handle. The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window. It is recommended to use the action 'Wait for desktop element' which is more powerful.
Wait for UIA process main window	A simple and fast Win32 action which waits for a specified time for the main window of a process (specified by name) to exist before returning a handle. The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window. It is recommended to use the action 'Wait for desktop element' which is more powerful.
Wait for UIA top level Win32 window	A simple and fast Win32 action which waits for a specified time for a top-level window to exist before returning a handle. A top-level window is one that is directly connected to the desktop. It is recommended to use the action 'Wait for desktop element' which is more powerful.

Check multiple UIA elements

Operation ID:

UIACheckMultipleElements

Sets the state of multiple elements (typically a checkbox or radio box) to either checked or unchecked.

Parameters

Name	Key	Required	Type	Description
Input elements	InputElementsJSON	True	string	An array of UIA elements to check, in JSON format.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Check UIA element

Operation ID:

UIACheckElement

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Check element	CheckElement		boolean	Should the element be checked (true) or unchecked (false)?
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Click UIA list element item by index

Operation ID:

UIAClickListElementItemByIndex

Clicks the list element that matches the specified index. This is typically used to select an item in a dropdown / menu item.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Expand first	ExpandFirst		boolean	If set to true then IA-Connect will attempt to expand the list before searching for the list item elements. This is useful for dynamic lists as the list item elements may not be created until the list is expanded.
Collapse after	CollapseAfter		boolean	If set to true then the list will be collapsed after executing the search.
Item index	ItemIndex		integer	The index in the list of the item to be clicked.
Seconds between expand and collapse	SecondsBetweenExpandCollapse		double	The number of seconds to wait between the expand and collapse actions if these are set to true.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Click UIA list element item by name

Operation ID:

UIAClickListElementItemByName

Clicks 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
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Expand first	ExpandFirst		boolean	If set to true then IA-Connect will attempt to expand the list before searching for the list item elements. This is useful for dynamic lists as the list item elements may not be created until the list is expanded.
Collapse after	CollapseAfter		boolean	If set to true then the list will be collapsed after executing the search.
Item name	ItemName		string	The name of the element item to be clicked.
Seconds between expand and collapse	SecondsBetweenExpandCollapse		double	The number of seconds to wait between the expand and collapse actions if these are set to true.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Close UIA element window

Operation ID:

UIACloseElementWindow

Closes the element window. Typically only works on windows or dialogs.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Collapse UIA element

Operation ID:

UIACollapseElement

Collapses an element (typically a menu / dropdown item). If the item is already collapsed, nothing will happen.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Does process have Win32 window

Operation ID:

UIADoesProcessHaveWindow

A simple and fast Win32 action which reports whether a process (specified by name) has any visible windows. The window must exist: IA-Connect will not wait. It is recommended to use the action 'Wait for desktop element' which is more powerful.

Parameters

Name	Key	Required	Type	Description
Search process name	SearchProcessName	True	string	The name of the process to search for, e.g. notepad.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Process has window	ProcessHasWindow	boolean	Returns true if the process has a visible window, or false if not.

Does top level Win32 window exist

Operation ID:

UIADoesTopLevelWindowExist

A simple and fast Win32 action which reports whether a top-level window exists. A top-level window is one that is directly connected to the desktop. The window must exist: IA-Connect will not wait. It is recommended to use the action 'Wait for desktop element' which is more powerful.

Parameters

Name	Key	Required	Type	Description
Search class name	SearchClassName		string	The element class name of the top level window to search for, e.g. 'Notepad'.
Search window title	SearchWindowTitle		string	The title of the top level window to search for.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Window exists	WindowExists	boolean	Returns true if the window exists or false if not.

Does UIA desktop element exist

Operation ID:

UIADoesDesktopElementExist

Reports whether a desktop element exists and provides some basic element properties.

Parameters

Name	Key	Required	Type	Description
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search process Id	SearchProcessId		integer	If specified then the search will only consider elements owned by a process with this Process ID (PID). If IA-Connect launched the process then the PID is provided by the 'Run Process' action in the IA-Connect Environment / Session actions. If you don't know the PID then leave this field blank.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Return element handle	ReturnElementHandle		boolean	If set to true than a handle to the located element will be returned. This handle can be used in further actions to act as a 'parent' handle.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Include child processes	IncludeChildProcesses		boolean	If set to true and a 'Search process Id' is specified, child processes of that process Id are also included in the search. If set to false then only a process matching the exact 'Search process Id' will be returned.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element exists	ElementExists	boolean	Returns true if the element exists or false if not.
Element handle	ElementHandle	integer	The UIA handle for the element. This can be used as an input to further UIA actions acting on this element.
Element name	ElementName	string	The UIA name of the element.
Element class name	ElementClassName	string	The UIA class name of the element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the element.

Does UIA element exist

Operation ID:

UIADoesElementExist

Reports whether an element exists and returns some basic element properties.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search process Id	SearchProcessId		integer	If specified then the search will only consider elements owned by a process with this Process ID (PID). If IA-Connect launched the process then the PID is provided by the 'Run Process' action in the IA-Connect Environment / Session actions. If you don't know the PID then leave this field blank.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Return element handle	ReturnElementHandle		boolean	If set to true than a handle to the located element will be returned. This handle can be used in further actions to act as a 'parent' handle.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Include child processes	IncludeChildProcesses		boolean	If set to true and a 'Search process Id' is specified, child processes of that process Id are also included in the search. If set to false then only a process matching the exact 'Search process Id' will be searched.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element exists	ElementExists	boolean	Returns true if the element exists or false if not.
Element handle	ElementHandle	integer	The UIA handle for the element. This can be used as an input to further UIA actions acting on this element.
Element name	ElementName	string	The UIA name of the element.
Element class name	ElementClassName	string	The UIA class name of the element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the element.

Draw rectangle around UIA element

Operation ID:

UIADrawRectangleAroundElement

Draws a rectangle around the perimeter of an 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
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
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.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Expand UIA element

Operation ID:

UIAExpandElement

Expands an element (typically a menu / dropdown item). If the item is already expanded, nothing will happen.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Focus UIA element

Operation ID:

UIAFocusElement

Focusses an element which makes it the active element for keyboard focus and, depending on the application, may bring the element window to the foreground.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Get multiple UIA element properties

Operation ID:

UIAGetMultipleElementProperties

Returns the properties of multiple elements. This can be useful if you are uncertain which fields holds the property values required.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element localized control type	SearchElementLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search descendants	SearchDescendants		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Return element handle	ReturnElementHandle		boolean	If set to true than a handle to the located element will be returned. This handle can be used in further actions to act as a 'parent' handle.
Return element value	ReturnElementValue		boolean	If set to true than the value of the located element will be returned.
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 UIA tree), you can alternatively specify a negative index starting from -1.
Max items to return	MaxItemsToReturn		integer	The maximum number of elements to return, or 0 to return all items.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of elements found	NumberOfElementsFound	integer	The number of elements found that match the search criteria.
Number of elements returned	NumberOfElementsReturned	integer	The number of elements returned (this can be lower than the number of elements found if specifying a maximum number of items to return).
Element properties	ElementProperties	array of object	The element properties of the elements found that match the search criteria.
items	ElementProperties	object

Get multiple UIA elements as table

Operation ID:

UIAGetMultipleElementsAsTable

Enumerates the values of child elements of a specified parent element and returns in a table format. This can be used to returns 'Tables' of data which aren't technically tables.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Search cell header subelement localized control type	SearchCellHeaderSubElementLocalizedControlType		string	The cell header subelement localized control type to search for. Leave blank if not searching for cell headers.
Search cell header subelement control type	SearchCellHeaderSubElementControlType		integer	The cell header subelement control type (an non-localized integer) to search for. This is the same value across different languages. Leave at 0 if not searching for cell headers.
Search cell subelement localized control type	SearchCellSubElementLocalizedControlType		string	The cell subelement localized control type to search for.
Search cell subelement control type	SearchCellSubElementControlType		integer	The cell subelement control type (an non-localized integer) to search for. This is the same value across different languages.
Search descendants for cell subelements	SearchDescendantsForCellSubElements		boolean
First cell header subelement to return	FirstCellHeaderSubElementToReturn		integer	The index of the first cell header subelement to return, starting from 1. If you wish to return the elements in the reverse order (from the bottom of the UIA tree), you can alternatively specify a negative index starting from -1.
Max cell header subelements to return	MaxCellHeaderSubElementsToReturn		integer	The maximum number of cell header subelements to return, or 0 to return all subelements.
First cell subelement to return	FirstCellSubElementToReturn		integer	The index of the first cell subelement to return, starting from 1. If you wish to return the elements in the reverse order (from the bottom of the UIA tree), you can alternatively specify a negative index starting from -1.
Max cell subelements to return	MaxCellSubElementsToReturn		integer	The maximum number of cell subelements to return, or 0 to return all subelements.
Requested number of columns	RequestedNumberOfColumns		integer	The number of columns you would like in the output table. This value must be correct for the parent element being specified or you will receive unexpected results.
Cell subelement value priority	CellSubElementValuePriority		integer	The priority for using the cell subelement value as the value to use in the output table. 1 is highest priority. 2 is second priority. 3 is third priority. 0 is do not use.
Cell subelement text value priority	CellSubElementTextValuePriority		integer	The priority for using the cell subelement text value as the value to use in the output table. 1 is highest priority. 2 is second priority. 3 is third priority. 0 is do not use.
Cell subelement name value priority	CellSubElementNameValuePriority		integer	The priority for using the cell subelement name (common for labels) as the value to use in the output table. 1 is highest priority. 2 is second priority. 3 is third priority. 0 is do not use.
Minimum cell subelement width	MinimumCellSubElementWidth		integer	The minimum width in pixels of a cell subelement to be included in the table.
Minimum cell subelement height	MinimumCellSubElementHeight		integer	The minimum height in pixels of a cell subelement to be included in the table.
Search cell subelement bounding box left	SearchCellSubElementBoundingBoxLeft		integer	Only include cell subelements which are fully contained within the bounding box. By default the bounding box is huge to include all elements.
Search cell subelement bounding box right	SearchCellSubElementBoundingBoxRight		integer	Only include cell subelements which are fully contained within the bounding box. By default the bounding box is huge to include all elements.
Search cell subelement bounding box top	SearchCellSubElementBoundingBoxTop		integer	Only include cell subelements which are fully contained within the bounding box. By default the bounding box is huge to include all elements.
Search cell subelement bounding box bottom	SearchCellSubElementBoundingBoxBottom		integer	Only include cell subelements which are fully contained within the bounding box. By default the bounding box is huge to include all elements.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of cell subelements found	NumberOfCellSubElementsFound	integer	The number of cell subelements (not headers) found that match the search criteria.
Number of cell subelements returned	NumberOfCellSubElementsReturned	integer	The number of cell subelements (not headers) returned (this can be lower than the number of elements found if specifying a first or maximum number of items to return).
Table contents JSON	TableContentsJSON	string	The table created from the multiple element contents, in JSON format.
Number of rows in table	NumberOfRowsInTable	integer	The number of rows in the output table.
Number of columns in table	NumberOfColumnsInTable	integer	The number of columns in the output table.

Get multiple UIA parent element properties

Operation ID:

UIAGetMultipleParentElementProperties

Returns a hierarchal tree of parent elements of the specified element, all the way up to the desktop (root level). The parent element is defined as the element which is at the next level up the UIA 'tree' and is almost always a containing element.

Parameters

Name	Key	Required	Type	Description
Element handle	ElementHandle	True	integer	The UIA handle for the target element.
Max parents to process	MaxParentsToProcess		integer	The maximum number of parent elements to process. By default, this is set to 50.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
UIA parent elements	UIAParentElements	array of object	A list of all located parent elements (and their properties). The properties returned are the same as those returned by the 'Get multiple element properties' action.
items	UIAParentElements	object
Number of parent elements returned	NumberOfParentElementsReturned	integer	The number of parent elements returned from the search.

Get UIA datagrid element contents

Operation ID:

UIAGetDataGridElementContents

Returns the contents of a DataGrid element. This is an element with rows, columns, header and cells (i.e. a table).

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Retrieve Onscreen columns only	OnScreenColumnsOnly		boolean	If set to true then only onscreen columns will be returned.
Retrieve Onscreen rows only	OnScreenRowsOnly		boolean	If set to true then only onscreen rows will be returned.
Return null values as blank	ReturnNullValuesAsBlank		boolean	If set to true, null values will be returned as '' (i.e. blank). If set to false, null values are typically returned as '(null)'.
Alternative header row name	AlternativeHeaderRowName		string	By default, the header row in a DataGrid has the UIA name 'Top Row'. If the header row has a different name, specify that name here.
Return row UIA name	ReturnRowUIAName		boolean	If this input is set to then the row UIA name will be stored in a column in the output collection. The name of the column is defined by the input 'Name of column to store row UIA name'.
Name of column to store row UIA name	NameOfColumnToStoreRowUIAName		string	If the input 'Return row UIA name' is set to true then this input specifies the name of the column in the output collection to hold the row UIA name.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
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 UIA tree), you can alternatively specify a negative index starting from -1.
Max items to return	MaxItemsToReturn		integer	The maximum number of elements to return, or 0 to return all items.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Datagrid contents JSON	DataGridContentsJSON	string	The datagrid element contents, in JSON format.

Get UIA datagrid element properties

Operation ID:

UIAGetDataGridElementProperties

Returns table properties of a DataGrid element. This is an element with rows, columns, header and cells (i.e. a table).

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Alternative header row name	AlternativeHeaderRowName		string	By default, the header row in a DataGrid has the UIA name 'Top Row'. If the header row has a different name, specify that name here.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of columns	NumberOfColumns	integer	The number of columns in the datagrid.
Number of visible columns	NumberOfVisibleColumns	integer	The number of visible columns in the datagrid.
Number of rows	NumberOfRows	integer	The number of rows in the datagrid.
Number of visible rows	NumberOfVisibleRows	integer	The number of visible rows in the datagrid.
First visible row	FirstVisibleRow	integer	The index of the first visible row in the datagrid.
Last visible row	LastVisibleRow	integer	The index of the last visible row in the datagrid.
Number of scrollbars	NumberOfScrollbars	integer	The number of scrollbars that the datagrid has.
Scrollbar names	ScrollbarNames	string	A comma separated list of the names of the scrollbars (e.g. Horizontal, Vertical).

Get UIA desktop elements

Operation ID:

UIAGetDesktopElements

Returns a list of all windows and dialogs on the desktop.

Parameters

Name	Key	Required	Type	Description
Search element localized control type	SearchElementLocalizedControlType		string	Filter the results by the localized control type of the element.
Search process Id	SearchProcessID		integer	If specified then the search will only consider elements owned by a process with this Process ID (PID). If IA-Connect launched the process then the PID is provided by the 'Run Process' action in the IA-Connect Environment / Session actions. If you don't know the PID then leave this field blank.
Return element handle	ReturnElementHandle		boolean	If set to true than a handle to the located element will be returned. This handle can be used in further actions to act as a 'parent' handle.
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 UIA tree), you can alternatively specify a negative index starting from -1.
Max items to return	MaxItemsToReturn		integer	The maximum number of elements to return, or 0 to return all items.
Include child processes	IncludeChildProcesses		boolean	If set to true and a 'Search process Id' is specified, child processes of that process Id are also included in the search. If set to false then only a process matching the exact 'Search process Id' will be returned.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of elements found	NumberOfElementsFound	integer	The number of desktop elements found that match the search criteria.
Number of elements returned	NumberOfElementsReturned	integer	The number of desktop elements returned (this can be lower than the number of elements found if specifying a maximum number of items to return).
Element properties	ElementProperties	array of object	The element properties of the desktop elements found that match the search criteria.
items	ElementProperties	object

Get UIA element at screen coordinates

Operation ID:

UIAGetElementAtCoordinates

Returns the UIA element located at the given screen coordinates.

Parameters

Name	Key	Required	Type	Description
X coordinate	XCoord		integer	The screen X coordinate value (in pixels) where the UIA element should be seached for.
Y coordinate	YCoord		integer	The screen Y coordinate value (in pixels) where the UIA element should be seached for.
Raise exception if element not found	RaiseExceptionIfElementNotFound		boolean	Should IA-Connect raise an exception if a UIA element was not located at the specified location?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element found	ElementFound	boolean	Returns true if a UIA element was found at the specified location.
Element handle	ElementHandle	integer	The UIA handle for the element. This can be used as an input to further UIA actions acting on this element.
Element name	ElementName	string	The UIA name of the element.
Element class name	ElementClassName	string	The UIA class name of the element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the element.

Get UIA element label value

Operation ID:

UIAGetElementLabelValue

Returns the value of the label on the element.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element label value	ElementLabelValue	string	The value of the label on the element.

Get UIA element properties

Operation ID:

UIAGetElementProperties

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Return element handle	ReturnElementHandle		boolean	If set to true than a handle to the located element will be returned. This handle can be used in further actions to act as a 'parent' handle.
Return element value	ReturnElementValue		boolean	If set to true than the value of the located element will be returned.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element name	ElementName	string	The UIA name of the element.
Element class name	ElementClassName	string	The UIA class name of the element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the element.
Element framework Id	ElementFrameworkId	string	The UIA framework Id of the element.
Element control type	ElementControlType	string	The UIA control type as a number. This is similar to localized control type but isn't language specific.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the element.
Element is enabled	ElementIsEnabled	boolean	Returns whether the element enabled or not.
Element is offscreen	ElementIsOffscreen	boolean	Returns whether the element is offscreen or not.
Element is keyboard focusable	ElementIsKeyboardFocusable	boolean	Returns whether the element can be focussed by the keyboard.
Element has keyboard focus	ElementHasKeyboardFocus	boolean	Returns whether the element currently has keyboard focus.
Element is password field	ElementIsPasswordField	boolean	Returns whether an element is a password input field.
Element accelerator key	ElementAcceleratorKey	string	Returns the hotkey which could be pressed to activate the element.
Element access key	ElementAccessKey	string	Returns the hotkey which could be pressed to activate a menu element.
Element left edge	ElementLeftEdge	integer	The distance in pixels between the left edge of the element or window and the left edge of the display.
Element right edge	ElementRightEdge	integer	The distance in pixels between the right edge of the element or window and the left edge of the display.
Element top edge	ElementTopEdge	integer	The distance in pixels between the top edge of the element or window and the top edge of the display.
Element bottom edge	ElementBottomEdge	integer	The distance in pixels between the bottom edge of the element or window and the top edge of the display.
Element clickable point X	ElementClickablePointX	integer	The X coordinate in pixels of a central clickable point in the element relative to the left edge of the display as returned by the underlying application.
Element clickable point Y	ElementClickablePointY	integer	The Y coordinate in pixels of a central clickable point in the element relative to the top edge of the display as returned by the underlying application.
Element process ID	ElementProcessId	integer	The Process ID (PID) of the process which owns this element.
Element handle	ElementHandle	integer	If the input 'Return element handle' was set to true, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further actions.
Element value	ElementValue	string	If the input 'Return element value' was set to true and if the element has a value pattern, this will hold that value.
Element text value	ElementTextValue	string	If the input 'Return element value' was set to true and if the element has a text value pattern, this will hold that text value.

Get UIA element properties as list

Operation ID:

UIAGetElementPropertiesAsList

Returns the properties of an 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
Element handle	ElementHandle	True	integer	The UIA handle for the target element.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of elements found	NumberOfElementsFound	integer	The number of elements found.
Number of elements returned	NumberOfElementsReturned	integer	The number of elements returned.
UIA element properties JSON	UIAElementPropertiesJSON	string	The UIA properties of the element, in JSON format.

Get UIA element text value

Operation ID:

UIAGetElementTextValue

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element text value	ElementTextValue	string	The text value of the element.

Get UIA element value

Operation ID:

UIAGetElementValue

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element value	ElementValue	string	The value of the element.

Get UIA handle for desktop

Operation ID:

UIAGetHandleForDesktop

Returns a handle for the desktop. This is an obsolete action because the handle '-2' can be used to refer to the desktop element but also because there are plenty of actions which can search relative to the desktop (e.g 'wait for desktop element').

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Window handle	WindowHandle	integer	The UIA handle for the desktop. This can be used as an input to further UIA actions within this window.
Element name	ElementName	string	The UIA name of the desktop element.
Element class name	ElementClassName	string	The UIA class name of the desktop element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the desktop element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the desktop element.

Get UIA handle for focussed element

Operation ID:

UIAGetHandleForFocussedElement

Returns a handle for the currently focused UIA element.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Window handle	WindowHandle	integer	The UIA handle for the window. This can be used as an input to further UIA actions within this window.
Element name	ElementName	string	The UIA name of the element.
Element class name	ElementClassName	string	The UIA class name of the element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the element.

Get UIA handle for main window of focussed element

Operation ID:

UIAGetHandleForMainWindowOfFocussedElement

Returns a handle for the main window of the currently focused UIA element. The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Window handle	WindowHandle	integer	The UIA handle for the window. This can be used as an input to further UIA actions within this window.
Element name	ElementName	string	The UIA name of the window element.
Element class name	ElementClassName	string	The UIA class name of the window element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the window element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the window element.

Get UIA handle for process Id main window

Operation ID:

UIAGetHandleForProcessIdMainWindow

A simple and fast Win32 action which returns the handle for any main window of a process (specified by Process ID). The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window. It is recommended to use the action 'Wait for desktop element' which is more powerful.

Parameters

Name	Key	Required	Type	Description
Search process Id	ProcessId	True	integer	The Id of the process to wait for (as provided by the 'Run Process' action in the IA-Connect Environment / Session actions).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Window handle	WindowHandle	integer	The UIA handle for the window. This can be used as an input to further UIA actions within this window.
Element name	ElementName	string	The UIA name of the window element.
Element class name	ElementClassName	string	The UIA class name of the window element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the window element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the window element.

Get UIA handle for process main window

Operation ID:

UIAGetHandleForProcessMainWindow

A simple and fast Win32 action which returns the handle for any main window of a process (specified by name). The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window. The window must exist: IA-Connect will not wait. It is recommended to use the action 'Wait for desktop element' which is more powerful.

Parameters

Name	Key	Required	Type	Description
Search process name	SearchProcessName	True	string	The name of the process to search for, e.g. notepad.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Window handle	WindowHandle	integer	The UIA handle for the window. This can be used as an input to further UIA actions within this window.
Element name	ElementName	string	The UIA name of the window element.
Element class name	ElementClassName	string	The UIA class name of the window element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the window element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the window element.

Get UIA handle for top level Win32 window

Operation ID:

UIAGetHandleForTopLevelWindow

A simple and fast Win32 action which returns the handle for any top-level window which has the specified class name or window title. A top-level window is one that is directly connected to the desktop. The window must exist: IA-Connect will not wait. It is recommended to use the action 'Wait for desktop element' which is more powerful.

Parameters

Name	Key	Required	Type	Description
Search class name	SearchClassName		string	The element class name of the top level window to search for, e.g. 'Notepad'.
Search window title	SearchWindowTitle		string	The title of the top level window to search for.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Window handle	WindowHandle	integer	The UIA handle for the window. This can be used as an input to further UIA actions within this window.
Element name	ElementName	string	The UIA name of the window element.
Element class name	ElementClassName	string	The UIA class name of the window element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the window element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the window element.

Get UIA list element items

Operation ID:

UIAGetListElementItems

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Expand first	ExpandFirst		boolean	If set to true then IA-Connect will attempt to expand the list before searching for the list item elements. This is useful for dynamic lists as the list item elements may not be created until the list is expanded.
Collapse after	CollapseAfter		boolean	If set to true then the list will be collapsed after executing the search.
Check for selected items	CheckForSelectedItems		boolean	If set to true then the output collection will contain an additional property indicating whether the list item is currently selected.
Seconds between expand and collapse	SecondsBetweenExpandCollapse		double	The number of seconds to wait between the expand and collapse actions if these are set to true.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of list items	NumberOfListItems	integer	The number of items in the list.
List items JSON	ListItemsJSON	string	The properties of the items in the list, in JSON format.
Number of selected items	NumberOfSelectedItems	integer	The number of selected items in the list.
Index of first selected item	IndexOfFirstSelectedItem	integer	The index in the list of the first selected item.
Selected item name	SelectedItemName	string	The name of the selected item.

Get UIA parent element handle

Operation ID:

UIAGetParentElementHandle

Returns a handle for the parent element of the specified element. The parent element is defined as the element which is at the next level up the UIA 'tree' and is almost always a containing element.

Parameters

Name	Key	Required	Type	Description
Element handle	ElementHandle	True	integer	The UIA handle for the target element.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Parent element handle	ParentElementHandle	integer	A UIA handle for the parent element.

Global double left mouse click on UIA element

Operation ID:

UIAGlobalDoubleLeftMouseClickOnElement

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Delay in milliseconds	DelayInMilliseconds		integer	The delay (in milliseconds) between each of the clicks.
Focus element first	FocusElementFirst		boolean	Should IA-Connect attempt to focus the element before global clicking?
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
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 input password into UIA element

Operation ID:

UIAGlobalPasswordInputIntoElement

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Focus element first	FocusElement		boolean	Should IA-Connect attempt to focus the element before global clicking?
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.
Interval in milliseconds	Interval		integer	The number of milliseconds between each key press.
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.
Password contains stored password	PasswordContainsStoredPassword		boolean	Set to true if the password contains (or is entirely) an IA-Connect stored password identifier, in the format {IAConnectPassword:StoredPasswordIdentifier}. This stored password could have been generated by the 'Generate password' action, for example.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Global input text into UIA element

Operation ID:

UIAGlobalTextInputIntoElement

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Focus element first	FocusElement		boolean	Should IA-Connect attempt to focus the element before global clicking?
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.
Interval in milliseconds	Interval		integer	The number of milliseconds between each key press.
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 mouse click on UIA element

Operation ID:

UIAGlobalMouseClickOnElement

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Focus element first	FocusElementFirst		boolean	Should IA-Connect attempt to focus the element before global clicking?
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
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 UIA element

Operation ID:

UIAGlobalMiddleMouseClickOnElement

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Focus element first	FocusElementFirst		boolean	Should IA-Connect attempt to focus the element before global clicking?
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
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 UIA element

Operation ID:

UIAGlobalRightMouseClickOnElement

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Focus element first	FocusElementFirst		boolean	Should IA-Connect attempt to focus the element before global clicking?
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
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 UIA element

Operation ID:

UIAInputPasswordIntoElement

UIA action which inputs a password into an element (typically a password entry field), replacing the existing text.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Password to input	PasswordToInput	True	password	The password value to input.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Password contains stored password	PasswordContainsStoredPassword		boolean	Set to true if the password contains (or is entirely) an IA-Connect stored password identifier, in the format {IAConnectPassword:StoredPasswordIdentifier}. This stored password could have been generated by the 'Generate password' action, for example.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Input return into UIA element

Operation ID:

UIAInputReturnIntoElement

Inputs a Windows return / new line () into an element (typically a text entry field), either replacing the existing text or inserting the return at a specific position.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
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

Input text into multiple UIA elements

Operation ID:

UIAInputTextIntoMultipleElements

UIA Action which inputs different pieces of text into multiple elements (typically text entry fields), either replacing the existing text or inserting the new value at a specific position.

Parameters

Name	Key	Required	Type	Description
Input elements	InputElementsJSON	True	string	An array of UIA elements to enter text into, in JSON format.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Input text into UIA element

Operation ID:

UIAInputTextIntoElement

UIA action which inputs text into an 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
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Text to input	TextToInput	True	string	The text value to input.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
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

Is UIA element checked

Operation ID:

UIAIsElementChecked

This action returns true or false indicating whether an element (typically a checkbox or radio box) is checked.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element is checked	ElementIsChecked	boolean	Returns true if the element is checked or false if not.

Maximise UIA window

Operation ID:

UIAMaximiseWindow

Maximises the window with the specified UIA handle.

Parameters

Name	Key	Required	Type	Description
Window handle	WindowHandle	True	integer	The UIA handle for the window to be maximised.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Minimise UIA window

Operation ID:

UIAMinimiseWindow

Minimises the window with the specified UIA handle.

Parameters

Name	Key	Required	Type	Description
Window handle	WindowHandle	True	integer	The UIA handle for the window to be minimised.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Press UIA element

Operation ID:

UIAPressElement

Presses an element (typically a button).

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Wait for button event to complete	Wait		boolean	Should the automation wait for the button event to complete before continuing. If set to true this can cause a timeout if the button opens a modal dialog.
Win32 click button	Win32ClickButton		boolean	Should a Win32 click event be used? This is a 'fire and forget' click event, which can be useful when dealing with modal dialogs that are presented after a click.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Reset all UIA element handles

Operation ID:

UIAResetAllElementHandles

Resets all UIA element handles currently stored by IA-Connect which can be useful if you have been identifying a lot of elements and have a large number of element handles stored. In scenarios with extremely high numbers of element handles (100,000+) this action can also be used to free up RAM usage.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Search for first UIA parent element

Operation ID:

UIASearchForFirstParentElement

Searches up the UIA tree hierarchy for the first parent element which matches the search criteria. The parent element is defined as the element which is at the next level up the UIA 'tree' and is almost always a containing element.

Parameters

Name	Key	Required	Type	Description
Element handle	ElementHandle	True	integer	The UIA handle for the target element.
Search parent element localized control type	SearchParentLocalizedControlType		string	The parent UIA element localized control type to search for. This can be discovered via Inspection.
Search parent element control type	SearchParentControlType		integer	The parent UIA element control type (an non-localized integer) to search for. This is the same value across different languages.
Max parents to process	MaxParentsToProcess		integer	The maximum number of parent elements to process. By default, this is set to 50.
Raise exception if parent element not found	RaiseExceptionIfParentElementNotFound		boolean	Should IA-Connect raise an exception if the search UIA element is not located?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Parent element found	ParentElementFound	boolean	Returns true if the search parent UIA element was found.
Parent element handle	ParentElementHandle	integer	The UIA handle for the located parent element. This can be used as an input to further UIA actions acting on this element.
Parent element name	ParentElementName	string	The UIA name of the located parent element.
Parent element class name	ParentElementClassName	string	The UIA class name of the located parent element.
Parent element automation Id	ParentElementAutomationId	string	The UIA automation Id of the located parent element.
Parent element localized control type	ParentElementLocalizedControlType	string	The UIA localized control type of the located parent element.

Select UIA element

Operation ID:

UIASelectElement

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set foreground UIA window

Operation ID:

UIASetForegroundWindow

Brings a window to the foreground.

Parameters

Name	Key	Required	Type	Description
Window handle	WindowHandle	True	integer	The UIA handle for the window which should be set as the foreground window.
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.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set UIA element to numeric range value

Operation ID:

UIASetElementToNumericRangeValue

Sets the value of the element which has a numeric range, for example a scrollbar.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
New value	NewValue	True	double	The numeric range value to set the element to.
New value is percentage	NewValueIsPercentage		boolean	Is the new value a percentage?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set UIA element to numeric value

Operation ID:

UIASetElementToNumericValue

Sets the value of the element which has a numeric input, for example a text field or a scrollbar.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
New value	NewValue	True	integer	The numeric value to set the element to.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set UIA transaction timeout

Operation ID:

UIASetTransactionTimeout

Controls how long the UIA API will wait for an application to return the information about an element. This transaction timeout would typically only be reached if the application was non-responsive.

Parameters

Name	Key	Required	Type	Description
Timeout in seconds	TimeoutInSeconds	True	double	The maximum length of time that the UIA API will wait for an application to return the information about an element.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set UIA window to normal

Operation ID:

UIASetWindowToNormal

Normalises the window with the specified UIA handle (i.e. sets it to a normal sized window instead of minimised or maximised).

Parameters

Name	Key	Required	Type	Description
Window handle	WindowHandle	True	integer	The UIA handle for the window to be normalised.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Take screenshot of UIA element location

Operation ID:

UIATakeScreenShotOfElementLocation

Takes a screenshot of the location of an element and returns an image. The element should be brought to the front first as the screenshot is taking a copy of the screen at the elements location.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Image format	ImageFormat		string	The image format to use for the screenshot. This can affect the quality and size of data being returned. Supported formats are PNG (the default), JPG, BMP and GIF
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Screen image as Base64	ScreenBitmapBase64	string	The screen image as a Base64 encoded string.

Toggle UIA element

Operation ID:

UIAToggleElement

Toggles an element (typically a checkbox or a radio box). This gives the element the opposite state to its current state (e.g. checked becomes unchecked and vice-versa). If you want to set a specific state, use the action 'Check element' instead.

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Wait for UIA desktop element

Operation ID:

UIAWaitForDesktopElement

Waits for a desktop element (typically a window) to exist.

Parameters

Name	Key	Required	Type	Description
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search process Id	SearchProcessId		integer	If specified then the search will only consider elements owned by a process with this Process ID (PID). If IA-Connect launched the process then the PID is provided by the 'Run Process' action in the IA-Connect Environment / Session actions. If you don't know the PID then leave this field blank.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Return element handle	ReturnElementHandle		boolean	If set to true than a handle to the located element will be returned. This handle can be used in further actions to act as a 'parent' handle.
Seconds to wait	SecondsToWait	True	integer	The maximum number of seconds to wait for the element to exist.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Include child processes	IncludeChildProcesses		boolean	If set to true and a 'Search process Id' is specified, child processes of that process Id are also included in the search. If set to false then only a process matching the exact 'Search process Id' will be returned.
Raise exception if element not found	RaiseExceptionIfElementNotFound		boolean	Should IA-Connect raise an exception if the UIA 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	ElementExists	boolean	Returns true if the element exists or false if not.
Element handle	ElementHandle	integer	The UIA handle for the element. This can be used as an input to further UIA actions acting on this element.
Element name	ElementName	string	The UIA name of the element.
Element class name	ElementClassName	string	The UIA class name of the element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the element.

Wait for UIA desktop element to not exist

Operation ID:

UIAWaitForDesktopElementToNotExist

Waits for a desktop element (typically a window) to no longer exist.

Parameters

Name	Key	Required	Type	Description
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search process Id	SearchProcessId		integer	If specified then the search will only consider elements owned by a process with this Process ID (PID). If IA-Connect launched the process then the PID is provided by the 'Run Process' action in the IA-Connect Environment / Session actions. If you don't know the PID then leave this field blank.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Seconds to wait	SecondsToWait	True	integer	The maximum number of seconds to wait for the element to not exist.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Include child processes	IncludeChildProcesses		boolean	If set to true and a 'Search process Id' is specified, child processes of that process Id are also included in the search. If set to false then only a process matching the exact 'Search process Id' will be returned.
Raise exception if element still exists	RaiseExceptionIfElementStillExists		boolean	Should IA-Connect raise an exception if the UIA element still exists after the wait period?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element exists before wait	ElementExistsBeforeWait	boolean	Returns true if the element existed before waiting or false if not.
Element exists after wait	ElementExistsAfterWait	boolean	Returns true if the element existed after waiting or false if not.

Wait for UIA element

Operation ID:

UIAWaitForElement

Waits for an 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
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search process Id	SearchProcessId		integer	If specified then the search will only consider elements owned by a process with this Process ID (PID). If IA-Connect launched the process then the PID is provided by the 'Run Process' action in the IA-Connect Environment / Session actions. If you don't know the PID then leave this field blank.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Return element handle	ReturnElementHandle		boolean	If set to true than a handle to the located element will be returned. This handle can be used in further actions to act as a 'parent' handle.
Seconds to wait	SecondsToWait	True	integer	The maximum number of seconds to wait for the element to exist.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Include child processes	IncludeChildProcesses		boolean	If set to true and a 'Search process Id' is specified, child processes of that process Id are also included in the search. If set to false then only a process matching the exact 'Search process Id' will be returned.
Raise exception if element not found	RaiseExceptionIfElementNotFound		boolean	Should IA-Connect raise an exception if the UIA 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	ElementExists	boolean	Returns true if the element exists or false if not.
Element handle	ElementHandle	integer	The UIA handle for the element. This can be used as an input to further UIA actions acting on this element.
Element name	ElementName	string	The UIA name of the element.
Element class name	ElementClassName	string	The UIA class name of the element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the element.

Wait for UIA element to not exist

Operation ID:

UIAWaitForElementToNotExist

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

Parameters

Name	Key	Required	Type	Description
Parent window handle	ParentWindowHandle	True	integer	The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Wait for desktop element' or 'Wait for element'.
Search element name	SearchElementName		string	The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element class name	SearchElementClassName		string	The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element automation ID	SearchElementAutomationId		string	The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.
Search element localized control type	SearchLocalizedControlType		string	The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.
Search process Id	SearchProcessId		integer	If specified then the search will only consider elements owned by a process with this Process ID (PID). If IA-Connect launched the process then the PID is provided by the 'Run Process' action in the IA-Connect Environment / Session actions. If you don't know the PID then leave this field blank.
Search UIA subtree	SearchSubTree		boolean	If set to true then the whole UIA tree below the parent window handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent window handle in the UIA tree will be searched.
Seconds to wait	SecondsToWait	True	integer	The maximum number of seconds to wait for the element to not exist.
Match index	MatchIndex		integer	If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.
Search filter	SearchFilter		string	An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [ClassName] like 'Label*'. See the documentation for more examples.
Sort by column name	SortByColumn		string	If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.
Match index is ascending	MatchIndexAscending		boolean	If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).
Include child processes	IncludeChildProcesses		boolean	If set to true and a 'Search process Id' is specified, child processes of that process Id are also included in the search. If set to false then only a process matching the exact 'Search process Id' will be returned.
Raise exception if element still exists	RaiseExceptionIfElementStillExists		boolean	Should IA-Connect raise an exception if the UIA element still exists after the wait period?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element exists before wait	ElementExistsBeforeWait	boolean	Returns true if the element existed before waiting or false if not.
Element exists after wait	ElementExistsAfterWait	boolean	Returns true if the element existed after waiting or false if not.

Wait for UIA process Id main window

Operation ID:

UIAWaitForProcessIdMainWindow

A simple and fast Win32 action which waits for a main window of a process (specified by Process ID) to exist and returns a handle. The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window. It is recommended to use the action 'Wait for desktop element' which is more powerful.

Parameters

Name	Key	Required	Type	Description
Search process Id	ProcessId	True	integer	The Id of the process to wait for (as provided by the 'Run Process' action in the IA-Connect Environment / Session actions).
Seconds to wait	SecondsToWait	True	integer	The maximum number of seconds to wait for the process main window.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Element exists	ElementExists	boolean	Returns true if the element exists or false if not.
Window handle	WindowHandle	integer	The UIA handle for the window. This can be used as an input to further UIA actions within this window.
Element name	ElementName	string	The UIA name of the window element.
Element class name	ElementClassName	string	The UIA class name of the window element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the window element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the window element.

Wait for UIA process main window

Operation ID:

UIAWaitForProcessMainWindow

A simple and fast Win32 action which waits for a specified time for the main window of a process (specified by name) to exist before returning a handle. The 'Main' window is typically the main application window: a login dialog or sub-window is generally not the 'Main' window. It is recommended to use the action 'Wait for desktop element' which is more powerful.

Parameters

Name	Key	Required	Type	Description
Search process name	SearchProcessName	True	string	The name of the process to search for, e.g. notepad.
Seconds to wait	SecondsToWait	True	integer	The maximum number of seconds to wait for the process main window.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Window handle	WindowHandle	integer	The UIA handle for the window. This can be used as an input to further UIA actions within this window.
Element name	ElementName	string	The UIA name of the window element.
Element class name	ElementClassName	string	The UIA class name of the window element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the window element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the window element.
Element exists	ElementExists	boolean	Returns true if the window exists or false if not.

Wait for UIA top level Win32 window

Operation ID:

UIAWaitForTopLevelWindow

A simple and fast Win32 action which waits for a specified time for a top-level window to exist before returning a handle. A top-level window is one that is directly connected to the desktop. It is recommended to use the action 'Wait for desktop element' which is more powerful.

Parameters

Name	Key	Required	Type	Description
Search class name	SearchClassName		string	The element class name of the top level window to search for, e.g. 'Notepad'.
Search window title	SearchWindowTitle		string	The title of the top level window to search for.
Seconds to wait	SecondsToWait	True	integer
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Window handle	WindowHandle	integer	The UIA handle for the window. This can be used as an input to further UIA actions within this window.
Element name	ElementName	string	The UIA name of the window element.
Element class name	ElementClassName	string	The UIA class name of the window element.
Element automation Id	ElementAutomationId	string	The UIA automation Id of the window element.
Element localized control type	ElementLocalizedControlType	string	The UIA localized control type of the window element.
Element exists	ElementExists	boolean	Returns true if the window exists or false if not.