IA-Connect Java

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

This connector is available in the following products and regions:

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

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

Prerequisites

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

The IA-Connect software consists of two main components:

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

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

Available IA-Connect Connectors

The available IA-Connect Connectors are:

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

How to get credentials

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

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

Get started with your connector

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

Support

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

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

Known issues, common errors and FAQs

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

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

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

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

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Are Java element handles the same

Compares two Java element handles for Java elements to see if they represent the same Java object. This can be useful if you have identified an element and retrieved a handle to its parent.

Check Java element

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

Connect to Java Access Bridge

Starts the IA-Connect Java subsystem (IA-JavaAccessBridge) and connects it to the specified Java Access Bridge DLL (or leave blank to search for one). This step must be performed before you can automate Java applications. This action also enables the Java Access Bridge which must be enabled before running any Java applications.

Create handle for Java element at screen coordinate

Creates a handle to a Java element by providing the screen coordinates. If a Java element exists at the specified coordinate, the action will identify the element and return a handle to it.

Disconnect from Java Access Bridge

Shuts down any running IA-Connect Java subsystem (IA-JavaAccessBridge).

Does Java desktop element exist

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

Does Java element exist

Reports whether a Java element exists and returns some basic element properties.

Draw rectangle around Java element

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

Expand Java selection element

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

Focus Java element

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

Get actions for Java element

Returns the accessible actions for a Java element. These accessible actions can then be performed on the element by using the action name as an input to the action 'Perform action on Java element', for example 'click' or 'select-all'.

Get all Java child element properties

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

Get Java child element properties

Returns all properties of a specific Java child element, specified by index. This can be useful if you are uncertain which field holds the property values required.

Get Java desktop elements

Returns a list of Java application windows and dialogs on the desktop. You must first connect to the Java Access Bridge.

Get Java element properties

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

Get Java element properties as list

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

Get Java element text value

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

Get Java element value

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

Get Java parent element properties

Returns the properties of the parent element of a Java element. This action will only return the properties of the direct parent element and will not search the entire height of the element tree.

Get Java properties for UIA element

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

Get Java role CSV from element handle

Returns the tree of element roles below the specified element handle as CSV. This action would only be used for development purposes and provides an overview of the elements of the application which can be useful for visualising the application structure and optimising element searches.

Get Java role CSV from element search

Performs a Java element search and outputs the details of the elements searched (up to the point where the element was found) as CSV. This action would only be used for development purposes and provides an overview of the elements of the application which can be useful for visualising the application structure and optimising element searches.

Get Java selection element items

Returns all child selection element items found under the specified Java selection element. You can choose to retrieve the selection element options either by looping through the selection, selecting each individual option in the list OR by reading the labels of the child elements of the selection. If you choose to retrieve the selection element options by reading the labels of the child elements of the selection, you will likely need to expand the selection first by providing the 'Expand first' parameter as 'True' and you can then optionally close the selection afterwards by also providing the 'Collapse after' parameter as 'True'.

Get Java selection state by index

Returns the selection state of a child element in a selection (typically an item in a list or drop-down) by providing the child element index. You can retrieve all selection child element items to check their index by using the action 'Get Java selection element items'.

Get Java selection state by name

Returns the selection state of a child element in a selection (typically an item in a list or drop-down) by providing the child element name. You can retrieve all selection child element items to check their name by using the action 'Get Java selection element items'.

Get Java table cell at screen coordinate

If a Java table cell that is a child element of the table exists at the specified coordinates, this action will identify the element, its properties and will optionally return a handle to the table cell element.

Get Java table cell properties

Returns the properties and contents of a specified cell within a Java table element. This is an element with rows, columns, a header and cells (i.e. a table). You can optionally specify whether to determine which if the cell is currently visible on screen and it's coordinates by enumerating the viewport. The viewport element typically contains the table (e.g. it is a parent element of the table) and represents the visible area of the table.

Get Java table contents

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

Get Java table properties

Returns the properties of a Java table element. This is an element with rows, columns, a header and cells (i.e. a table). You can optionally specify whether to determine which components of the table are currently visible on screen by enumerating the viewport. The viewport element typically contains the table (e.g. it is a parent element of the table) and represents the visible area of the table.

Get multiple Java parent element properties

Returns the properties of all parent elements of a Java element. This action will search the entire height of the element tree returning all parent properties if the 'Max parents to process' parameter is set high enough.

Get visible bounding rectangle of Java element

Retrieves the visible bounds of a Java element. Typically, the Java Access Bridge will return the virtual positional values of an element, regardless of whether the element is visible on screen and these virtual values are provided by the 'Get Java element properties' action. With larger elements (e.g. a table element which can scroll) as these may not always be visible on screen, this action returns the coordinates of the currently visible area of the element.

Get windows access bridge connection status

Returns the current status of the connection between IA-Connect Agent and the Windows Access Bridge (WAB). If IA-Connect Agent is connected to the WAB then the relevant details are returned as outputs.

Get windows access bridge info

Returns information about the Windows Access Bridge (WAB) for a particular Java VM ID, including the Java and Windows DLL versions. The Java VM ID can be obtained as an output from the 'Get Java element properties' action.

Global double left mouse click on Java element

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

Global input password into Java element

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

Global input text into Java element

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

Global left mouse click on Java element

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

Global middle mouse click on Java element

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

Global mouse click on Java table cell

Moves the mouse to the centre of a Java table cell and clicks the specified mouse button.

Global right mouse click on Java element

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

Input password into Java element

Inputs a password into a Java element (typically a password entry field), replacing the existing text.

Input text into Java element

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

Is Java table cell visible onscreen

Returns whether a specific table cell within a Java table element is currently visible onscreen.

Is Java window

Returns whether a UIA window is a Java element.

Perform action on Java element

Performs an accessible action for a Java element. These accessible actions for a specific element can be queried by using the 'Get actions for Java element' action. Some common actions are 'click' for a button or 'select-all' for a text element.

Press Java element

Presses a Java element (typically a button).

Reset all Java element handles

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

Select Java list element by index

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

Select Java list element by name

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

Wait for Java desktop element

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

Wait for Java desktop element to not exist

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

Wait for Java element

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

Wait for Java element to not exist

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

Are Java element handles the same

Compares two Java element handles for Java elements to see if they represent the same Java object. This can be useful if you have identified an element and retrieved a handle to its parent.

Parameters

Name Key Required Type Description
Element 1 JAB handle
Element1JABHandle True integer

The first element handle to compare.

Element 2 JAB handle
Element2JABHandle True integer

The second element handle to compare.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Same object
SameObject boolean

Returns true if both element handles are for the same Java object, or false if the element handles are for different Java objects.

Check Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Check element
CheckElement boolean

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

Auto detect action name
AutoDetectActionName boolean

If set to true (the default) then IA-Connect Agent will attempt to automatically detect the 'click' action name in non-English locales. If there are more than two possible actions for the element then the 'Override action name' will be used. If set to false then IA-Connect Agent will not attempt to detect the 'click' action name in non-English locales and the action may fail unless an 'Override action name' value is provided.

Override action name
OverrideActionName string

The name of the 'Click' action in non-English locales, e.g. 'cliquer' or 'hacer clic'. This can be determined from the output of the action 'Get actions for Java element' and is typically case sensitive.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Connect to Java Access Bridge

Starts the IA-Connect Java subsystem (IA-JavaAccessBridge) and connects it to the specified Java Access Bridge DLL (or leave blank to search for one). This step must be performed before you can automate Java applications. This action also enables the Java Access Bridge which must be enabled before running any Java applications.

Parameters

Name Key Required Type Description
Windows Access Bridge DLL search folder
WindowsAccessBridgeDLLSearchFolder string

Either specify the folder containing the Windows Access Bridge DLL (a component of the Java runtime) in the session where the Agent is running or enter the full filename of a Windows Access Bridge DLL to force that particular DLL to be used. If you do not provide a path, then the standard Windows search path will be used.

IA-JavaAccessBridge DLL path
IAJavaAccessBridgePath string

The location of the IA-JavaAccessBridge.dll COM DLL (a built-in component of the IA-Connect Agent) if you need to host it externally to the EXE (perhaps due to a security allow list). This can either be the full path, or the path relative to the location of the IA-Connect Agent. For example, if both the Agent and the IA-JavaAccessBridge.dll COM DLL are in the same folder then just passing the file name of the DLL is sufficient.

Is 64bit Windows Access Bridge DLL
Is64BitJABDLL boolean

Is the Windows Access Bridge DLL being used 64bit?

Use COM for 64bit IA-JavaAccessBridge DLL
UseCOMFor64BitJABDLL boolean

If the Windows Access Bridge DLL you are trying to load is 64bit, should this be run via an out-of-process COM DLLSurrogate instead of calling directly (in memory) from IA-Connect. By default, this is set to 'True'. You could try unchecking this if the IA-JavaAccessBridge DLL is being blocked.

Enable Java Access Bridge
EnableJavaAccessBridge boolean

Should the Java Access Bridge be enabled? By default, this is set to 'True'.

Accessibility file path
AccessibilityFilepath string

The path to the .accessibility.properties file which controls whether the Java Access Bridge is enabled. If you do not provide a path, then this defaults to %USERPROFILE%.accessibility.properties.

Command timeout in seconds
CommandTimeoutInSeconds integer

The maximum number of seconds to wait for IA-Connect to connect to the Java Access Bridge. By default, this is 20 seconds.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Loaded Windows Access Bridge DLL
LoadedWindowsAccessBridgeDLL string

The full filename of the Windows Access Bridge DLL that was loaded.

Create handle for Java element at screen coordinate

Creates a handle to a Java element by providing the screen coordinates. If a Java element exists at the specified coordinate, the action will identify the element and return a handle to it.

Parameters

Name Key Required Type Description
Parent element JAB handle
ParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Screen X
ScreenX True integer

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

Screen Y
ScreenY True integer

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

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Located element JAB handle
LocatedElementJABHandle integer

If an element existed at the specified coordinates, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further searches (i.e. to locate elements relative to the handle).

Disconnect from Java Access Bridge

Shuts down any running IA-Connect Java subsystem (IA-JavaAccessBridge).

Parameters

Name Key Required Type Description
Disable Java Access Bridge
DisableJavaAccessBridge boolean

Should the Java Access Bridge be disabled? By default, this is set to 'True'.

Accessibility file path
AccessibilityFilepath string

The path to the .accessibility.properties file which controls whether the Java Access Bridge is enabled. If you do not provide a path, then this defaults to %USERPROFILE%.accessibility.properties.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Does Java desktop element exist

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

Parameters

Name Key Required Type Description
Search UIA element name
SearchUIAElementName string

The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search UIA element class name
SearchUIAElementClassName string

The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search UIA element localized control type
SearchUIAElementLocalizedControlType string

The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.

Search process Id
SearchProcessID integer

The process ID of the running process. This can be retrieved as an output from the "Run Process" action.

Search child elements
SearchChildElements boolean

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

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Include child processes
IncludeChildProcesses boolean

If set to true and a 'Search process Id' is specified, child processes of that process Id are included in the search. This is common for Java since a launcher EXE often then runs a child 'Java(w).exe' process. If set to false then only a process matching the exact 'Search process Id' will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element exists
ElementExists boolean

Returns true if the element exists or false if not.

Element JAB handle
ElementJABHandle integer

If the search element was found, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further searches (i.e. to locate elements relative to this handle).

Element name
ElementName string

The Java name of the located element.

Element description
ElementDescription string

The Java description of the located element (if there is one).

Element role
ElementRole string

The Java role (e.g. frame or panel) of the located element (if there is one).

Does Java element exist

Reports whether a Java element exists and returns some basic element properties.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element exists
ElementExists boolean

Returns true if the element exists or false if not.

Element JAB handle
ElementJABHandle integer

If the search element was found, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further searches (i.e. to locate elements relative to this handle).

Element name
ElementName string

The Java name of the located element.

Element description
ElementDescription string

The Java description of the located element (if there is one).

Element role
ElementRole string

The Java role (e.g. frame or panel) of the located element (if there is one).

Draw rectangle around Java element

Draws a rectangle around the perimeter of a Java 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 JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

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

Expand Java selection element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Expand
Expand boolean

If set to 'True' (the default) then the element will be expanded. If set to 'False' then the element will be collapsed.

Verify element state
VerifyElementState boolean

If set to 'True' then the IA-Connect Agent will validate the element state afterwards to check that the 'Expanded' state matches the expected state and raises an exception if this does not match. For example, if expanding an element then the 'IsExpanded' property should be true. If set to 'False' then the element state is not validated.

Seconds to wait for state change
SecondsToWaitForStateChange double

The number of seconds to wait for the state change after expanding or collapsing. By default, this is set to 0.05 (20 milliseconds).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Focus Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Get actions for Java element

Returns the accessible actions for a Java element. These accessible actions can then be performed on the element by using the action name as an input to the action 'Perform action on Java element', for example 'click' or 'select-all'.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Accessible actions
AccessibleActions string

A list of all accessible actions for the search element, for example 'click'.

Get all Java child element properties

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

Parameters

Name Key Required Type Description
Search element JAB handle
SearchElementJABHandle True integer

The element handle of the element which you want to return the child element properties for. This could be located using 'Get Java element properties' or some other search which returns an element handle.

First item to return
FirstItemToReturn integer

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

Max items to return
MaxItemsToReturn integer

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

Max string length
MaxStringLength integer

The maximum length of the description field. This can sometimes contain a large amount of text so setting a maximum value can increase search speed. By default, there is no maximum string length so full descriptions will be returned.

Search descendants
SearchDescendants boolean

If set to true then all child elements below the parent handle will be searched. This is more thorough but can take longer. If set to false, only direct child elements of the parent handle will be searched.

Search Java element role
SearchRole string

The optional Java element role of the child elements to search for. This can be discovered via Inspection.

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of child elements returned
NumberOfChildElementsReturned integer

The number of child elements returned from the search.

More elements available at current depth
MoreElementsAvailableAtCurrentDepth boolean

Returns true if there are more child elements at the current depth that have not been returned as 'Max items to return' has been set to a lower number.

More elements available at lower depths
MoreElementsAvailableAtLowerDepths boolean

Returns true if there are more of child elements available at a lower depth in the Java tree, if 'Max items to return' was set to a lower number.

More elements deeper than max depth
MoreElementsDeeperThanMaxDepth boolean

Returns true if there are more child elements available at a lower maximum depth in the Java tree, if 'Maximum relative depth' was set to a lower number.

Java child elements JSON
JavaChildElementsJSON string

A list of all located child elements (and their properties), in JSON format. The properties returned are the same as those returned by the 'Get Java child element properties' action.

Get Java child element properties

Returns all properties of a specific Java child element, specified by index. This can be useful if you are uncertain which field holds the property values required.

Parameters

Name Key Required Type Description
Search element JAB handle
SearchElementJABHandle True integer

The element handle of the element which you want to return the child element properties for. This could be located using 'Get Java element properties' or some other search which returns an element handle.

Search child index
SearchChildIndex True integer
Max string length
MaxStringLength integer

The maximum length of the description field. This can sometimes contain a large amount of text so setting a maximum value can increase search speed. By default, there is no maximum string length so full descriptions will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element JAB handle
ElementJABHandle integer

If the search element was found, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further searches (i.e. to locate elements relative to this handle).

Element VMID
ElementVMID integer

The ID of the Java virtual machine running the Java program.

Element name
ElementName string

The Java name of the located element.

Element description
ElementDescription string

The Java description of the located element (if there is one).

Element role
ElementRole string

The Java role (e.g. frame or panel) of the located element (if there is one).

Element states
ElementStates string

The Java element's supported states (e.g. focusable, visible) in the locale of the Agent session.

Element states en_US
ElementStates_en_US string

The Java element's supported states (e.g. focusable, visible) in the en_US locale.

Element left edge
ElementLeftEdge integer

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

Element top edge
ElementTopEdge integer

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

Element right edge
ElementRightEdge integer

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

Element bottom edge
ElementBottomEdge integer

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

Element width
ElementWidth integer

The width of the Java element in pixels.

Element height
ElementHeight integer

The height of the Java element in pixels.

Is component element
IsComponentElement boolean

Returns true if the Java element is a container or false if not.

Is action element
IsActionElement boolean

Returns true if the Java element is an action element or false if not.

Is selection element
IsSelectionElement boolean

Returns true if the Java element is a selection or false if not.

Is text element
IsTextElement boolean

Returns true if the Java element is a text element or false if not.

Is enabled
IsEnabled boolean

Returns true if the Java element is enabled or false if not. A disabled element is typically visible but cannot be interacted with.

Is visible
IsVisible boolean

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

Is showing
IsShowing boolean

Returns true if the Java element is showing or false if not.

Is opaque
IsOpaque boolean

Returns true if the Java element is opaque or false if not.

Is focusable
IsFocusable boolean

Returns true if the Java element be focussed by the keyboard or false if not. This may be of limited use since most elements are keyboard focusable.

Is editable
IsEditable boolean

Returns true if the Java element is editable or false if not.

Is single line
IsSingleLine boolean

Returns true if the Java element is a single line or false if not.

Is resizable
IsResizable boolean

Returns true if the Java element is resizable or false if not.

Is modal
IsModal boolean

Returns true if the Java element is modal or false if not. A modal element will block the main application window, preventing you from interacting with it.

Is collapsed
IsCollapsed boolean

Returns true if the Java element is collapsed or false if not.

Is selectable
IsSelectable boolean

Returns true if the Java element is selectable or false if not.

Is selected
IsSelected boolean

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

Is vertical
IsVertical boolean

Returns true if the Java element is vertical or false if not.

Is horizontal
IsHorizontal boolean

Returns true if the Java element is horizontal or false if not.

Is active
IsActive boolean

Returns true if the Java element is active or false if not.

Is checked
IsChecked boolean

Returns true if the Java element is checked or false if not.

Is focussed
IsFocussed boolean

Returns true if the Java element has keyboard focus. or false if not.

Is expanded
IsExpanded boolean

Returns true if the Java element is expanded or false if not.

Additional element states en_US
AdditionalStates_en_US string

Any additional states that the element supports will be listed here in the en_US locale, e.g. multiselectable, transient.

Index in parent
IndexInParent integer

The element index within the current parent element.

Element child count
ChildrenCount integer

The number of child elements that the element has.

Element depth
ElementDepth integer

The depth of the element from the top-level parent window.

Get Java desktop elements

Returns a list of Java application windows and dialogs on the desktop. You must first connect to the Java Access Bridge.

Parameters

Name Key Required Type Description
Search element localized control type
SearchElementLocalizedControlType string

The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.

Search process Id
SearchProcessID integer

The process ID of the running process. This can be retrieved as an output from the "Run Process" action.

First item to return
FirstItemToReturn integer

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

Max items to return
MaxItemsToReturn integer

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

Search child elements
SearchChildElements boolean

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

Max string length
MaxStringLength integer

The maximum length of the description field. This can sometimes contain a large amount of text so setting a maximum value can increase search speed. By default, there is no maximum string length so full descriptions will be returned.

Include child processes
IncludeChildProcesses boolean

If set to true and a 'Search process Id' is specified, child processes of that process Id are included in the search. This is common for Java since a launcher EXE often then runs a child 'Java(w).exe' process. If set to false then only a process matching the exact 'Search process Id' will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of elements found
NumberOfElementsFound integer

The number of elements found which met the search criteria.

Number of elements returned
NumberOfElementsReturned integer

The number of elements returned from the search. This could be lower than the number of elements found if 'Max items to return' was set to a lower number.

Java desktop elements JSON
JavaDesktopElementsJSON string

The element properties of the Java desktop elements found that match the search criteria, in JSON format.

Get Java element properties

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Max string length
MaxStringLength integer

The maximum length of the description field. This can sometimes contain a large amount of text so setting a maximum value can increase search speed. By default, there is no maximum string length so full descriptions will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element JAB handle
ElementJABHandle integer

If the search element was found, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further searches (i.e. to locate elements relative to this handle).

Element VMID
ElementVMID integer

The ID of the Java virtual machine running the Java program.

Element name
ElementName string

The Java name of the located element.

Element description
ElementDescription string

The Java description of the located element (if there is one).

Element role
ElementRole string

The Java role (e.g. frame or panel) of the located element (if there is one).

Element states
ElementStates string

The Java element's supported states (e.g. focusable, visible) in the locale of the Agent session.

Element states en_US
ElementStates_en_US string

The Java element's supported states (e.g. focusable, visible) in the en_US locale.

Element left edge
ElementLeftEdge integer

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

Element top edge
ElementTopEdge integer

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

Element width
ElementWidth integer

The width of the Java element in pixels.

Element height
ElementHeight integer

The height of the Java element in pixels.

Element right edge
ElementRightEdge integer

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

Element bottom edge
ElementBottomEdge integer

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

Is component element
IsComponentElement boolean

Returns true if the Java element is a container or false if not.

Is action element
IsActionElement boolean

Returns true if the Java element is an action element or false if not.

Is selection element
IsSelectionElement boolean

Returns true if the Java element is a selection or false if not.

Is text element
IsTextElement boolean

Returns true if the Java element is a text element or false if not.

Is enabled
IsEnabled boolean

Returns true if the Java element is enabled or false if not. A disabled element is typically visible but cannot be interacted with.

Is visible
IsVisible boolean

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

Is showing
IsShowing boolean

Returns true if the Java element is showing or false if not.

Is opaque
IsOpaque boolean

Returns true if the Java element is opaque or false if not.

Is focusable
IsFocusable boolean

Returns true if the Java element be focussed by the keyboard or false if not. This may be of limited use since most elements are keyboard focusable.

Is editable
IsEditable boolean

Returns true if the Java element is editable or false if not.

Is single line
IsSingleLine boolean

Returns true if the Java element is a single line or false if not.

Is resizable
IsResizable boolean

Returns true if the Java element is resizable or false if not.

Is modal
IsModal boolean

Returns true if the Java element is modal or false if not. A modal element will block the main application window, preventing you from interacting with it.

Is collapsed
IsCollapsed boolean

Returns true if the Java element is collapsed or false if not.

Is selectable
IsSelectable boolean

Returns true if the Java element is selectable or false if not.

Is selected
IsSelected boolean

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

Is vertical
IsVertical boolean

Returns true if the Java element is vertical or false if not.

Is horizontal
IsHorizontal boolean

Returns true if the Java element is horizontal or false if not.

Is active
IsActive boolean

Returns true if the Java element is active or false if not.

Is checked
IsChecked boolean

Returns true if the Java element is checked or false if not.

Is focussed
IsFocussed boolean

Returns true if the Java element has keyboard focus. or false if not.

Is expanded
IsExpanded boolean

Returns true if the Java element is expanded or false if not.

Additional element states en_US
AdditionalStates_en_US string

Any additional states that the element supports will be listed here in the en_US locale, e.g. multiselectable, transient.

Index in parent
IndexInParent integer

The element index within the current parent element.

Element child count
ChildrenCount integer

The number of child elements that the element has.

Element depth
ElementDepth integer

The depth of the element from the top-level parent window.

Get Java element properties as list

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Max string length
MaxStringLength integer

The maximum length of the description field. This can sometimes contain a large amount of text so setting a maximum value can increase search speed. By default, there is no maximum string length so full descriptions will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of elements found
NumberOfElementsFound integer

The number of elements found which met the search criteria.

Number of elements returned
NumberOfElementsReturned integer

The number of elements returned from the search. This could be lower than the number of elements found if 'Maximum elements to search' or 'Maximum child elements to search per node' was set to a lower number.

Java element properties JSON
JABElementPropertiesJSON string

The element properties of the Java elements found that match the search criteria, in JSON format.

Get Java element text value

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element text value
ElementTextValue string

The text value of the element.

Get Java element value

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element current value
ElementCurrentValue string

The current value of the element.

Element maximum value
ElementMaximumValue string

The maximum value of the element, if specified.

Element minimum value
ElementMinimumValue string

The minimum value of the element, if specified.

Get Java parent element properties

Returns the properties of the parent element of a Java element. This action will only return the properties of the direct parent element and will not search the entire height of the element tree.

Parameters

Name Key Required Type Description
Search element JAB handle
SearchElementJABHandle True integer

The element handle of the element which you want to return the parent element properties for. This could be located using 'Get Java element properties' or some other search which returns an element handle.

Max string length
MaxStringLength integer

The maximum length of the description field. This can sometimes contain a large amount of text so setting a maximum value can increase search speed. By default, there is no maximum string length so full descriptions will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element JAB handle
ElementJABHandle integer

If the search element was found, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further searches (i.e. to locate elements relative to this handle).

Element VMID
ElementVMID integer

The ID of the Java virtual machine running the Java program.

Element name
ElementName string

The Java name of the located element.

Element description
ElementDescription string

The Java description of the located element (if there is one).

Element role
ElementRole string

The Java role (e.g. frame or panel) of the located element (if there is one).

Element states
ElementStates string

The Java element's supported states (e.g. focusable, visible) in the locale of the Agent session.

Element states en_US
ElementStates_en_US string

The Java element's supported states (e.g. focusable, visible) in the en_US locale.

Element left edge
ElementLeftEdge integer

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

Element top edge
ElementTopEdge integer

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

Element right edge
ElementRightEdge integer

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

Element bottom edge
ElementBottomEdge integer

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

Element width
ElementWidth integer

The width of the Java element in pixels.

Element height
ElementHeight integer

The height of the Java element in pixels.

Is component element
IsComponentElement boolean

Returns true if the Java element is a container or false if not.

Is action element
IsActionElement boolean

Returns true if the Java element is an action element or false if not.

Is selection element
IsSelectionElement boolean

Returns true if the Java element is a selection or false if not.

Is text element
IsTextElement boolean

Returns true if the Java element is a text element or false if not.

Is enabled
IsEnabled boolean

Returns true if the Java element is enabled or false if not. A disabled element is typically visible but cannot be interacted with.

Is visible
IsVisible boolean

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

Is showing
IsShowing boolean

Returns true if the Java element is showing or false if not.

Is opaque
IsOpaque boolean

Returns true if the Java element is opaque or false if not.

Is focusable
IsFocusable boolean

Returns true if the Java element be focussed by the keyboard or false if not. This may be of limited use since most elements are keyboard focusable.

Is editable
IsEditable boolean

Returns true if the Java element is editable or false if not.

Is single line
IsSingleLine boolean

Returns true if the Java element is a single line or false if not.

Is resizable
IsResizable boolean

Returns true if the Java element is resizable or false if not.

Is modal
IsModal boolean

Returns true if the Java element is modal or false if not. A modal element will block the main application window, preventing you from interacting with it.

Is collapsed
IsCollapsed boolean

Returns true if the Java element is collapsed or false if not.

Is selectable
IsSelectable boolean

Returns true if the Java element is selectable or false if not.

Is selected
IsSelected boolean

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

Is vertical
IsVertical boolean

Returns true if the Java element is vertical or false if not.

Is horizontal
IsHorizontal boolean

Returns true if the Java element is horizontal or false if not.

Is active
IsActive boolean

Returns true if the Java element is active or false if not.

Is checked
IsChecked boolean

Returns true if the Java element is checked or false if not.

Is focussed
IsFocussed boolean

Returns true if the Java element has keyboard focus. or false if not.

Is expanded
IsExpanded boolean

Returns true if the Java element is expanded or false if not.

Additional element states en_US
AdditionalStates_en_US string

Any additional states that the element supports will be listed here in the en_US locale, e.g. multiselectable, transient.

Index in parent
IndexInParent integer

The element index within the current parent element.

Element child count
ChildrenCount integer

The number of child elements that the element has.

Element depth
ElementDepth integer

The depth of the element from the top-level parent window.

Get Java properties for UIA element

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

Parameters

Name Key Required Type Description
Parent window handle
ParentWindowHandle True integer

The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using UIA actions such as 'Wait for desktop element' or 'Wait for element'.

Search element name
SearchElementName string

The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search element class name
SearchElementClassName string

The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search element automation ID
SearchElementAutomationId string

The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.

Search element localized control type
SearchLocalizedControlType string

The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.

Search UIA subtree
SearchSubTree boolean

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

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Max string length
MaxStringLength integer

The maximum length of the description field. This can sometimes contain a large amount of text so setting a maximum value can increase search speed. By default, there is no maximum string length so full descriptions will be returned.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element JAB handle
ElementJABHandle integer

If the search element was found, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further searches (i.e. to locate elements relative to this handle).

Element VMID
ElementVMID integer

The ID of the Java virtual machine running the Java program.

Element name
ElementName string

The Java name of the located element.

Element description
ElementDescription string

The Java description of the located element (if there is one).

Element role
ElementRole string

The Java role (e.g. frame or panel) of the located element (if there is one).

Element states
ElementStates string

The Java element's supported states (e.g. focusable, visible) in the locale of the Agent session.

Element states en_US
ElementStates_en_US string

The Java element's supported states (e.g. focusable, visible) in the en_US locale.

Element left edge
ElementLeftEdge integer

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

Element top edge
ElementTopEdge integer

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

Element width
ElementWidth integer

The width of the Java element in pixels.

Element height
ElementHeight integer

The height of the Java element in pixels.

Element right edge
ElementRightEdge integer

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

Element bottom edge
ElementBottomEdge integer

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

Is component element
IsComponentElement boolean

Returns true if the Java element is a container or false if not.

Is action element
IsActionElement boolean

Returns true if the Java element is an action element or false if not.

Is selection element
IsSelectionElement boolean

Returns true if the Java element is a selection or false if not.

Is text element
IsTextElement boolean

Returns true if the Java element is a text element or false if not.

Is enabled
IsEnabled boolean

Returns true if the Java element is enabled or false if not. A disabled element is typically visible but cannot be interacted with.

Is visible
IsVisible boolean

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

Is showing
IsShowing boolean

Returns true if the Java element is showing or false if not.

Is opaque
IsOpaque boolean

Returns true if the Java element is opaque or false if not.

Is focusable
IsFocusable boolean

Returns true if the Java element be focussed by the keyboard or false if not. This may be of limited use since most elements are keyboard focusable.

Is editable
IsEditable boolean

Returns true if the Java element is editable or false if not.

Is single line
IsSingleLine boolean

Returns true if the Java element is a single line or false if not.

Is resizable
IsResizable boolean

Returns true if the Java element is resizable or false if not.

Is modal
IsModal boolean

Returns true if the Java element is modal or false if not. A modal element will block the main application window, preventing you from interacting with it.

Is collapsed
IsCollapsed boolean

Returns true if the Java element is collapsed or false if not.

Is selectable
IsSelectable boolean

Returns true if the Java element is selectable or false if not.

Is selected
IsSelected boolean

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

Is vertical
IsVertical boolean

Returns true if the Java element is vertical or false if not.

Is horizontal
IsHorizontal boolean

Returns true if the Java element is horizontal or false if not.

Is active
IsActive boolean

Returns true if the Java element is active or false if not.

Is checked
IsChecked boolean

Returns true if the Java element is checked or false if not.

Is focussed
IsFocussed boolean

Returns true if the Java element has keyboard focus. or false if not.

Is expanded
IsExpanded boolean

Returns true if the Java element is expanded or false if not.

Additional element states en_US
AdditionalStates_en_US string

Any additional states that the element supports will be listed here in the en_US locale, e.g. multiselectable, transient.

Index in parent
IndexInParent integer

The element index within the current parent element.

Element child count
ChildrenCount integer

The number of child elements that the element has.

Element depth
ElementDepth integer

The depth of the element from the top-level parent window.

Get Java role CSV from element handle

Returns the tree of element roles below the specified element handle as CSV. This action would only be used for development purposes and provides an overview of the elements of the application which can be useful for visualising the application structure and optimising element searches.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Indent role in CSV
IndentRoleInCSV boolean

Should the child element roles in the CSV output be indented? This may help to better visualise the parent and child relationships in the Java element tree. By default, this is set to 'True'.

Include description in CSV
IncludeDescriptionInCSV boolean

Should the element descriptions be included in the CSV output? By default, this is set to 'True'.

Include dimensions in CSV
IncludeDimensionsInCSV boolean

Should the element dimensions (height, width and bounding edges) be included in the CSV output? By default, this is set to 'True'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element found
ElementFound boolean

Returns true if the element specified by the input handle was found, or false if not.

Number of elements searched
ElementsSearched integer

The number of elements searched under the parent element.

Role CSV
RoleCSV string

The CSV output containing the role of each element found under the parent element.

Performs a Java element search and outputs the details of the elements searched (up to the point where the element was found) as CSV. This action would only be used for development purposes and provides an overview of the elements of the application which can be useful for visualising the application structure and optimising element searches.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Indent role in CSV
IndentRoleInCSV boolean

Should the child element roles in the CSV output be indented? This may help to better visualise the parent and child relationships in the Java element tree. By default, this is set to 'True'.

Include description in CSV
IncludeDescriptionInCSV boolean

Should the element descriptions be included in the CSV output? By default, this is set to 'True'.

Include dimensions in CSV
IncludeDimensionsInCSV boolean

Should the element dimensions (height, width and bounding edges) be included in the CSV output? By default, this is set to 'True'.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element found
ElementFound boolean

Returns true if the search element was found, or false if not.

Number of elements searched
ElementsSearched integer

The number of elements searched under the parent element before the search element was found.

Role CSV
RoleCSV string

The CSV output containing the role of each element found in the search.

Get Java selection element items

Returns all child selection element items found under the specified Java selection element. You can choose to retrieve the selection element options either by looping through the selection, selecting each individual option in the list OR by reading the labels of the child elements of the selection. If you choose to retrieve the selection element options by reading the labels of the child elements of the selection, you will likely need to expand the selection first by providing the 'Expand first' parameter as 'True' and you can then optionally close the selection afterwards by also providing the 'Collapse after' parameter as 'True'.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Get list of options by selecting
GetListOfOptionsBySelecting boolean

If set to 'True' then the IA-Connect Agent will attempt to obtain a list of all options in the selection by selecting each one in turn (in JAB). If set to 'False' (the default) then the 'Get list of options by reading labels' parameter should be set to 'True' otherwise the list of options will not be read.

Get list of options by reading labels
GetListOfOptionsByReadingLabels boolean

If set to 'True' then the IA-Connect Agent will attempt to obtain a list of all options in the selection by reading the child labels (in the JAB tree). For drop-down lists you will almost certainly need to set the 'Expand first' parameter to 'True' because the child elements aren't exposed until the list drops down. Also set the 'Collapse after' parameter to 'True' to close the list afterwards. The 'Get list of options by selecting' parameter should also be set to 'False' or this option will be ignored (as you can't get the list via both methods). If set to 'False' (the default) then the 'Get list of options by selecting' parameter should be set to 'True' otherwise the list of options will not be read.

Expand first
ExpandFirst boolean

If set to 'true' then the action will attempt to expand the list before searching for the list item elements. This is useful for dynamic lists as the other list item elements may not be created until the list is expanded. If set to false (the default) then the list will not be expanded.

Collapse after
CollapseAfter boolean

If set to true then the list will be collapsed after executing the search. If set to false (the default) then the list will not be collapsed.

Seconds between expand and collapse
SecondsBetweenExpandCollapse double

The number of seconds to wait between the expand and collapse actions, if these are set to 'True'. By default, this is 0.05 (20 milliseconds).

Max list items to return
MaxListItemsToReturn integer

The maximum number of list items to return, by default this is 100.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of selected items
NumberOfSelectedItems integer

The number of child list items found under the parent selection element that are currently selected.

Selection 1 name
AccessibleSelection1Name string

The name of the first selected child list item.

Selection 1 index in list
AccessibleSelection1IndexInParent integer

The index in the list of the first selected child list item.

Selected items JSON
JABSelectionSelectedItemsJSON string

The selected child list items of the parent selection element, in JSON format.

Selection list items JSON
JABSelectionListItemsJSON string

All child list items of the parent selection element, in JSON format.

Get Java selection state by index

Returns the selection state of a child element in a selection (typically an item in a list or drop-down) by providing the child element index. You can retrieve all selection child element items to check their index by using the action 'Get Java selection element items'.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Item index
ItemIndex True integer

The index (starting at 1) of the list item state to query.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Index is selected
IndexIsSelected boolean

Returns true if the selection list item at the index specified is selected or false if not.

Get Java selection state by name

Returns the selection state of a child element in a selection (typically an item in a list or drop-down) by providing the child element name. You can retrieve all selection child element items to check their name by using the action 'Get Java selection element items'.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Item name
ItemName True string

The name of the list item to select or deselect.

Item name case sensitive
ItemNameCaseSensitive boolean

If set to 'True' then the item name search will be case sensitive (e.g. it must match exactly to the list item). If set to 'False' (the default) then the item name search will not be case sensitive.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Name is selected
NameIsSelected boolean

Returns true if the named selection list item is selected or false if not.

Get Java table cell at screen coordinate

If a Java table cell that is a child element of the table exists at the specified coordinates, this action will identify the element, its properties and will optionally return a handle to the table cell element.

Parameters

Name Key Required Type Description
Table element JAB handle
TableElementJABHandle True integer

The Java element handle for the parent table element you are searching. This could be a table you located earlier using 'Get Java element properties'.

Screen X
ScreenX True integer

The screen X coordinate in pixels to locate the table cell at.

Screen Y
ScreenY True integer

The screen Y coordinate in pixels to locate the table cell at.

Return handle
ReturnJABHandle boolean

Should an element handle be returned for the cell?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Cell index in parent
CellIndexInParent integer

The cell index of the cell in the table. The first cell in the first row will have an index of 1, increasing by 1 for each cell in the row. Therefore, in a table with 5 rows and 3 columns, the first cell in the second row will have an index of 4.

Cell row index
CellRowIndex integer

The row index of the cell in the table, starting at 1.

Cell column index
CellColumnIndex integer

The column index of the cell in the table, starting at 1.

Cell JAB handle
CellJABHandle integer

The element handle to the table cell.

Get Java table cell properties

Returns the properties and contents of a specified cell within a Java table element. This is an element with rows, columns, a header and cells (i.e. a table). You can optionally specify whether to determine which if the cell is currently visible on screen and it's coordinates by enumerating the viewport. The viewport element typically contains the table (e.g. it is a parent element of the table) and represents the visible area of the table.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Cell row index
RowIndex True integer

The row index of the cell in the table, starting at 1.

Cell column index
ColumnIndex True integer

The column index of the cell in the table, starting at 1.

Return handle
ReturnJABHandle boolean

If set to true then an element handle will be returned for the cell.

Enumerate viewport
EnumerateViewport boolean

The viewport element typically contains the table and represents the visible area of the table. If set to 'True' (the default) then IA-Connect Agent will attempt to detect the table visible bounds and the index of the cells at each corner by calculating the size of the viewport. This allows you to determine which components of the table are currently visible on screen. If set to 'False' then the viewport coordinates will not be populated.

Process viewport parents
ProcessViewportParents boolean

If set to 'True' (the default) then the parent elements of the viewport will also be processed to help refine the visible size of the viewport. This is useful if it is embedded in another viewport. If set to 'False' then viewport parent elements will not be processed.

Max viewport parents to process
MaxViewportParentsToProcess integer

The maximum number of parent elements to process when enumerating the viewport. By default, this is set to 50.

Viewport parent element roles to consider
ViewportParentElementRolesToConsider string

The roles of the viewport parent element to consider when enumerating to calculate the viewport size. This is used to exclude parent elements that are smaller in size than the viewport which can skew the size calculation, for example page tabs. By default, these are: Panel, Viewport, Layered pane, Root pane.

Viewport left margin
ViewportLeftMargin integer

A left inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport top margin
ViewportTopMargin integer

A top inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport right margin
ViewportRightMargin integer

A right inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport bottom margin
ViewportBottomMargin integer

A bottom inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Cell index
CellIndex integer

The cell index in the table. The first cell in the first row will have an index of 1, increasing by 1 for each cell in the row. Therefore, in a table with 5 rows and 3 columns, the first cell in the second row will have an index of 4.

Cell row extent
RowExtent integer

The number of rows that the cell spans. This will commonly be 1 unless the cell is merged across multiple rows.

Cell column extent
ColumnExtent integer

The number of columns that the cell spans. This will commonly be 1 unless the cell is merged across multiple columns.

Cell is selected
IsSelected boolean

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

Cell contents
CellContents string

The contents of the cell.

Cell left edge
CellLeftEdge integer

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

Cell top edge
CellTopEdge integer

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

Cell right edge
CellRightEdge integer

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

Cell bottom edge
CellBottomEdge integer

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

Cell width
CellWidth integer

The width of the cell element in pixels.

Cell height
CellHeight integer

The height of the cell element in pixels.

Cell is visible onscreen
CellOnscreen boolean

Returns true if the cell is visible onscreen, or false if not.

Visible result is certain
CellVisibleResultIsCertain boolean

Returns true if the 'Cell is visible onscreen' result is certain. This will be set to 'False' if any one of the 4 parent table bounds could not be calculated.

Cell JAB handle
CellJABHandle integer

The element handle to the table cell.

Get Java table contents

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

First row to return
FirstRowToReturn integer

The index of the first row to return. By default, this is set to 1.

Max rows to return
MaxRowsToReturn integer

The maximum number of rows to return. By default, all rows are returned.

First column to return
FirstColumnToReturn integer

The index of the first column to return. By default, this is set to 1.

Max columns to return
MaxColumnsToReturn integer

The maximum number of columns to return. By default, all columns are returned.

Use column headers from table
UseColumnHeadersFromTable boolean

If set to 'True' then the IA-Connect Agent will attempt to return the output collection columns to match the column names in the Java table. If set to 'False' (the default) then the column headers will be called 'Column_N' in the collection (since collections cannot have blank names).

Return row index in output collection
ReturnRowIndexInOutputCollection boolean

If set to 'True' (the default) then the IA-Connect Agent will return the row index in the output collection as an additional column. By default, the row index column will be called 'Row_index' however this can be changed by passing a column name in the 'Name of column to store row index' parameter. This is useful if you plan to filter the output collection and keep track of which row the filtered result relates to. If set to 'False' then no row index column will be returned.

Name of column to store row index
NameOfColumnToStoreRowIndex string

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

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of rows in table
NumberOfRowsInTable integer

The number of rows in the table.

Number of columns in table
NumberOfColumnsInTable integer

The number of columns in the table.

Number of selected rows
NumberOfSelectedRows integer

The number of rows that are currently selected.

Number of selected columns
NumberOfSelectedColumns integer

The number of columns that are currently selected.

Number of rows returned
NumberOfRowsReturned integer

The number of rows returned, which could be lower than the number of rows found if 'Max rows to return' was set to a lower number.

Number of columns returned
NumberOfColumnsReturned integer

The number of columns returned, which could be lower than the number of columns found if 'Max columns to return' was set to a lower number.

Table contents JSON
TableContentsJSON string

The contents of the table element, in JSON format. The column names of this collection will match the column names of the table element if the 'Use column headers from table' was set to true. If the column name is blank, it will be called 'Column_N' in the collection (since collections cannot have blank names). If the column name is a duplicate, it will have '_N' appended to the name (since collections cannot have duplicate column names).

Get Java table properties

Returns the properties of a Java table element. This is an element with rows, columns, a header and cells (i.e. a table). You can optionally specify whether to determine which components of the table are currently visible on screen by enumerating the viewport. The viewport element typically contains the table (e.g. it is a parent element of the table) and represents the visible area of the table.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Enumerate viewport
EnumerateViewport boolean

The viewport element typically contains the table and represents the visible area of the table. If set to 'True' (the default) then IA-Connect Agent will attempt to detect the table visible bounds and the index of the cells at each corner by calculating the size of the viewport. This allows you to determine which components of the table are currently visible on screen. If set to 'False' then the viewport coordinates will not be populated.

Process viewport parents
ProcessViewportParents boolean

If set to 'True' (the default) then the parent elements of the viewport will also be processed to help refine the visible size of the viewport. This is useful if it is embedded in another viewport. If set to 'False' then viewport parent elements will not be processed.

Max viewport parents to process
MaxViewportParentsToProcess integer

The maximum number of parent elements to process when enumerating the viewport. By default, this is set to 50.

Viewport parent element roles to consider
ViewportParentElementRolesToConsider string

The roles of the viewport parent element to consider when enumerating to calculate the viewport size. This is used to exclude parent elements that are smaller in size than the viewport which can skew the size calculation, for example page tabs. By default, these are: Panel, Viewport, Layered pane, Root pane.

Viewport left margin
ViewportLeftMargin integer

A left inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport top margin
ViewportTopMargin integer

A top inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport right margin
ViewportRightMargin integer

A right inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport bottom margin
ViewportBottomMargin integer

A bottom inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Number of rows
NumberOfRows integer

The number of rows in the table.

Number of columns
NumberOfColumns integer

The number of columns in the table.

Number of selected rows
NumberOfSelectedRows integer

The number of rows that are currently selected.

Number of selected columns
NumberOfSelectedColumns integer

The number of columns that are currently selected.

Number of rows in row header
NumberOfRowsInRowHeader integer

The number of rows in the row header. This is commonly 0 as tables rarely have row headers.

Number of columns in column header
NumberOfColumnsInColumnHeader integer

The number of columns in the column header.

Viewport located
ViewportLocated boolean

Returns true if the viewport has been located, or false if not. If this is 'True', the viewport coordinates will be returned.

Viewport left edge
ViewportLeftEdge integer

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

Viewport top edge
ViewportTopEdge integer

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

Viewport width
ViewportWidth integer

The width of the viewport element in pixels.

Viewport height
ViewportHeight integer

The height of the viewport element in pixels.

Viewport right edge
ViewportRightEdge integer

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

Viewport bottom edge
ViewportBottomEdge integer

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

Top left visible cell index in parent
TopLeftVisibleCellIndexInParent integer

The cell index of the top left visible cell in the table. The first cell in the first row will have an index of 1, increasing by 1 for each cell in the row. Therefore, in a table with 5 rows and 3 columns, the first cell in the second row will have an index of 4.

Top left visible row index
TopLeftVisibleCellRowIndex integer

The row index of the top left visible cell in the table.

Top left visible column index
TopLeftVisibleCellColumnIndex integer

The column index of the top left visible cell in the table.

Top right visible cell index in parent
TopRightVisibleCellIndexInParent integer

The cell index of the top right visible cell in the table. The first cell in the first row will have an index of 1, increasing by 1 for each cell in the row. Therefore, in a table with 5 rows and 3 columns, the first cell in the second row will have an index of 4.

Top right visible row index
TopRightVisibleCellRowIndex integer

The row index of the top right visible cell in the table.

Top right visible column index
TopRightVisibleCellColumnIndex integer

The column index of the top right visible cell in the table.

Bottom left visible cell index in parent
BottomLeftVisibleCellIndexInParent integer

The cell index of the bottom left visible cell in the table. The first cell in the first row will have an index of 1, increasing by 1 for each cell in the row. Therefore, in a table with 5 rows and 3 columns, the first cell in the second row will have an index of 4.

Bottom left visible row index
BottomLeftVisibleCellRowIndex integer

The row index of the bottom left visible cell in the table.

Bottom left visible column index
BottomLeftVisibleCellColumnIndex integer

The column index of the bottom left visible cell in the table.

Bottom right visible cell index in parent
BottomRightVisibleCellIndexInParent integer

The cell index of the bottom right visible cell in the table. The first cell in the first row will have an index of 1, increasing by 1 for each cell in the row. Therefore, in a table with 5 rows and 3 columns, the first cell in the second row will have an index of 4.

Bottom right visible row index
BottomRightVisibleCellRowIndex integer

The row index of the bottom right visible cell in the table.

Bottom right visible column index
BottomRightVisibleCellColumnIndex integer

The column index of the bottom right visible cell in the table.

Leftmost visible column index
LeftmostVisibleColumnIndex integer

The column index of the leftmost visible column.

Rightmost visible column index
RightmostVisibleColumnIndex integer

The column index of the rightmost visible column.

Topmost visible row index
TopmostVisibleRowIndex integer

The row index of the topmost visible row.

Bottommost visible row index
BottommostVisibleRowIndex integer

The row index of the bottommost visible row.

Get multiple Java parent element properties

Returns the properties of all parent elements of a Java element. This action will search the entire height of the element tree returning all parent properties if the 'Max parents to process' parameter is set high enough.

Parameters

Name Key Required Type Description
Search element JAB handle
SearchElementJABHandle True integer

The element handle of the element which you want to return all of the parent elements properties for. This could be located using 'Get Java element properties' or some other search which returns an element handle.

Max string length
MaxStringLength integer

The maximum length of the description field. This can sometimes contain a large amount of text so setting a maximum value can increase search speed. By default, there is no maximum string length so full descriptions will be returned.

Max parents to process
MaxParentsToProcess integer

The maximum number of parent elements to process. By default, this is set to 50.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Java parent elements JSON
JavaParentElementsJSON string

A list of all located parent elements (and their properties), in JSON format. The properties returned are the same as those returned by the 'Get Java element properties' action.

Number of parent elements returned
NumberOfParentElementsReturned integer

The number of parent elements returned from the search.

Get visible bounding rectangle of Java element

Retrieves the visible bounds of a Java element. Typically, the Java Access Bridge will return the virtual positional values of an element, regardless of whether the element is visible on screen and these virtual values are provided by the 'Get Java element properties' action. With larger elements (e.g. a table element which can scroll) as these may not always be visible on screen, this action returns the coordinates of the currently visible area of the element.

Parameters

Name Key Required Type Description
Element JAB handle
ElementJABHandle True integer

The element handle of the element which you want to return the visible bounds for. This could be located using 'Get Java element properties' or some other search which returns an element handle.

Max parents to process
MaxParentsToProcess integer

The maximum number of parent elements to process when calculating the visible size of the specified element. By default, this is set to 50.

Parent element roles to consider
ParentElementRolesToConsider string

The roles of the parent elements to consider when calculating the element size. This is used to exclude parent elements that are smaller in size than the element which can skew the size calculation, for example page tabs. By default, these are: Panel, Viewport, Layered pane, Root pane.

Draw rectangle
DrawRectangle boolean

Should IA-Connect draw a rectangle around the element so that it is visible on screen? By default, this is set to false.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element visible rectangle left
ElementVisibleRectangleLeft integer

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

Element visible rectangle top
ElementVisibleRectangleTop integer

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

Element visible rectangle right
ElementVisibleRectangleRight integer

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

Element visible rectangle bottom
ElementVisibleRectangleBottom integer

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

Element visible rectangle width
ElementVisibleRectangleWidth integer

The visible width of the element in pixels.

Element visible rectangle height
ElementVisibleRectangleHeight integer

The visible height of the element in pixels.

Get windows access bridge connection status

Returns the current status of the connection between IA-Connect Agent and the Windows Access Bridge (WAB). If IA-Connect Agent is connected to the WAB then the relevant details are returned as outputs.

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
WAB connected
Connected boolean

Returns true if the IA-Connect Agent is connected to the Windows Access Bridge or false if not.

WAB connection type
ConnectionType string

The type of connection to the Windows Access Bridge, for example COM or Native and 32bit or 64bit.

Is WAB 64bit
IsWAB64bit boolean

Returns true if the Windows Access Bridge is 64 bit or false if not.

Connection error
ConnectionError string

The connection error, if one has been reported.

Loaded IA-JavaAccessBridge COM DLL
LoadedIAJABDLL string

The full path to the loaded IA-JavaAccessBridge COM DLL.

Loaded Windows Access Bridge DLL
LoadedWABDLL string

The full path to the loaded Windows Access Bridge DLL.

Windows Access Bridge DLL version
WABVersion string

The version of the loaded Windows Access Bridge DLL.

Get windows access bridge info

Returns information about the Windows Access Bridge (WAB) for a particular Java VM ID, including the Java and Windows DLL versions. The Java VM ID can be obtained as an output from the 'Get Java element properties' action.

Parameters

Name Key Required Type Description
VM ID
VMID True integer

The Java Virtual Machine ID. This is unique across all Java virtual machines.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Java class version
JavaClassVersion string

The Java class version, for example '1.8.0_261'.

Java DLL version
JavaDLLVersion string

The Java DLL version, for example '1.8.0_261'.

Windows DLL version
WinDLLVersion string

The Windows DLL version, for example '1.8.0_261'.

VM version
VMVersion string

The Java VM version, for example '1.8.0_261'.

Global double left mouse click on Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Click offset X
ClickOffsetX integer

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

Click offset Y
ClickOffsetY integer

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

Offset relative to
OffsetRelativeTo string

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

Delay in milliseconds
DelayInMilliseconds integer

The delay in milliseconds (thousandths of a second) between the first and second click. The default is 10 milliseconds.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global input password into Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Focus element first
FocusElement boolean

Should IA-Connect attempt to focus the element before global clicking?

Global left mouse click on element
GlobalMouseClickOnElement boolean

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

Replace existing value using double mouse click delete
ReplaceExistingValueUsingDoubleClickDelete boolean

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

Replace existing value using CTRL-A delete
ReplaceExistingValueUsingCTRLADelete boolean

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

Password to input
PasswordToInput True password

The password value to global input.

Use send key events
SendKeyEvents boolean

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

Key interval in milliseconds
KeyIntervalInMilliseconds integer

The number of milliseconds between each key press.

Double click interval in milliseconds
DoubleClickIntervalInMilliseconds integer

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

Dont interpret symbols
DontInterpretSymbols boolean

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

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global input text into Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Focus element first
FocusElement boolean

Should IA-Connect attempt to focus the element before global clicking?

Global left mouse click on element
GlobalMouseClickOnElement boolean

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

Replace existing value using double mouse click delete
ReplaceExistingValueUsingDoubleClickDelete boolean

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

Replace existing value using CTRL-A delete
ReplaceExistingValueUsingCTRLADelete boolean

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

Text to input
TextToInput string

The text value to global input using the keyboard.

Use send key events
SendKeyEvents boolean

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

Key interval in milliseconds
KeyIntervalInMilliseconds integer

The number of milliseconds between each key press.

Double click interval in milliseconds
DoubleClickIntervalInMilliseconds integer

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

Dont interpret symbols
DontInterpretSymbols boolean

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

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global left mouse click on Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Click offset X
ClickOffsetX integer

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

Click offset Y
ClickOffsetY integer

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

Offset relative to
OffsetRelativeTo string

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

Number of times to click element
NumberOfTimesToClickElement integer

The number of times to click the element, by default this is 1.

Seconds to wait between clicks
SecondsToWaitBetweenClicks double

The number of seconds to wait between clicks, by default this is 0.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global middle mouse click on Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Click offset X
ClickOffsetX integer

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

Click offset Y
ClickOffsetY integer

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

Offset relative to
OffsetRelativeTo string

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

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global mouse click on Java table cell

Moves the mouse to the centre of a Java table cell and clicks the specified mouse button.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Cell row index
RowIndex True integer

The row index of the cell in the table, starting at 1.

Cell column index
ColumnIndex True integer

The column index of the cell in the table, starting at 1.

Enumerate viewport
EnumerateViewport boolean

The viewport element typically contains the table and represents the visible area of the table. If set to 'True' (the default) then IA-Connect Agent will attempt to detect the table visible bounds and the index of the cells at each corner by calculating the size of the viewport. This allows you to determine which components of the table are currently visible on screen. If set to 'False' then the viewport coordinates will not be populated.

Process viewport parents
ProcessViewportParents boolean

If set to 'True' (the default) then the parent elements of the viewport will also be processed to help refine the visible size of the viewport. This is useful if it is embedded in another viewport. If set to 'False' then viewport parent elements will not be processed.

Max viewport parents to process
MaxViewportParentsToProcess integer

The maximum number of parent elements to process when enumerating the viewport. By default, this is set to 50.

Viewport parent element roles to consider
ViewportParentElementRolesToConsider string

The roles of the viewport parent element to consider when enumerating to calculate the viewport size. This is used to exclude parent elements that are smaller in size than the viewport which can skew the size calculation, for example page tabs. By default, these are: Panel, Viewport, Layered pane, Root pane.

Viewport left margin
ViewportLeftMargin integer

A left inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport top margin
ViewportTopMargin integer

A top inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport right margin
ViewportRightMargin integer

A right inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport bottom margin
ViewportBottomMargin integer

A bottom inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Mouse button
MouseButton True integer

The mouse button to use when clicking on the table cell. Left = 0, Right = 1, Middle = 2, Double left = 3.

Click offset X
ClickOffsetX integer

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

Click offset Y
ClickOffsetY integer

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

Offset relative to
OffsetRelativeTo string

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

Delay in milliseconds
DelayInMilliseconds integer

The number of seconds to wait between clicks, by default this is 0.05 (20 milliseconds).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Global right mouse click on Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Click offset X
ClickOffsetX integer

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

Click offset Y
ClickOffsetY integer

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

Offset relative to
OffsetRelativeTo string

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

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Input password into Java element

Inputs a password into a Java element (typically a password entry field), replacing the existing text.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Password to input
PasswordToInput True password

The password value to input.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Input text into Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Text to input
TextToInput string

The text value to input.

Replace existing value
ReplaceExistingValue boolean

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

Insert position
InsertPosition integer

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

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Is Java table cell visible onscreen

Returns whether a specific table cell within a Java table element is currently visible onscreen.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Process viewport parents
ProcessViewportParents boolean

If set to 'True' (the default) then the parent elements of the viewport will also be processed to help refine the visible size of the viewport. This is useful if it is embedded in another viewport. If set to 'False' then viewport parent elements will not be processed.

Max viewport parents to process
MaxViewportParentsToProcess integer

The maximum number of parent elements to process when enumerating the viewport. By default, this is set to 50.

Viewport parent element roles to consider
ViewportParentElementRolesToConsider string

The roles of the viewport parent element to consider when enumerating to calculate the viewport size. This is used to exclude parent elements that are smaller in size than the viewport which can skew the size calculation, for example page tabs. By default, these are: Panel, Viewport, Layered pane, Root pane.

Viewport left margin
ViewportLeftMargin integer

A left inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport top margin
ViewportTopMargin integer

A top inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport right margin
ViewportRightMargin integer

A right inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Viewport bottom margin
ViewportBottomMargin integer

A bottom inner margin for the enumerated viewport. This value can be used to exclude any cells which might be only showing by a single pixel or two and are almost entirely offscreen. By default, this is set to 2 and should only be increased if you are trying to influence the data returned by the IA-Connect Agent.

Cell row index
CellRowIndex True integer

The row index of the cell in the table, starting at 1.

Cell column index
CellColumnIndex True integer

The column index of the cell in the table, starting at 1.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Cell onscreen
CellOnScreen boolean

Returns true if the specified cell is currently displayed on screen, or false if not.

Result is certain
ResultIsCertain boolean

Returns true if the 'Cell onscreen' result is certain. This will be set to 'False' if any one of the 4 parent table bounds could not be calculated.

Offscreen direction
OffscreenDirection string

A text representation of the offscreen direction of the specified cell, e.g. Above, Below, Left or Right. If the cell is Above AND Left or Right, then this will return as Above. Similarly, if the cell is Below AND Left or Right, then this will return as Below.

Is Java window

Returns whether a UIA window is a Java element.

Parameters

Name Key Required Type Description
Parent window handle
ParentWindowHandle True integer

The parent UIA window handle to act as the starting point for the search. This can be discovered via Inspection using UIA actions such as 'Wait for desktop element' or 'Wait for element'.

Search element name
SearchElementName string

The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search element class name
SearchElementClassName string

The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search element automation ID
SearchElementAutomationId string

The optional UIA element automation ID to search for (starting from the parent window handle). This can be discovered via Inspection.

Search element localized control type
SearchLocalizedControlType string

The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.

Search UIA subtree
SearchSubTree boolean

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

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Is Java window
IsJavaWindow boolean

Returns true if the UIA element found is a Java window or false if not.

Perform action on Java element

Performs an accessible action for a Java element. These accessible actions for a specific element can be queried by using the 'Get actions for Java element' action. Some common actions are 'click' for a button or 'select-all' for a text element.

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Action
Action True string

The action to perform, for example 'click'. The action name is often case sensitive.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Press Java element

Presses a Java element (typically a button).

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Number of times to press element
NumberOfTimesToPressElement integer

The number of times to press the element, by default this is 1.

Seconds to wait between presses
SecondsToWaitBetweenPresses double

The number of seconds to wait between presses, by default this is 0.05 (20 milliseconds).

Auto detect action name
AutoDetectActionName boolean

If set to true (the default) then IA-Connect Agent will attempt to automatically detect the 'click' action name in non-English locales. If there are more than two possible actions for the element then the 'Override action name' will be used. If set to false then IA-Connect Agent will not attempt to detect the 'click' action name in non-English locales and the action may fail unless an 'Override action name' value is provided.

Override action name
OverrideActionName string

The name of the 'Click' action in non-English locales, e.g. 'cliquer' or 'hacer clic'. This can be determined from the output of the action 'Get actions for Java element' and is typically case sensitive.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Reset all Java element handles

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

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select Java list element by index

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Item index
ItemIndex True integer

The index (starting at 1) of the list item to select or deselect.

Select item
SelectItem boolean

If set to 'True' (the default) then the item will be selected. If set to 'False' then the item will be deselected. This is typically only used with a multi-select.

Clear selection first
ClearSelectionFirst boolean

If set to 'True' (the default) then the selection will be cleared first. This is mainly used for multi-selects because you need to choose if you are selecting additional items or selecting only a single item (by clearing first). If set to 'False' then the selection will not be cleared first.

Recover on failure
RecoverOnFailure boolean

If set to 'True' then the originally selected list items will be recovered if the new selection fails. For example, if item 3 was selected and you try selecting item 90 (which doesn't exist) then item 3 will be re-selected. If set to 'False' then the originally selected list items will not be recovered.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Select Java list element by name

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Item name
ItemName True string

The name of the list item to select or deselect.

Select item
SelectItem boolean

If set to 'True' (the default) then the item will be selected. If set to 'False' then the item will be deselected. This is typically only used with a multi-select.

Item name case sensitive
ItemNameCaseSensitive boolean

If set to 'True' then the item name search will be case sensitive (e.g. it must match exactly to the list item). If set to 'False' (the default) then the item name search will not be case sensitive.

Clear selection first
ClearSelectionFirst boolean

If set to 'True' (the default) then the selection will be cleared first. This is mainly used for multi-selects because you need to choose if you are selecting additional items or selecting only a single item (by clearing first). If set to 'False' then the selection will not be cleared first.

Get list of options by selecting
GetListOfOptionsBySelecting boolean

If set to 'True' then the IA-Connect Agent will attempt to obtain a list of all options in the selection by selecting each one in turn (in JAB). If set to 'False' (the default) then the 'Get list of options by reading labels' parameter should be set to 'True' otherwise the list of options will not be read.

Get list of options by reading labels
GetListOfOptionsByReadingLabels boolean

If set to 'True' (the default) then the IA-Connect Agent will attempt to obtain a list of all options in the selection by reading the child labels (in the JAB tree). For drop-down lists you will almost certainly need to set the 'Expand first' parameter to 'True' because the child elements aren't exposed until the list drops down. Also set the 'Collapse after' parameter to 'True' to close the list afterwards. The 'Get list of options by selecting' parameter should also be set to 'False' or this option will be ignored (as you can't get the list via both methods). If set to 'False' then the 'Get list of options by selecting' parameter should be set to 'True' otherwise the list of options will not be read.

Expand first
ExpandFirst boolean

If set to 'true' (the default) then the action will attempt to expand the list before searching for the list item elements. This is useful for dynamic lists as the other list item elements may not be created until the list is expanded. If set to 'false' then the list will not be expanded.

Collapse after
CollapseAfter boolean

If set to true (the default) then the list will be collapsed after executing the search. If set to false then the list will not be collapsed.

Seconds between expand and collapse
SecondsBetweenExpandCollapse double

The number of seconds to wait between the expand and collapse actions, if these are set to 'True'. By default, this is 0.05 (20 milliseconds).

Force even if in correct state
ForceEvenIfInCorrectState boolean

If set to 'True' then the element will be selected even if it is already selected. If set to 'False' (the default) then the IA-Connect Agent will do nothing if the list element is already selected.

Recover on failure
RecoverOnFailure boolean

If set to 'True' then the originally selected list items will be recovered if the new selection fails. For example, if item 3 was selected and you try selecting item 90 (which doesn't exist) then item 3 will be re-selected. If set to 'False' then the originally selected list items will not be recovered.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Wait for Java desktop element

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

Parameters

Name Key Required Type Description
Search UIA element name
SearchUIAElementName string

The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search UIA element class name
SearchUIAElementClassName string

The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search UIA element localized control type
SearchUIAElementLocalizedControlType string

The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.

Search process Id
SearchProcessID integer

The process ID of the running process. This can be retrieved as an output from the "Run Process" action.

Search child elements
SearchChildElements boolean

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

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Seconds to wait
SecondsToWait True double

The maximum number of seconds to wait for the element to exist.

Include child processes
IncludeChildProcesses boolean

If set to true and a 'Search process Id' is specified, child processes of that process Id are included in the search. This is common for Java since a launcher EXE often then runs a child 'Java(w).exe' process. If set to false then only a process matching the exact 'Search process Id' will be returned.

Raise exception if element not found
RaiseExceptionIfElementNotFound boolean

Should IA-Connect raise an exception if the Java element does not exist after the wait period?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element exists
ElementExists boolean

Returns true if the element exists or false if not.

Element JAB handle
ElementJABHandle integer

If the search element was found, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further searches (i.e. to locate elements relative to this handle).

Element name
ElementName string

The Java name of the located element.

Element description
ElementDescription string

The Java description of the located element (if there is one).

Element role
ElementRole string

The Java role (e.g. frame or panel) of the located element (if there is one).

Wait for Java desktop element to not exist

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

Parameters

Name Key Required Type Description
Search UIA element name
SearchUIAElementName string

The optional UIA element name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search UIA element class name
SearchUIAElementClassName string

The optional UIA element class name to search for (starting from the parent window handle). This can be discovered via Inspection.

Search UIA element localized control type
SearchUIAElementLocalizedControlType string

The optional UIA element localized control type to search for (starting from the parent window handle). This can be discovered via Inspection.

Search process Id
SearchProcessID integer

The process ID of the running process. This can be retrieved as an output from the "Run Process" action.

Search child elements
SearchChildElements boolean

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

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Seconds to wait
SecondsToWait True double

The maximum number of seconds to wait for the element to not exist.

Include child processes
IncludeChildProcesses boolean

If set to true and a 'Search process Id' is specified, child processes of that process Id are included in the search. This is common for Java since a launcher EXE often then runs a child 'Java(w).exe' process. If set to false then only a process matching the exact 'Search process Id' will be returned.

Raise exception if element still exists
RaiseExceptionIfElementStillExists boolean

Should IA-Connect raise an exception if the Java element still exists after the wait period?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element exists before wait
ElementExistsBeforeWait boolean

Returns true if the element existed before waiting or false if not.

Element exists after wait
ElementExistsAfterWait boolean

Returns true if the element existed after waiting or false if not.

Wait for Java element

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Seconds to wait
SecondsToWait True double

The maximum number of seconds to wait for the element to exist.

Raise exception if element not found
RaiseExceptionIfElementNotFound boolean

Should IA-Connect raise an exception if the Java element does not exist after the wait period?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element exists
ElementExists boolean

Returns true if the element exists or false if not.

Element JAB handle
ElementJABHandle integer

If the search element was found, this will hold a numeric element handle which can be used in further actions to act as a 'parent' handle for further searches (i.e. to locate elements relative to this handle).

Element name
ElementName string

The Java name of the located element.

Element description
ElementDescription string

The Java description of the located element (if there is one).

Element role
ElementRole string

The Java role (e.g. frame or panel) of the located element (if there is one).

Wait for Java element to not exist

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

Parameters

Name Key Required Type Description
Parent element JAB handle
SearchParentElementJABHandle True integer

The Java element handle which is a parent of the element you are searching for. This could be a window you located earlier using 'Wait for Java desktop element'.

Search Java element name
SearchElementJABName string

The optional Java name of the element to search for. This can be discovered via Inspection.

Search Java element description
SearchElementJABDescription string

The optional Java element description of the element to search for. This can be discovered via Inspection.

Search Java element role
SearchElementJABRole string

The optional Java element role of the element to search for. This can be discovered via Inspection.

Search child elements
SearchSubTree boolean

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

Maximum relative depth
MaxRelativeDepth integer

The maximum relative depth to search from the parent element for child elements. Direct child elements will have a depth value of 0.

Match index
MatchIndex integer

If multiple elements match the search, which element (starting at 1) should be matched. Can be used in conjunction with 'Sort by column' to choose the sort order for matching.

Search filter
SearchFilter string

An optional advanced filter to further restrict the search using conditional operators and any element field. Example 1: [Width] < 200. Example 2: [Name] like 'Document*' AND [Role] like 'Label*'. See the documentation for more examples.

Sort by column name
SortByColumn string

If multiple elements match the search, this allows you to specify which element property to sort by. This will be used in conjunction with 'Match index' to pick the required element. For example: If 'Sort by column name' is [TopEdge] and 'Match index' is 1 then the matching element nearest the top of the screen will be matched.

Match index is ascending
MatchIndexAscending boolean

If multiple elements match the search, should 'Match index' match from the top of the sorted list (true) or from the bottom of the sorted list (false).

Case sensitive search
CaseSensitiveSearch boolean

Should the element search be case sensitive? When set to True, only elements matching the exact string/text searches will be returned. By default, this is set to false.

Only search visible elements
OnlySearchVisibleElements boolean

Should only visible elements be searched? By default, this is set to true.

Only search showing elements
OnlySearchShowingElements boolean

Should only showing elements be searched? Showing elements are typically items displayed in an alternative tab or collapsed menu. By default, this is set to true.

Element roles not to traverse
ElementRolesNotToTraverse string

A comma separated list of roles to not traverse (step into) when searching. The search will still check if the element matches the search criteria however it will not search any child elements. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum elements to search
MaximumElementsToSearch integer

The maximum number of elements to search when looking for the target element, restricting the search to only check the first N number of elements found in the Java tree. By default, this is set to 2000. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Maximum child elements to search per node
MaximumChildElementsToSearchPerNode integer

The maximum number of child elements to search in each element when looking for the target element, restricting the search to only check the first N number of child elements found for each element in the Java tree. By default, this is set to 200. This parameter can be used to optimise element searching. This is only used if the 'Search child elements' input parameter is set to 'True'.

Seconds to wait
SecondsToWait True double
Raise exception if element still exists
RaiseExceptionIfElementStillExists boolean

Should IA-Connect raise an exception if the Java element still exists after the wait period?

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Name Path Type Description
Element exists before wait
ElementExistsBeforeWait boolean

Returns true if the element existed before waiting or false if not.

Element exists after wait
ElementExistsAfterWait boolean

Returns true if the element existed after waiting or false if not.