IA-Connect Web Browser (Preview)

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

This connector is available in the following products and regions:

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

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

Prerequisites

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

The IA-Connect software consists of two main components:

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

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

Available IA-Connect Connectors

The available IA-Connect Connectors are:

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

How to get credentials

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

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

Get started with your connector

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

Support

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

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

Known issues, common errors and FAQs

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

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

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

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

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Check multiple web elements

Checks / ticks multiple HTML elements (typically a checkbox or radio box).

Check web element

Checks / ticks a HTML element (typically a checkbox or radio box).

Clear all web element text

Clears all existing text from a web element.

Click web element

Clicks an element (typically a button or hyperlink) in the web browser.

Close active web browser tab

Closes the current active browser tab. After calling this action the IA-Connect Agent will not switch to a new active tab by default. To re-attach to another tab you will need to the call 'Set browser tab' action before attempting to interact with the page.

Close Chromium Edge browser

Closes the Chromium Edge browser which was opened using the 'Open Chromium Edge' action.

Close Google Chrome browser

Closes the Google Chrome web browser which was opened using the 'Open Chrome' action.

Close Internet Explorer browser

Closes the Internet Explorer browser which was opened using the 'Open Internet Explorer' action.

Copy selected text on web element

Copies all of the currently selected text from a web element into the clipboard.

Create handle to parent web element

Creates a handle to a HTML elements parent.

Create handle to web element

Creates a handle to a HTML element. This handle can be used to automate child HTML elements.

Deselect all items in web selection list

Deselects all currently selected options in a select element that supports multi-select.

Deselect web selection list item

Deselects an option on a select HTML element, either by Text, Value or Index. The text, value or index of each option in a selection can be discovered using the 'Get selection properties' action.

Does web element exist

Reports whether a HTML element currently exists. This action does not wait for the HTML element.

Draw rectangle around web element

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

Execute JavaScript in webpage

Executes the provided JavaScript code in the web page.

Execute JavaScript on web element

Executes the provided JavaScript code on the selected HTML element.

Focus web element

Focusses an HTML element. This makes the element the active element for keyboard focus and may bring the element to the foreground.

Fullscreen active browser

Sets the web browser to full screen so the website occupies the entire screen (hides the browser navigation toolbar, address bar, start bar etc).

Get browser parent window details

Returns properties of the browser parent window that the IA-Connect Agent is currently interacting with.

Get ChromeDriver folder

Gets the ChromeDriver folder path for the ChromeDriver version that is used with the current Chrome EXE version. This is used by the 'Open Chrome' action and it is unlikely that you would need to call this directly.

Get Chromium Edge driver folder

Gets the ChromiumEdgeDriver folder path for the ChromiumEdgeDriver version that is used with the current Chromium Edge EXE version. This is used by the 'Open Chromium Edge' action and it is unlikely that you would need to call this directly.

Get Chromium Edge EXE version from file

Gets the version of Chromium Edge installed in the session where the Agent is running.

Get current webpage frame window pixel coordinate

Returns the pixel coordinates of the current HTML frame, relative to the browser document window (the area which displays the webpage).

Get Google Chrome EXE version from file

Gets the version of Google Chrome installed in the session where the Agent is running.

Get multiple web element properties

Gets the properties of all HTML elements that matches search criteria.

Get web browser tabs

Returns the current tabs that are open in the browser window.

Get web element bounding rectangle

Returns the pixel coordinates of the left, right, top, and bottom edges of the HTML element relative to the browser document window (the area which displays the webpage).

Get web element children properties

Gets the properties of the child elements of the matching HTML element.

Get web element parents properties

Gets the properties of the parent elements of the matching HTML element.

Get web element properties

Gets the properties of a HTML element.

Get web element screen bounding rect

Returns the pixel coordinates of the left, right, top, and bottom edges of the HTML element relative to the sessions screen.

Get web selection list properties

Returns all the options of a select HTML element and their properties.

Get web table contents

Returns the contents of a HTML table element.

Get webpage text

Gets all the text on the current page by selecting the entire browser page, copying it into the clipboard in the session where the IA-Connect Agent is running and then returning the clipboard contents.

Global mouse left click on web element

Moves the mouse to the centre of an HTML element and presses the left mouse button. This is sometimes used instead of 'Click element' in scenarios where the element expects the mouse to be over the element before you press it.

Global mouse right click on web element

Moves the mouse to the centre of an HTML element and presses the right mouse button. This is sometimes used instead of 'Click element' in scenarios where the element expects the mouse to be over the element before you press it.

Input password into web element

Inputs a password into a HTML element (typically a text input field), either replacing the existing value or appending the new value to any existing value.

Input text into multiple web elements

Inputs text into multiple HTML elements (typically text input fields), either replacing the existing text or appending the new value to any existing value.

Input text into web element

Inputs text into a HTML element (typically a text input field), either replacing the existing text or appending the new value to any existing value.

Is suitable remote ChromeDriver available

Searches for a suitable version of ChromeDriver for the installed version of Google Chrome in the session where the IA-Connect Agent is running.

Is suitable remote Chromium Edge driver available

Searches for a suitable version of ChromiumEdgeDriver for the installed version of Chromium Edge in the session where the Agent is running.

JavaScript simulate click on web element

Simulates a mouse action by telling the browser's JavaScript engine to perform a left click. This is an alternative to the action 'Simulate mouse left click on element' and is usually sufficient for the web page to react as expected.

Maximise active browser

Maximises the web browser currently being controlled (the last browser opened using a browser 'Open' action).

Minimise active browser

Minimises the web browser currently being controlled (the last browser opened using a browser 'Open' action).

Navigate active browser to URL

Navigates the browser to the provided URL. IA-Connect will wait for the page to load before returning.

Normalise active browser

Normalises the browser window by resizing window to the provided dimensions and moving the window to the provided coordinates.

Open Chromium Edge browser

Opens the Chromium Edge web browser, allowing it to to be automated using the actions in this IA-Connect module. If the web browser was opened manually, by another application or using the 'Run Process' action then it can only be automated using UIA actions and not by the actions in this IA-Connect module.

Open Google Chrome browser

Opens the Google Chrome web browser, allowing it to to be automated using the actions in this IA-Connect module. If the web browser was opened manually, by another application or using the 'Run Process' action then it can only be automated using UIA actions and not by the actions in this IA-Connect module.

Open Internet Explorer browser

Opens the Internet Explorer web browser, allowing it to to be automated using the actions in this IA-Connect module. If the web browser was opened manually, by another application or using the 'Run Process' action then it can only be automated using UIA actions and not by the actions in this IA-Connect module.

Open new web browser tab

Opens a new tab in the browser window. In Internet Explorer, this action opens a new window but the new window behaves as a tab and can be interacted with in the same way as a tab with the 'Get browser tabs' or 'Set browser tab' actions.

Paste into web element

Pastes the contents of the clipboard into a HTML element (typically a text input field).

Press CTRL key on web element

Presses the CTRL key on a HTML element. This can be used with the 'Control key' parameter to perform shortcuts such as Ctrl-a (Select all), Ctrl-c (Copy), Ctrl-x (Cut) or Ctrl-v (Paste).

Press enter on web element

Presses the enter key on an HTML element. This can be used to submit the element or in some cases to interact with buttons.

Print the current web page

Prints the current web page.

Refresh current webpage in active browser

Refreshes the current browser page.

Reset all web element handles

Resets all web element handles that are currently held by the IA-Connect Agent. This action is generally used for memory clean-up and is only recommended for use in large complex processes which will result in high numbers of element handles (10,000+) being stored.

Reset browser webpage frame stack

Resets the browser frame stack. This should only be used if approved by Ultima Technical Support.

Save webpage to file

Saves the current HTML page to a file on disk.

Scroll browser window by pixels

Scrolls the browser window by the specified number of pixels.

Scroll browser window to pixels

Scrolls the browser window to the specified pixel coordinates.

Scroll web element into view

Scrolls the web page up, down, left or right until the HTML element is on screen.

Select all on a web element

Selects all of the contents of a HTML element (typically a text field).

Select web selection list item

Selects an option on a select HTML element, either by Text, Value or Index. The text, value or index of each option in a selection can be discovered using the 'Get selection properties' action.

Set active browser window position

Moves the browser window to the pixel coordinates specified.

Set active browser window size

Resizes the browser window to the width and height dimensions specified.

Set browser timeouts

Sets the internal timeouts that IA-Connect uses when interacting with the web browser.

Set web browser tab

Sets the active tab and switches the IA-Connect Agent to control this tab so that it can interact with it.

Simulate mouse left click on web element

Simulates a mouse action by telling the browser that a mouse left click action was performed. This is usually sufficient for the web page to react as expected. If this fails, consider using 'Global mouse left click on element' which moves the mouse and clicks in exactly the same way as a user would.

Simulate mouse right click on web element

Simulates a mouse action by telling the browser that a mouse right click action was performed. This is usually sufficient for the web page to react as expected. If this fails, consider using 'Global mouse right click on element' which moves the mouse and clicks in exactly the same way as a user would.

Submit web element

Submits a HTML element. This is typically performed on any input element in a form element and will cause the form to be submitted.

Switch to webpage frame

Switches the IA-Connect Agent to controlling or interacting with an alternative frame within a browser page.

Switch to webpage parent frame

Switches the IA-Connect Agent to controlling or interacting with the parent frame of the current frame within a web page.

Switch to webpage root frame

Switches the IA-Connect Agent to controlling or interacting with the root frame within a web page.

Upload new ChromeDriver

Uploads a new version of ChromeDriver from the local system (the digital worker) to the IA-Connect Agent session to be used with Google Chrome.

Upload new Chromium Edge driver

Uploads a new version of ChromiumEdgeDriver from the local system (the digital worker) to the IA-Connect Agent session to be used with Chromium Edge.

Check multiple web elements

Checks / ticks multiple HTML elements (typically a checkbox or radio box).

Parameters

Name Key Required Type Description
Input elements as JSON
InputElementsJSON True string

The properties of the HTML elements to check, in JSON format.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Check web element

Checks / ticks a HTML element (typically a checkbox or radio box).

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Check element
CheckElement boolean

Set to true to check / tick an element or false to uncheck / untick.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Clear all web element text

Clears all existing text from a web element.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Previous value
PreviousValue string

The previous value of the matching element before it was cleared.

Click web element

Clicks an element (typically a button or hyperlink) in the web browser.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Close active web browser tab

Closes the current active browser tab. After calling this action the IA-Connect Agent will not switch to a new active tab by default. To re-attach to another tab you will need to the call 'Set browser tab' action before attempting to interact with the page.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Close Chromium Edge browser

Closes the Chromium Edge browser which was opened using the 'Open Chromium Edge' action.

Parameters

Name Key Required Type Description
Purge dynamic user data dir
PurgeDynamicUserDataDir boolean

Should a dynamic user data directory be purged when closing Chromium Edge? By default this is set to true as a dynamic user data directory is generated when Chromium Edge is not using a specific user profile and is designed for one time use.

Purge static user data dir
PurgeStaticUserDataDir boolean

Should a static user data directory be purged when closing Chromium Edge? By default this is set to false as a static user data directory is used when Chromium Edge is using a specific user profile and can be re-used between Chromium Edge sessions.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Close Google Chrome browser

Closes the Google Chrome web browser which was opened using the 'Open Chrome' action.

Parameters

Name Key Required Type Description
Purge dynamic user data dir
PurgeDynamicUserDataDir boolean

Should a dynamic user data directory be purged when closing Chrome? By default this is set to true as a dynamic user data directory is generated when Chrome is not using a specific user profile and is designed for one time use.

Purge static user data dir
PurgeStaticUserDataDir boolean

Should a static user data directory be purged when closing Chrome? By default this is set to false as a static user data directory is used when Chrome is using a specific user profile and can be re-used between Chrome sessions.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Close Internet Explorer browser

Closes the Internet Explorer browser which was opened using the 'Open Internet Explorer' action.

Parameters

Name Key Required Type Description
Unload IE driver
UnloadIEDriver boolean

Should the IE driver be unloaded when IA-Connect Agent closes Internet Explorer? This is typically unnecessary and should only be used if approved by Ultima Technical Support.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Copy selected text on web element

Copies all of the currently selected text from a web element into the clipboard.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Create handle to parent web element

Creates a handle to a HTML elements parent.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element handle
ElementHandle double

The handle for the matching element. This can be used as an input to further actions acting on this element.

Element tag name
ElementTagName string

The HTML tag name of the matching elementd.

Create handle to web element

Creates a handle to a HTML element. This handle can be used to automate child HTML elements.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element handle
ElementHandle double

The handle for the matching element. This can be used as an input to further actions acting on this element.

Element tag name
ElementTagName string

The HTML tag name of the matching element.

Deselect all items in web selection list

Deselects all currently selected options in a select element that supports multi-select.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Deselect web selection list item

Deselects an option on a select HTML element, either by Text, Value or Index. The text, value or index of each option in a selection can be discovered using the 'Get selection properties' action.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Value to deselect
ValueToDeselect string

The value of the selection option to deselect.

Text to deselect
TextToDeselect string

The text value of the selection option to deselect.

Index to deselect
IndexToDeselect double

The index of the selection option to deselect.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Does web element exist

Reports whether a HTML element currently exists. This action does not wait for the HTML element.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element exists
ElementExists boolean

Returns true if a matching element exists or false if not.

Draw rectangle around web element

Draws a rectangle around the perimeter of a HTML 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 Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Pen colour
PenColour string

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

Pen thickness pixels
PenThicknessPixels integer

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

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Execute JavaScript in webpage

Executes the provided JavaScript code in the web page.

Parameters

Name Key Required Type Description
JavaScript code
JavaScriptCode True string

The JavaScript code to be executed in the web page.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
JavaScript response
JavaScriptResponse string

The JavaScript response message received after executing the code.

Execute JavaScript on web element

Executes the provided JavaScript code on the selected HTML element.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

JavaScript code
JavaScriptToExecute True string

The JavaScript code to be executed on the matching element.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
JavaScript response
JavaScriptResponse string

The JavaScript response message received after executing the code.

Focus web element

Focusses an HTML element. This makes the element the active element for keyboard focus and may bring the element to the foreground.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Fullscreen active browser

Sets the web browser to full screen so the website occupies the entire screen (hides the browser navigation toolbar, address bar, start bar etc).

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Get browser parent window details

Returns properties of the browser parent window that the IA-Connect Agent is currently interacting with.

Parameters

Name Key Required Type Description
Browser process Id
BrowserPID integer

The optional process ID of the running browser process. If this parameter is not specified then IA-Connect will use the process ID of the last browser process that was launched.

Search document element class name
SearchDocumentElementClassName string

The optional UIA element class name of the browser document element.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Browser parent window element name
MainWindowElementName string

The HTML name of the browser parent window element.

Browser parent window element class name
MainWindowElementClassName string

The HTML class name of the browser parent window element.

Browser parent window element left X pixels
MainWindowLeftXPixels integer

The X coordinate of the browser parent window element left edge in pixels.

Browser parent window element top Y pixels
MainWindowTopYPixels integer

The Y coordinate of the browser parent window element top edge in pixels.

Browser parent window element width pixels
MainWindowWidthPixels integer

The width of the browser parent window element in pixels.

Browser parent window element height pixels
MainWindowHeightPixels integer

The height of the browser parent window element in pixels.

Browser document element name
DocumentElementName string

The HTML name of the browser document element.

Browser document element class name
DocumentElementClassName string

The HTML class name of the browser document element.

Browser document element left X pixels
DocumentLeftXPixels integer

The X coordinate of the browser document element left edge in pixels.

Browser document element top Y pixels
DocumentTopYPixels integer

The Y coordinate of the browser document element top edge in pixels.

Browser document element width pixels
DocumentWidthPixels integer

The width of the browser document element in pixels.

Browser document element height pixels
DocumentHeightPixels integer

The height of the browser document element in pixels.

Get ChromeDriver folder

Gets the ChromeDriver folder path for the ChromeDriver version that is used with the current Chrome EXE version. This is used by the 'Open Chrome' action and it is unlikely that you would need to call this directly.

Parameters

Name Key Required Type Description
ChromeDriver parent folder
DirectoryPath True string

The parent folder which contains a ChromeDriver folder (which itself contains the ChromeDriver.exe) for the major version of Chrome.

Chrome EXE major version
ChromeMajorVersion integer

The major version of the Chrome browser (e.g. 91) installed in the session where the Agent is running.

Chrome EXE path
ChromeBrowserEXE string

An optional path to the Chrome.exe, if this is not installed in the default location (or you are using a Dev or Canary version of Chrome).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
ChromeDriver folder
ChromeDriverFolder string

The folder path containing the correct version of ChromeDriver.exe for the Chrome browser major version.

Get Chromium Edge driver folder

Gets the ChromiumEdgeDriver folder path for the ChromiumEdgeDriver version that is used with the current Chromium Edge EXE version. This is used by the 'Open Chromium Edge' action and it is unlikely that you would need to call this directly.

Parameters

Name Key Required Type Description
Chromium Edge driver parent folder
DirectoryPath True string

The parent folder which contains a msedgedriver folder (which itself contains the msedgedriver.exe) for the version of major version of Chromium Edge.

Chromium Edge EXE major version
ChromiumEdgeMajorVersion integer

The major version of the Chromium Edge browser (e.g. 91) installed in the session where the Agent is running.

Chromium Edge EXE path
ChromiumEdgeBrowserEXE string

An optional path to the msedge.exe if this is not installed in the default location (or you are using a Dev or Canary version of Chromium Edge).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
ChromiumEdgeDriver folder
ChromiumEdgeDriverFolder string

The folder path containing the correct version of msedgedriver.exe for the Chromium Edge browser major version.

Get Chromium Edge EXE version from file

Gets the version of Chromium Edge installed in the session where the Agent is running.

Parameters

Name Key Required Type Description
Chromium Edge EXE path
ChromiumEdgeBrowserEXE string

An optional path to the msedge.exe if this is not installed in the default location (or you are using a Dev or Canary version of Chromium Edge).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Chromium Edge EXE file version
ChromiumEdgeBrowserFileVersion string

The version of the msedge.exe file installed in the session where the IA-Connect Agent is running.

Chromium Edge EXE major version
ChromiumEdgeBrowserMajorVersion integer

The major version of the Chromium Edge browser (e.g. 91) installed in the session where the IA-Connect Agent is running.

Get current webpage frame window pixel coordinate

Returns the pixel coordinates of the current HTML frame, relative to the browser document window (the area which displays the webpage).

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
X
X integer

The X coordinate in pixels of the top left corner of the current HTML frame, relative to the browser document window.

Y
Y integer

The Y coordinate in pixels of the top left corner of the current HTML frame, relative to the browser document window.

Width
Width integer

The width of the current HTML frame.

Height
Height integer

The height of the current HTML frame.

Get Google Chrome EXE version from file

Gets the version of Google Chrome installed in the session where the Agent is running.

Parameters

Name Key Required Type Description
Chrome EXE path
ChromeBrowserEXE string

An optional path to the Chrome.exe, if this is not installed in the default location (or you are using a Dev or Canary version of Chrome).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Chrome EXE file version
ChromeBrowserFileVersion string

The version of the Chrome.exe file installed in the session where the IA-Connect Agent is running.

Chrome EXE major version
ChromeBrowserMajorVersion integer

The major version of the Chrome browser (e.g. 91) installed in the session where the IA-Connect Agent is running.

Get multiple web element properties

Gets the properties of all HTML elements that matches search criteria.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Get HTML code
GetHTMLCode boolean

Should the HTML code (both Inner and Outer) for the elements be returned?

Create handle
CreateHandle boolean

Should IA-Connect return an element handle for any matching elements? This could be used as an input to further actions acting on this element.

Return value
ReturnValue boolean

Should IA-Connect return the HTML value of each matching element?

Return text
ReturnText boolean

Should IA-Connect return the HTML text value of each matching element?

Max value length
MaxValueLength integer

The maximum number of characters from the HTML value to be returned. This is useful to limit the amount of data returned if the HTML elements have long values. If set to 0, the entire value will be returned.

Max text length
MaxTextLength integer

The maximum number of characters from the HTML text value to be returned. This is useful to limit the amount of data returned if the HTML elements have long text values. If set to 0, the entire text value will be returned.

Return is displayed
ReturnIsDisplayed boolean

Should IA-Connect return whether each matching element is displayed?

Return coordinates
ReturnCoordinates boolean

Should IA-Connect return the coordinates of each matching element?

Return dimensions
ReturnDimensions boolean

Should IA-Connect return the height and width of each matching element?

Return child element count
ReturnChildElementCount boolean

Should IA-Connect return the child element count of each matching element?

Return parent tag
ReturnParentTag boolean

Should IA-Connect return the HTML tag of the parent of each matching element?

First item to return
FirstItemToReturn integer

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

Max items to return
MaxItemsToReturn integer

The maximum number of elements to return, or 0 for all elements.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of elements found
NumberOfElementsFound double

The number of elements found that matched the search criteria.

Element properties
ElementProperties array of object

A list of all elements that matched the search criteria.

items
ElementProperties object
More elements available
MoreElementsAvailable boolean

The number of additional elements that matched the search criteria but were not returned (e.g. the search was limited by the 'Max items to return' parameter).

Get web browser tabs

Returns the current tabs that are open in the browser window.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of tabs
NumberOfTabs integer

The number of tabs that are currently open in the browser window.

Current tab handle
CurrentTabHandle string

An internal browser tab handle string.

Browser tabs as JSON
BrowserTabsJSON string

The properties of the open browser tabs, in JSON format.

Get web element bounding rectangle

Returns the pixel coordinates of the left, right, top, and bottom edges of the HTML element relative to the browser document window (the area which displays the webpage).

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element left pixels
ElementLeftPixels double

The coordinate of the element left edge in pixels, relative to the parent browser window.

Element right pixels
ElementRightPixels double

The coordinate of the element right edge in pixels, relative to the parent browser window.

Element top pixels
ElementTopPixels double

The coordinate of the element top edge in pixels, relative to the parent browser window.

Element bottom pixels
ElementBottomPixels double

The coordinate of the element bottom edge in pixels, relative to the parent browser window.

Element center X pixels
ElementCenterXPixels double

The X coordinate of the center of the element in pixels, relative to the parent browser window.

Element center Y pixels
ElementCenterYPixels double

The Y coordinate of the center of the element in pixels, relative to the parent browser window.

Get web element children properties

Gets the properties of the child elements of the matching HTML element.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Get HTML code
GetHTMLCode boolean

Should the HTML code (both Inner and Outer) for the elements be returned?

Create handle
CreateHandle boolean

Should IA-Connect return an element handle for the child elements? This could be used as an input to further actions acting on this element.

Search sub tree
SearchSubTree boolean

If set to true then the whole HTML tree below the parent element handle will be searched. This is more thorough but can take longer. If set to false, only elements directly below the parent element handle in the HTML tree will be searched.

Return value
ReturnValue boolean

Should IA-Connect return the HTML value of each matching element?

Return text
ReturnText boolean

Should IA-Connect return the HTML text value of each matching element?

Max value length
MaxValueLength integer

The maximum number of characters from the HTML value to be returned. This is useful to limit the amount of data returned if the HTML elements have long values. If set to 0, the entire value will be returned.

Max text length
MaxTextLength integer

The maximum number of characters from the HTML text value to be returned. This is useful to limit the amount of data returned if the HTML elements have long text values. If set to 0, the entire text value will be returned.

Return is displayed
ReturnIsDisplayed boolean

Should IA-Connect return whether each matching element is displayed?

Return coordinates
ReturnCoordinates boolean

Should IA-Connect return the coordinates of each matching element?

Return dimensions
ReturnDimensions boolean

Should IA-Connect return the height and width of each matching element?

Return child element count
ReturnChildElementCount boolean

Should IA-Connect return the child element count of each matching element?

Return parent tag
ReturnParentTag boolean

Should IA-Connect return the HTML tag of the parent of each matching element?

First item to return
FirstItemToReturn integer

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

Max items to return
MaxItemsToReturn integer

The maximum number of elements to return, or 0 for all elements.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of elements found
NumberOfElementsFound double

The number of child elements found for the element that matched the search criteria.

Element properties
ElementProperties array of object

A list of all child elements for the element that matched the search criteria.

items
ElementProperties object
More elements available
MoreElementsAvailable boolean

The number of additional child elements for the element that matched the search criteria but were not returned (e.g. the search was limited by the 'Max items to return' parameter).

Get web element parents properties

Gets the properties of the parent elements of the matching HTML element.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Get HTML code
GetHTMLCode boolean

Should the HTML code (both Inner and Outer) for the elements be returned?

Create handle
CreateHandle boolean

Should IA-Connect return an element handle for the parent elements? This could be used as an input to further actions acting on this element.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of elements found
NumberOfElementsFound double

The number of parent elements found for the element that matched the search criteria.

Element properties
ElementProperties array of object

A list of all parent elements for the element that matched the search criteria.

items
ElementProperties object

Get web element properties

Gets the properties of a HTML element.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Get HTML code
GetHTMLCode boolean

Should the HTML code (both Inner and Outer) for the elements be returned?

Return Element handle
ReturnElementHandle boolean

Should IA-Connect return an element handle for any matching elements? This could be used as an input to further actions acting on this element.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element name
ElementName string

The HTML name of the matching element.

Element ID
ElementID string

The HTML ID of the matching element.

Element tag name
ElementTagName string

The HTML tag name of the matching element.

Element class name
ElementClassName string

The HTML class name of the matching element.

Element value
ElementValue string

The HTML value of the matching element.

Element text
ElementText string

The HTML text value of the matching element.

Element enabled
ElementEnabled boolean

Returns true if the matching element is enabled or false if not.

Element displayed
ElementDisplayed boolean

Returns true if the matching element is displayed or false if not.

Element X coordinate
ElementXCoordinate double

The X coordinate of the top left corner of the matching element in pixels.

Element Y coordinate
ElementYCoordinate double

The Y coordinate of the top left corner of the matching element in pixels.

Element width
ElementWidth double

The element width in pixels.

Element height
ElementHeight double

The element height in pixels.

Element selected
ElementSelected boolean

Returns true if the matching element is selected or false if not.

Element type
ElementType string

The HTML type of the matching element.

Inner HTML
InnerHTML string

The inner HTML code of the matching element, containing all direct child elements. This property is only returned if the 'Get HTML code' parameter is set to true.

Outer HTML
OuterHTML string

The outer HTML code of the matching element, containing all direct child elements and the matching element code. This property is only returned if the 'Get HTML code' parameter is set to true.

Child element count
ChildElementCount double

The number of direct child elements found for the matching element.

Parent tag name
ParentTagName string

The HTML tag name of the parent element of the matching element.

Element handle
ElementHandle double

The handle for the matching element. This can be used as an input to further actions acting on this element.

Get web element screen bounding rect

Returns the pixel coordinates of the left, right, top, and bottom edges of the HTML element relative to the sessions screen.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element screen left pixels
ElementScreenLeftPixels double

The coordinate of the element left edge in pixels, relative to the sessions screen.

Element screen right pixels
ElementScreenRightPixels double

The coordinate of the element right edge in pixels, relative to the sessions screen.

Element screen top pixels
ElementScreenTopPixels double

The coordinate of the element top edge in pixels, relative to the sessions screen.

Element screen bottom pixels
ElementScreenBottomPixels double

The coordinate of the element bottom edge in pixels, relative to the sessions screen.

Element screen center X pixels
ElementScreenCenterXPixels double

The X coordinate of the center of the element in pixels, relative to the sessions screen.

Element screen center Y pixels
ElementScreenCenterYPixels double

The Y coordinate of the center of the element in pixels, relative to the sessions screen.

Element is onscreen
ElementIsOnscreen boolean

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

Offscreen direction
OffscreenDirection string

If the element is not currently on screen then this will return the offscreen direction (top, bottom, left or right).

Get web selection list properties

Returns all the options of a select HTML element and their properties.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Selected option text
SelectedOptionText string

The text value of the currently selected option.

Selected option value
SelectedOptionValue string

The value of the currently selected option.

Number of options
NumberOfOptions double

The number of options available to be selected.

Selection options
SelectionOptions array of object

A collection containing all available option values and whether the option is currently selected.

items
SelectionOptions object

Get web table contents

Returns the contents of a HTML table element.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Create column names from row
CreateColumnNamesFromRow double

The index number of the row that should be used to create the column headers in the output.

Merge child tables
MergeChildTables boolean

Should any child tables be merged into the output?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of rows
NumberOfRows double

The number of rows in the HTML table

Number of columns
NumberOfColumns double

The number of columns in the HTML table

Table contents JSON
TableContentsJSON string

The content of the HTML table, in JSON format

Get webpage text

Gets all the text on the current page by selecting the entire browser page, copying it into the clipboard in the session where the IA-Connect Agent is running and then returning the clipboard contents.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Page text
PageText string

Returns all of the text on the current page.

Global mouse left click on web element

Moves the mouse to the centre of an HTML element and presses the left mouse button. This is sometimes used instead of 'Click element' in scenarios where the element expects the mouse to be over the element before you press it.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Click offset X
ClickOffsetX integer

An optional value in pixels to offset the click from the centre of the matching element. To click further to the right, provide a positive value and to click further to the left, provide a negative value. By default, this is set to 0.

Click offset Y
ClickOffsetY integer

An optional value in pixels to offset the click from the centre of the matching element. To click further down, provide a positive value and to click further up, provide a negative value. By default, this is set to 0.

Focus first
FocusFirst boolean

Should the HTML element be focused first before attempting to click?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global mouse right click on web element

Moves the mouse to the centre of an HTML element and presses the right mouse button. This is sometimes used instead of 'Click element' in scenarios where the element expects the mouse to be over the element before you press it.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Click offset X
ClickOffsetX integer

An optional value in pixels to offset the click from the centre of the matching element. To click further to the right, provide a positive value and to click further to the left, provide a negative value. By default, this is set to 0.

Click offset Y
ClickOffsetY integer

An optional value in pixels to offset the click from the centre of the matching element. To click further down, provide a positive value and to click further up, provide a negative value. By default, this is set to 0.

Focus first
FocusFirst boolean

Should the HTML element be focused first before attempting to click?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Input password into web element

Inputs a password into a HTML element (typically a text input field), either replacing the existing value or appending the new value to any existing value.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Password to input
PasswordToInput True password

The password value to enter into the matching element. If the 'Reset existing value' parameter is set to true then any existing text in the element will be overwritten. If the 'Reset existing value' parameter is set to false, then this will be appended to the existing text.

Reset existing value
ResetExistingValue boolean

Should any existing text in the matching element be removed? By default, this is set to true.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Input text into multiple web elements

Inputs text into multiple HTML elements (typically text input fields), either replacing the existing text or appending the new value to any existing value.

Parameters

Name Key Required Type Description
Input elements as JSON
InputElementsJSON True string

The properties of the HTML elements to input text into, in JSON format.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Input text into web element

Inputs text into a HTML element (typically a text input field), either replacing the existing text or appending the new value to any existing value.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Text to input
TextToInput True string

The text value to enter into the matching element. If the 'Reset existing value' parameter is set to true then any existing text in the element will be overwritten. If the 'Reset existing value' parameter is set to false, then this will be appended to the existing text.

Reset existing value
ResetExistingValue boolean

Should any existing text in the matching element be removed? By default, this is set to true.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Previous value
PreviousValue string

The previous value of the matching element before text was input.

Is suitable remote ChromeDriver available

Searches for a suitable version of ChromeDriver for the installed version of Google Chrome in the session where the IA-Connect Agent is running.

Parameters

Name Key Required Type Description
Chrome driver parent folder
ChromeDriverFolder string

The parent folder which contains a ChromeDriver folder (which itself contains the ChromeDriver.exe) for the major version of Chrome.

Chrome EXE path
ChromeBrowserEXE string

An optional path to the Chrome.exe, if this is not installed in the default location (or you are using a Dev or Canary version of Chrome).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Chrome EXE file version
ChromeBrowserFileVersion string

The version of the Chrome.exe file installed in the session where the IA-Connect Agent is running.

Chrome EXE major version
ChromeBrowserMajorVersion integer

The major version of the Chrome browser (e.g. 91) installed in the session where the IA-Connect Agent is running.

Suitable ChromeDriver available
SuitableChromeDriverAvailable boolean

Returns true if a suitable version of ChromeDriver can be found for the installed version of Google Chrome in the session where the Agent is running.

Suitable ChromeDriver path
SuitableChromeDriverPath string

The file path to the suitable version of ChromeDriver for the installed version of Google Chrome in the session where the Agent is running.

Is suitable remote Chromium Edge driver available

Searches for a suitable version of ChromiumEdgeDriver for the installed version of Chromium Edge in the session where the Agent is running.

Parameters

Name Key Required Type Description
Chromium Edge driver parent folder
ChromiumEdgeDriverFolder string

The parent folder which contains a msedgedriver folder (which itself contains the msedgedriver.exe) for the version of major version of Chromium Edge.

Chromium Edge EXE path
ChromiumEdgeBrowserEXE string

An optional path to the msedge.exe if this is not installed in the default location (or you are using a Dev or Canary version of Chromium Edge).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Chromium Edge EXE file version
ChromiumEdgeBrowserFileVersion string

The version of the msedge.exe file installed in the session where the IA-Connect Agent is running.

Chromium Edge EXE major version
ChromiumEdgeBrowserMajorVersion integer

The major version of the Chromium Edge browser (e.g. 91) installed in the session where the IA-Connect Agent is running.

Suitable ChromiumEdgeDriver available
SuitableChromiumEdgeDriverAvailable boolean

Returns true if a suitable version of ChromiumEdgeDriver can be found for the installed version of Chromium Edge in the session where the Agent is running.

Suitable ChromiumEdgeDriver path
SuitableChromiumEdgeDriverPath string

The file path to the suitable version of ChromiumEdgeDriver for the installed version of Chromium Edge in the session where the Agent is running.

JavaScript simulate click on web element

Simulates a mouse action by telling the browser's JavaScript engine to perform a left click. This is an alternative to the action 'Simulate mouse left click on element' and is usually sufficient for the web page to react as expected.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Maximise active browser

Maximises the web browser currently being controlled (the last browser opened using a browser 'Open' action).

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Minimise active browser

Minimises the web browser currently being controlled (the last browser opened using a browser 'Open' action).

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Navigates the browser to the provided URL. IA-Connect will wait for the page to load before returning.

Parameters

Name Key Required Type Description
URL
URL True string

The URL of the page to be navigated to.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Page title
PageTitle string

The title of the page once it has loaded.

Page URL
PageURL string

The URL of the page once it has loaded.

Normalise active browser

Normalises the browser window by resizing window to the provided dimensions and moving the window to the provided coordinates.

Parameters

Name Key Required Type Description
X
X integer

The X coordinate in pixels of the top left corner of the browser window.

Y
Y integer

The Y coordinate in pixels of the top left corner of the browser window.

Width
Width integer

The width of the browser window.

Height
Height integer

The height of the browser window.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Open Chromium Edge browser

Opens the Chromium Edge web browser, allowing it to to be automated using the actions in this IA-Connect module. If the web browser was opened manually, by another application or using the 'Run Process' action then it can only be automated using UIA actions and not by the actions in this IA-Connect module.

Parameters

Name Key Required Type Description
Chromium Edge driver folder
ChromiumEdgeDriverFolder string

The folder path containing the correct version of msedgedriver.exe for the Chromium Edge browser major version in the IA-Connect Agent session.

User data directory
UserDataDir string

An optional path to the Chromium Edge user data directory if it has been changed from the default (normally this is '%LOCALAPPDATA%\Microsoft\Edge\User Data').

Kill existing Chromium Edge driver
KillExistingChromiumEdgeDriver boolean

Should any existing instances of msedgedriver.exe be killed when Chromium Edge is opened?

Print to default printer
PrintToDefaultPrinter boolean

Should Chromium Edge print to the default printer in the IA-Connect Agent session automatically without displaying a print dialog? The default printer can be changed using the 'Set default printer' action in the IA-Connect Environment / Session actions.

Default download directory
DefaultDownloadDirectory string

An optional path to a default download directory where all downloads will be saved to.

Download PDF instead of opening
DownloadPDFInsteadOfOpening boolean

Should PDF files automatically be downloaded instead of opening them?

Chromium Edge driver log filename
ChromiumEdgeDriverLogFilename string

An optional path to the location where msedgedriver log files will be stored.

Local Chromium Edge driver folder
LocalChromiumEdgeDriverFolder string

The folder path in the local session (where the IA-Connect Director is running) to the folder containing the correct version of msedgedriver.exe for the Chromium Edge browser major version. This will be automatically uploaded to the IA-Connect Agent session and should only be used when running the IA-Connect Agent in a Citrix or RDP session.

Hide browser is being automated message
HideBrowserIsBeingAutomatedMessage boolean

Should the 'Browser is being automated' message that is displayed by Chromium Edge be hidden?

Chromium Edge EXE path
ChromiumEdgeBrowserEXE string

An optional path to the msedge.exe if this is not installed in the default location (or you are using a Dev or Canary version of Chromium Edge).

Ignore certificate errors
IgnoreCertificateErrors boolean

Should Chromium Edge ignore webpage certificate errors?

Additional arguments
AdditionalArguments string

An optional space separated list of additional arguments to pass to the browser. A full list of command line switches can be found on the Chromium website.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
ChromiumEdgeDriver process Id
ChromiumEdgeDriverPID integer

The process ID of the msedgedriver process that has been launched.

ChromiumEdgeDriver TCP port
ChromiumEdgeDriverTCPPort integer

The TCP port that msedgedriver is listening on to receive requests from the IA-Connect Agent.

Chromium Edge process Id
ChromiumEdgePID integer

The process ID of the Chromium Edge process that has been launched.

Chromium Edge TCP port
ChromiumEdgeTCPPort integer

The TCP port that Chromium Edge DevTools is listening on, to receive requests from msedgedriver.

Chromium Edge instance user data directory
ChromiumEdgeInstanceUserDataDir string

The path to the user data directory being used by Chromium Edge, e.g. 'C:\Users\Robot1\AppData\Local\Microsoft\Edge\User Data'.

Open Google Chrome browser

Opens the Google Chrome web browser, allowing it to to be automated using the actions in this IA-Connect module. If the web browser was opened manually, by another application or using the 'Run Process' action then it can only be automated using UIA actions and not by the actions in this IA-Connect module.

Parameters

Name Key Required Type Description
Chrome driver folder
ChromeDriverFolder string

The folder path containing the correct version of ChromeDriver.exe for the Chrome browser major version in the IA-Connect Agent session.

Kill existing ChromeDriver
KillExistingChromeDriver boolean

Should any existing instances of ChromeDriver.exe be killed when Chrome is opened?

User data directory
UserDataDir string

An optional path to the Google Chrome user data directory if it has been changed from the default (normally this is '%LOCALAPPDATA%\Google\Chrome\User Data').

Print to default printer
PrintToDefaultPrinter boolean

Should Chrome print to the default printer in the IA-Connect Agent session automatically without displaying a print dialog? The default printer can be changed using the 'Set default printer' action in the IA-Connect Environment / Session actions.

Default download directory
DefaultDownloadDirectory string

An optional path to a default download directory where all downloads will be saved to.

Download PDF instead of opening
DownloadPDFInsteadOfOpening boolean

Should PDF files automatically be downloaded instead of opening them?

Chrome driver log filename
ChromeDriverLogFilename string

An optional path to the location where ChromeDriver log files will be stored.

Local Chrome driver folder
LocalChromeDriverFolder string

The folder path in the local session (where the IA-Connect Director is running) to the folder containing the correct version of ChromeDriver.exe for the Chrome browser major version. This will be automatically uploaded to the IA-Connect Agent session and should only be used when running the IA-Connect Agent in a Citrix or RDP session.

Chrome EXE path
ChromeBrowserEXE string

An optional path to the Chrome.exe, if this is not installed in the default location (or you are using a Dev or Canary version of Chrome).

Ignore certificate errors
IgnoreCertificateErrors boolean

Should Chrome ignore webpage certificate errors?

Additional arguments
AdditionalArguments string

An optional space separated list of additional arguments to pass to the browser. A full list of command line switches can be found on the Chromium website.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
ChromeDriver process Id
ChromeDriverPID integer

The process ID of the ChromeDriver process that has been launched.

ChromeDriver TCP port
ChromeDriverTCPPort integer

The TCP port that ChromeDriver is listening on to receive requests from the IA-Connect Agent.

Chrome process Id
ChromePID integer

The process ID of the Chrome process that has been launched.

Chrome TCP port
ChromeTCPPort integer

The TCP port that Chrome DevTools is listening on, to receive requests from ChromeDriver.

Chrome instance user data directory
ChromeInstanceUserDataDir string

The path to the user data directory being used by Chrome, e.g. 'C:\Users\Robot1\AppData\Local\Google\Chrome\User Data'.

Open Internet Explorer browser

Opens the Internet Explorer web browser, allowing it to to be automated using the actions in this IA-Connect module. If the web browser was opened manually, by another application or using the 'Run Process' action then it can only be automated using UIA actions and not by the actions in this IA-Connect module.

Parameters

Name Key Required Type Description
Internet Explorer driver folder
IEDriverFolder string

This parameter allows you to specify an alternative location for the folder containing IEDriver.dll. By default, IA-Connect handles this automatically so you would only need to use this parameter if directed by Ultima Technical Support.

Kill existing IEDriverServer
KillExistingIEDriver boolean

Should any existing instances of IEDriverServer.exe (legacy) be killed or should any existing IEDriver be unloaded before launching a new instance of Internet Explorer? This should be left as false unless directed by Ultima Technical Support.

Kill existing IE
KillExistingIE boolean

Should any existing sessions of Internet Explorer be killed before launching a new instance?

Clean session
CleanSession boolean

Should Internet Explorer launch a clean session? This will clear all browsing history and other temporary files before launching.

Enable native events
EnableNativeEvents boolean

Should native events be enabled? This is generally more reliable and better simulates user interactions. If set to false, user interactions are simulated by JavaScript events.

Web driver log file
WebDriverLogFile string

An optional file path to the location where web driver log files will be stored.

Web driver log level
WebDriverLogLevel string

An optional number to indicate the level of web driver logging as indicated: Fatal (1), Error (2), Warn (3), Info (4), Debug (5) or Trace (6).

Disable IE first run customise
DisableIEFirstRunCustomise boolean

Should the first-run customisation dialogs be suppressed? These dialogs can typically interrupt an automated process.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Open new web browser tab

Opens a new tab in the browser window. In Internet Explorer, this action opens a new window but the new window behaves as a tab and can be interacted with in the same way as a tab with the 'Get browser tabs' or 'Set browser tab' actions.

Parameters

Name Key Required Type Description
URL
URL string

The URL of the page to be opened in a new tab.

Switch control to new tab
SwitchControlToNewTab boolean

If set to true, IA-Connect will switch control to the new tab. If set to false, control will be kept in the current tab.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
New tab name
NewTabName string

The internal tab name of the new tab.

New tab index
NewTabIndex integer

The tab index of the new tab.

Paste into web element

Pastes the contents of the clipboard into a HTML element (typically a text input field).

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press CTRL key on web element

Presses the CTRL key on a HTML element. This can be used with the 'Control key' parameter to perform shortcuts such as Ctrl-a (Select all), Ctrl-c (Copy), Ctrl-x (Cut) or Ctrl-v (Paste).

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Control key
ControlKey True string

An optional key to use with the CTRL key to perform shortcuts, for example 'a' (Select all), 'c' (Copy), 'x' (Cut) or 'v' (Paste).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press enter on web element

Presses the enter key on an HTML element. This can be used to submit the element or in some cases to interact with buttons.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Prints the current web page.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Refresh current webpage in active browser

Refreshes the current browser page.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Reset all web element handles

Resets all web element handles that are currently held by the IA-Connect Agent. This action is generally used for memory clean-up and is only recommended for use in large complex processes which will result in high numbers of element handles (10,000+) being stored.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Reset browser webpage frame stack

Resets the browser frame stack. This should only be used if approved by Ultima Technical Support.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Save webpage to file

Saves the current HTML page to a file on disk.

Parameters

Name Key Required Type Description
Filename
SaveFilename True string

The full file path to save the current HTML page to.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Scroll browser window by pixels

Scrolls the browser window by the specified number of pixels.

Parameters

Name Key Required Type Description
X pixels
X double

The number of X pixels to scroll the window. A positive number of pixels will scroll to the right and a negative number will scroll to the left.

Y pixels
Y double

The number of Y pixels to scroll the window. A positive number of pixels will scroll down and a negative number will scroll up.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Scroll browser window to pixels

Scrolls the browser window to the specified pixel coordinates.

Parameters

Name Key Required Type Description
X pixels
X double

The X pixel to scroll the current window to, with 0 being the left-most edge.

Y pixels
Y double

The Y pixel to scroll the current window to, with 0 being the top-most edge.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Scroll web element into view

Scrolls the web page up, down, left or right until the HTML element is on screen.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select all on a web element

Selects all of the contents of a HTML element (typically a text field).

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select web selection list item

Selects an option on a select HTML element, either by Text, Value or Index. The text, value or index of each option in a selection can be discovered using the 'Get selection properties' action.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Value to select
ValueToSelect string

The value of the selection option to select.

Text to select
TextToSelect string

The text value of the selection option to select.

Index to select
IndexToSelect double

The index of the selection option to select.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Set active browser window position

Moves the browser window to the pixel coordinates specified.

Parameters

Name Key Required Type Description
X
X True integer

The X pixel coordinate to set the browser window to.

Y
Y True integer

The Y pixel coordinate to set the browser window to.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Set active browser window size

Resizes the browser window to the width and height dimensions specified.

Parameters

Name Key Required Type Description
Width
Width True integer

The width of the browser window in pixels.

Height
Height True integer

The height of the browser window in pixels.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Set browser timeouts

Sets the internal timeouts that IA-Connect uses when interacting with the web browser.

Parameters

Name Key Required Type Description
Element wait timeout seconds
ElementWaitTimeoutSeconds double

The number of seconds that IA-Connect will wait for an element to be visible.

Page load timeout seconds
PageLoadTimeoutSeconds double

The number of seconds that IA-Connect will wait for pages to finish loading.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Set web browser tab

Sets the active tab and switches the IA-Connect Agent to control this tab so that it can interact with it.

Parameters

Name Key Required Type Description
Tab name
TabName string

The internal tab name to switch to. This can be retrieved from the 'Get browser tabs' action.

Tab index
TabIndex integer

The tab index of the tab to switch to.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Simulate mouse left click on web element

Simulates a mouse action by telling the browser that a mouse left click action was performed. This is usually sufficient for the web page to react as expected. If this fails, consider using 'Global mouse left click on element' which moves the mouse and clicks in exactly the same way as a user would.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Focus first
FocusFirst boolean

Should the HTML element be focused first before attempting to click?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Simulate mouse right click on web element

Simulates a mouse action by telling the browser that a mouse right click action was performed. This is usually sufficient for the web page to react as expected. If this fails, consider using 'Global mouse right click on element' which moves the mouse and clicks in exactly the same way as a user would.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Focus first
FocusFirst boolean

Should the HTML element be focused first before attempting to click?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Submit web element

Submits a HTML element. This is typically performed on any input element in a form element and will cause the form to be submitted.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Switch to webpage frame

Switches the IA-Connect Agent to controlling or interacting with an alternative frame within a browser page.

Parameters

Name Key Required Type Description
Parent Element handle
ParentElementHandle double

The parent element handle to act as the starting point for the search. This can be discovered via Inspection using actions like 'Create handle to element'. If no value is provided then the whole page DOM structure is searched.

Search Element handle
SearchElementHandle double

The element handle to the target element. This could be located using 'Get multiple element properties' or some other search which returns an element handle. If a value is entered into this field then all other search criteria are ignored since this handle uniquely identifies an element and hence no other details are required.

Search Element name
SearchElementName string

The optional HTML name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element ID
SearchElementID string

The optional HTML ID of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element tag name
SearchElementTagName string

The optional HTML tag name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element XPath
SearchElementXPath string

An optional XPath query to identify the element. Wildcards are supported.

Search Element class name
SearchElementClassName string

The optional HTML class name of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element CSS selector
SearchElementCSSSelector string

An optional CSS selector to identify the element. Wildcards are supported.

Search Element index
SearchElementIndex double

If multiple elements match the search, which element (starting at 1) should be matched.

Search Element match value
SearchElementMatchValue string

The optional HTML value of the element to search for. This can be discovered via inspection.Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element match text
SearchElementMatchText string

The optional HTML text value of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element type
SearchElementType string

The optional HTML type of the element to search for. This can be discovered via inspection. Wildcards are not supported in this parameter but can instead be used as part of an XPath or CSS selector.

Search Element minimum width
SearchElementMinimumWidth double

An optional minimum width of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a width of 0.

Search Element minimum height
SearchElementMinimumHeight double

An optional minimum height of elements to be returned. By default, this is set to 1 to avoid returning hidden elements which typically have a height of 0.

Search Element bounding box left
SearchElementBoundingBoxLeft double

An optional HTML document coordinate value for the left side of the bounding box in whichthe search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box right
SearchElementBoundingBoxRight double

An optional HTML document coordinate value for the right side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Search Element bounding box top
SearchElementBoundingBoxTop double

An optional HTML document coordinate value for the top side of the bounding box in which the search element should be found. By default, this is set to -99999 to return all elements.

Search Element bounding box bottom
SearchElementBoundingBoxBottom double

An optional HTML document coordinate value for the bottom side of the bounding box in which the search element should be found. By default, this is set to 99999 to return all elements.

Only Element top left needs to be in bounding box
OnlyElementTopLeftNeedsToBeInBoundingBox boolean

Should only the top left of the search element found within the bounding box, or the entire element. By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Switch to webpage parent frame

Switches the IA-Connect Agent to controlling or interacting with the parent frame of the current frame within a web page.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Switch to webpage root frame

Switches the IA-Connect Agent to controlling or interacting with the root frame within a web page.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Upload new ChromeDriver

Uploads a new version of ChromeDriver from the local system (the digital worker) to the IA-Connect Agent session to be used with Google Chrome.

Parameters

Name Key Required Type Description
Local ChromeDriver file path
LocalChromeDriverFilePath True string

The file path to ChromeDriver.exe in the local session (where the IA-Connect Director is running) for the Chrome browser major version. This will be uploaded to the IA-Connect Agent session and should only be used when running the IA-Connect Agent in a Citrix or RDP session.

Compress
Compress boolean

Should the ChromeDriver be compressed when uploading?

Chrome EXE major version
ChromeBrowserMajorVersion integer

The major version of the Chrome browser (e.g. 91) installed in the session where the IA-Connect Agent is running.

ChromeDriver remote parent save folder
ChromeDriverRootSaveFolder string

The file path to the folder where the ChromeDriver should be saved in the IA-Connect Agent session.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Upload new Chromium Edge driver

Uploads a new version of ChromiumEdgeDriver from the local system (the digital worker) to the IA-Connect Agent session to be used with Chromium Edge.

Parameters

Name Key Required Type Description
Local ChromiumEdgeDriver file path
LocalChromiumEdgeDriverFilePath True string

The file path to msedgedriver.exe in the local session (where the IA-Connect Director is running) for the Chromium Edge browser major version. This will be uploaded to the IA-Connect Agent session and should only be used when running the IA-Connect Agent in a Citrix or RDP session.

Compress
Compress boolean

Should the ChromiumEdgeDriver be compressed when uploading?

Chromium Edge EXE major version
ChromiumEdgeBrowserMajorVersion integer

The major version of the Chromium Edge browser (e.g. 91) installed in the session where the IA-Connect Agent is running.

ChromiumEdgeDriver remote parent save folder
ChromiumEdgeDriverRootSaveFolder string

The file path to the folder where the ChromiumEdgeDriver should be saved in the IA-Connect Agent session.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns