Function API Reference

Last update: Edit

Widget_Set

For a Mendix widget input a selection, checkbox, number, text value or a date.

Function Name Description
Set Checkbox Set Selector Value Checks/clears a check box in a set selector by given entity attribute value.
Set Checkbox Set Selector Value (all) Checks/clears the ‘select all’ check box.
Set Checkbox Value Sets the value of a check box.
Set File Manager Set a file manager to the given file path to upload a file.
Set Grid Selector Checkbox Value Checks/clears a check box for a given column and row caption in a grid selector widget.
Set Grid Selector Radiobutton checked Selects the radio button for a given column and row caption in a grid selector widget.
Set Row Cell Value Sets the cell value for a particular column in a data grid row.
Set Simple Checkbox Set Selector Value Checks/clears the check box for a given entity attribute value.
Set Value Sets a value to a widget. Supported widgets: text box, text area, drop down, radio button, date picker, reference selector, search input text, search input drop down, OnChange Inputbox, CKEditor For Mendix BooleanSlider, BootstrapWysiwygEditor (Bootstrap RTE), InputReferenceSelector, RadiobuttonList.
Set Value (by index) Sets the value of drop down widgets by index. Supported widgets: drop down, reference selector, search input drop down, EnumSelect.

Set Checkbox Set Selector Value

Function Key

SetCheckboxSetSelectorValue

Description

Checks/clears a check box in a set selector by given entity attribute value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.
Checked Checked Boolean Required If true then checks the check box/radio button, otherwise clears it.

Return Value

None

Set Checkbox Set Selector Value (all)

Function Key

SetCheckboxSetSelectorValueAll

Description

Checks/clears the ‘select all’ check box.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Checked Checked Boolean Required If true then checks the check box/radio button, otherwise clears it.

Return value

None

Set Checkbox Value

Function Key

SetCheckboxValue

Description

Sets the value of a check box.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value Boolean Required If true then checks the check box/radio button, otherwise clears it.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return value

None

Set File Manager

Function Key

SetFileManager

Description

Set a file manager to the given file path to upload a file.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
File Path FilePath String Required Full path to the local file, on the client system, to be uploaded.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return value

None

Set Grid Selector Checkbox Value

Function Key

SetGridSelectorCheckboxValue

Description

Checks/clears a check box for a given column and row caption in a grid selector widget.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Row Caption RowCaption String Required Used to identify a row by it’s caption in a grid selector widget. The caption should match the label as shown in the browser.
Checked Checked Boolean Required If true then checks the check box/radio button, otherwise clears it.

Return Value

None.

Set Grid Selector Radiobutton checked

Function Key

SetGridSelectorRadiobuttonChecked

Description

Selects the radio button for a given column and row caption in a grid selector widget.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Row Caption RowCaption String Required Used to identify a row by it’s caption in a grid selector widget. The caption should match the label as shown in the browser.

Return Value

None.

Set Row Cell Value

Function Key

SetRowCellValue

Description

Sets the cell value for a particular column in a data grid row.

Input Parameters

Name Key Datatype Description
Datagrid Row Datagrid Row WebElement Required A data grid row as a web element. You can use the functions ‘Find/Assert DataGrid Row’ and ‘Find Item/Row’ to obtain a reference to the correct web element.
Value Value String Required The value to set.
Column Name ColumnName String Required Name of the column as assigned in the Mendix Studio Pro. This is not the caption of the column.

Return Value

None.

Set Simple Checkbox Set Selector Value

Function Key

SetSimpleCheckboxSetSelectorValue

Description

Checks/clears the check box for a given entity attribute value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.
Checked Checked Boolean Required If true then checks the check box/radio button, otherwise clears it.

Return Value

None.

Set Value

Function Key

SetValue

Description

Sets a value to a widget.
Supported widgets: text box, text area, drop down, radio button, date picker, reference selector, search input text, search input drop down, OnChange Inputbox, CKEditor For Mendix BooleanSlider, BootstrapWysiwygEditor (Bootstrap RTE), InputReferenceSelector, RadiobuttonList.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Required The value to set. The date/time format depends on the device type. For mobile devices the date/time should be formatted in the ISO 8601 standard meaning, ‘yyyy-MM-ddTHH:mm’ for date and time, or ‘yyyy-MM-dd’ for date, or ‘HH:mm’ for just the time. Seconds should be omitted. For desktop devices the string should be formatted so as to match the date/time picker format. This format is locale dependent, for example for the US the format is ‘MM/dd/yyyy, hh:mm a’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return value

None

Set Value (by index)

Function Key

SetValueByIndex

Description

Sets the value of drop down widgets by index.

Supported widgets: drop down, reference selector, search input drop down, EnumSelect.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Index Index Integer Required Starts from 0, meaning the first element has index 0, the second element has index 1 etc.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

None.

Widget_Get

Read text, dates, numbers and selections from Mendix widgets.

Function Name Description
Get Validation Message Returns the validation message of a widget.
Get Value Returns the current value of all supported widgets. Supported widgets: text box, text area, drop down, radio button, date picker, reference selector, search input text, search input drop down, label, input reference set selector, OnChange Inputbox, BooleanSlider, BootstrapWysiwygEditor (Bootstrap RTE), CKEditor For Mendix, InputReferenceSelector RadiobuttonList, Switch, AutoComplete, Format String, Custom String.
Get Active Tab Name Returns the name of the active tab page as specified in the Studio Pro. This is not the same as the caption of the tab which is shown in the browser.
Get Item/Row Index Returns the index of a row in a data grid, or an item in a template grid or list view. Indexing is 0 based, meaning the first row/item has index 0, the second row/item has index 1 etc.
Get Row Cell Value Gets the cell value of a data grid row for a given column name.
Get Total Item/Row Count Returns the total grid count from the paging status. Does not work if pagination is not shown. Supported widgets: data grid, template grid, list view.
Get Visible Item/Row Count Returns the number of currently visible items/rows in a data grid, template grid or a list view.
Get Checkbox Value Returns true if the check box is checked, false otherwise.
Get Index Gets the index of selected values in a drop-down menu. The returned index is 0 based, meaning the first element has index 0, the second element has index 1 etc. Supported widgets: drop down, reference selector, search input drop down.
Groupbox is Collapsed Returns true if the group box is collapsed, false otherwise.
Get Checkbox Set Selector Value Finds a check box by column caption and cell value and returns its value. The returned value is ‘true’ when the check box is checked, false otherwise.
Get Checkbox Set Selector Value (all) Returns the ‘select all’ check box value. The returned value is ‘true’ when the check box is checked, false otherwise.
Get Simple Checkbox Set Selector Value Returns the current value of a check box in a set selector widget found by entity attribute value. The returned value is ‘true’ when the check box is checked, false otherwise.
Get Grid Selector Box Value Returns the current value of check box/radio button for a given row and column captions in a grid selector. The returned value is ‘true’ if the check box/radio button is checked, false otherwise.
Get Dialog Message Text Get the text from message and confirmation dialogs.

Get Validation Message

Function Key

GetValidationMessage

Description

Returns the validation message of a widget.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return value

String

Get Value

Function Key

GetValue

Description

Returns the current value of all supported widgets.

Supported widgets: text box, text area, drop down, radio button, date picker, reference selector, search input text, search input drop down, label, input reference set selector, OnChange Inputbox, BooleanSlider, BootstrapWysiwygEditor (Bootstrap RTE), CKEditor For Mendix, InputReferenceSelector RadiobuttonList, Switch, AutoComplete, Format String, Custom String.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

String The value to set.

Get Active Tab Name

Function Key

GetActiveTabName

Description

Returns the name of the active tab page as specified in the Studio Pro.

This is not the same as the caption of the tab which is shown in the browser.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext String Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return value

String The name of a tab page as it is specified in the Studio Pro.

This is not the same as the caption of the tab which is shown in the browser.

Get Item/Row Index

Function Key

GetItemRowIndex

Description

Returns the index of a row in a data grid, or an item in a template grid or list view.

Indexing is 0 based, meaning the first row/item has index 0, the second row/item has index 1 etc.

Input Parameters

Name Key Datatype Description
Item/Row ItemRow WebElement Required A data grid row or an item from a template grid or a list view. Use the ‘Find/Assert DataGrid Row’, ‘Find Item/Row’ or ‘Find Item/Row (by child element)’ to get a reference to the correct web element.

Return Value

Integer Starts from 0, meaning the first element has index 0, the second element has index 1 etc.

Get Row Cell Value

Function Key

GetRowCellValue

Description

Gets the cell value of a data grid row for a given column name.

Input Parameters

Name Key Datatype Description
Datagrid Row Datagrid Row WebElement Required A data grid row as a web element. You can use the functions ‘Find/Assert DataGrid Row’ and ‘Find Item/Row’ to obtain a reference to the correct web element.
Column Name ColumnName String Required Name of the column as assigned in the Mendix Studio Pro. This is not the caption of the column.

Return Value

String The value to set.

Get Total Item/Row Count

Function Key

GetTotalItemRowCount

Description

Returns the total grid count from the paging status.

Does not work if pagination is not shown.

Supported widgets: data grid, template grid, list view.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

Integer Number of Rows/Items.

Get Visible Item/Row Count

Function Key

GetVisibleItemRowCount

Description

Returns the number of currently visible items/rows in a data grid, template grid or a list view.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

Integer Number of Rows/Items.

Get Checkbox Value

Function Key

GetCheckboxValue

Description

Returns true if the check box is checked, false otherwise.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

Boolean Value of the checkbox. True if checked, false if not

Get Index

Function Key

GetIndex

Description

Gets the index of selected values in a drop-down menu.

The returned index is 0 based, meaning the first element has index 0, the second element has index 1 etc.

Supported widgets: drop down, reference selector, search input drop down.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

Integer The index of the selected option. Starts with 0 for the first option

Groupbox is Collapsed

Function Key

GroupboxIsCollapsed

Description

Returns true if the group box is collapsed, false otherwise.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

Boolean Collapsed state of the GroupBox. True if it is collapsed, false if not.

Get Checkbox Set Selector Value

Function Key

GetCheckboxSetSelectorValue

Description

Finds a check box by column caption and cell value and returns its value.

The returned value is ‘true’ when the check box is checked, false otherwise.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.

Return Value

Boolean If true then checks the check box/radio button, otherwise clears it.

Get Checkbox Set Selector Value (all)

Function Key

GetCheckboxSetSelectorValueAll

Description

Returns the ‘select all’ check box value.

The returned value is ‘true’ when the check box is checked, false otherwise.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.

Return Value

Boolean If true then checks the check box/radio button, otherwise clears it.

Get Simple Checkbox Set Selector Value

Function Key

GetSimpleCheckboxSetSelectorValue

Description

Returns the current value of a check box in a set selector widget found by entity attribute value.

The returned value is ‘true’ when the check box is checked, false otherwise.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.

Return Value

Boolean If true then checks the check box/radio button, otherwise clears it.

Get Grid Selector Box Value

Function Key

GetGridSelectorBoxValue

Description

Returns the current value of check box/radio button for a given row and column captions in a grid selector.

The returned value is ‘true’ if the check box/radio button is checked, false otherwise.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Row Caption RowCaption String Required Used to identify a row by it’s caption in a grid selector widget. The caption should match the label as shown in the browser.

Return Value

Boolean If true then checks the check box/radio button, otherwise clears it.

Get Dialog Message Text

Function Key

GetDialogMessageText

Description

Get the text from message and confirmation dialogs.

Input Parameters

Name Key Datatype Description
Dialog Dialog WebElement Required A Mendix dialog as a web element. Use the ‘Find/Assert Dialog’ to get a reference to the correct web element.

Return Value

String The message or confirmation text to be asserted.

Widget_Assert

Check if a Mendix widget value such as text and selection match an expected value.

Function Name                 Description
Assert Validation Message Asserts that the validation message for a certain widget contains the specified text.
Assert Active Tab Name Assert a certain value for the name of the active tab page.
Assert Checkbox Value Assert the value of a check box.
Assert Value Asserts the current value of all supported widgets. Supported widgets: text box, text area, drop down, radio button, date picker, reference selector, search input text, search input drop down, label, input reference set selector, OnChange Inputbox, BooleanSlider, BootstrapWysiwygEditor (Bootstrap RTE), CKEditor For Mendix, InputReferenceSelector, RadiobuttonList, Switch, AutoComplete, Format String, Custom String.
Dropdown has Option Returns true if the given value is available in a drop down menu. Supported widgets: drop down, reference selector, search input drop down.
Assert Checkbox Set Selector Value Finds a check box by entity attribute value and asserts that the check box is set to a given value.
Assert Checkbox Set Selector Value Finds a check box by entity attribute value and asserts that the check box is set to a given value.
Assert Simple Checkbox Set Selector Value Asserts that the check box found by given entity attribute value is checked/cleared.
Assert Grid Selector Value Asserts the value of check box/radio button for a given column and row captions in a grid selector.

Assert Validation Message

Function Key

AssertValidationMessageNegetable

Description

Asserts that the validation message for a certain widget contains the specified text.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Validation Message ValidationMessage String Required Text which is expected to be part of the validation message.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None

Assert Active Tab Name

Function Key

AssertActiveTabNameNegetable

Description

Assert a certain value for the name of the active tab page.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Active Tab Name ActiveTabName String Required The name of a tab page as it is specified in the Studio Pro. This is not the same as the caption of the tab which is shown in the browser.
Search Context SearchContext String Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert Checkbox Value

Function Key

AssertCheckboxValueNegetable

Description

Assert the value of a check box.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value Boolean Required Expected status of the check box. A checked check box corresponds to ‘true’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert Value

Function Key

AssertValueNegetable

Description

Asserts the current value of all supported widgets.

Supported widgets: text box, text area, drop down, radio button, date picker, reference selector, search input text, search input drop down, label, input reference set selector, OnChange Inputbox, BooleanSlider, BootstrapWysiwygEditor (Bootstrap RTE), CKEditor For Mendix, InputReferenceSelector, RadiobuttonList, Switch, AutoComplete, Format String, Custom String.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Required Expected value. This is the text as shown in the browser, not a technical value or id.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Negate NegateParameter Boolean Required Negetes the asssert

Return value

None.

Function Key

DropdownHasOption

Description

Returns true if the given value is available in a drop down menu.

Supported widgets: drop down, reference selector, search input drop down.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Required The value of the drop down option that you want to assert. This is the text as shown in the browser, not a technical value or id.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

Boolean True if option with specified value is available in dropdown

Assert Checkbox Set Selector Value

Function Key

AssertCheckboxSetSelectorValue

Description

Finds a check box by entity attribute value and asserts that the check box is set to a given value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.
Checked Checked Boolean Required Expected status of a check box/radio button. A checked check box(radio button corresponds to the value ‘true’.

Return Value

None.

Assert Checkbox Set Selector Value

Function Key

AssertCheckboxSetSelectorValueNegetable

Description

Finds a check box by entity attribute value and asserts that the check box is set to a given value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.
Checked Checked Boolean Required Expected status of a check box/radio button. A checked check box(radio button corresponds to the value ‘true’.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert Simple Checkbox Set Selector Value

Function Key

AssertSimpleCheckboxSetSelectorValueNegetable

Description

Asserts that the check box found by given entity attribute value is checked/cleared.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.
Checked Checked Boolean Required Expected status of a check box/radio button. A checked check box(radio button corresponds to the value ‘true’.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert Grid Selector Value

Function Key

AssertGridSelectorValueNegetable

Description

Asserts the value of check box/radio button for a given column and row captions in a grid selector.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Row Caption RowCaption String Required Used to identify a row by it’s caption in a grid selector widget. The caption should match the label as shown in the browser.
Checked Checked Boolean Required Expected status of a check box/radio button. A checked check box(radio button corresponds to the value ‘true’.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Widget_Find

Find Mendix widgets and their child elements in the browser window by identifier or content.

Function Name                 Description
Find/Assert Widget Child Node Find/assert a node within a Mendix widget. Also matches the widget node itself. The action is limited to search in only within widgets that are visible.
Find/Assert Menu Item Finds/asserts a visible menu item in a navigation tree, menu bar, and simple menu bar.
Find/Assert DataGrid Row Finds/asserts a data grid row by a certain column value(s). If no column name/value pair is specified then the first row is returned. When multiple column name/value pairs are specified then a row must match all of them.
Find/Assert Item/Row (by index) Finds/asserts a row/item in a data grid, template grid, or list view by index.
Find Item/Row (by child element) Returns a row/item of a template grid, data grid or list view, which contains the specified element.
Find/Assert Selected Item/Row Finds/asserts the first selected item/row as a web element.
Find/Assert Widget Finds/asserts a Mendix widget by its given name and optionally value.
Find/Assert Checkbox Set Selector Finds/asserts a check box by a given cell value and column caption. Returns the first match.
Find Checkbox Set Selector (all) Returns the ‘select all’ checkbox for a set selector widget.
Find/Assert Simple Checkbox Set Selector Finds/asserts the check box by the given entity attribute value.
Find/Assert Grid Selector Finds/asserts a check box/radio button for a given column and row captions in a grid selector widget.
Find/Assert Dialog Finds/asserts a dialog by title or type. Supported widgets: window, dialog message, confirmation dialog.

Find/Assert Widget Child Node

Function Key

FindWidgetChildNodeNegetable

Description

Find/assert a node within a Mendix widget.

Also matches the widget node itself.

The action is limited to search in only within widgets that are visible.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Child Node Selector ChildNodeSelector String Required Used to constrain the matching child widgets. For example use: \”:contains(‘foo’)\” to find only widget that contain the text ‘foo’ inside. Check the ATS reference guide for a complete list of available selectors.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement The child node of the widget as a web element.

Find/Assert Menu Item<

Function Key

FindAssertMenuItemNegetable

Description

Finds/asserts a visible menu item in a navigation tree, menu bar, and simple menu bar.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Caption Caption String Required Caption of the menu item as shown in the browser.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement Menu Item as a Web Element.

Find/Assert DataGrid Row

Function Key

FindAssertDataGridRowNegetabke

Description

Finds/asserts a data grid row by a certain column value(s).

If no column name/value pair is specified then the first row is returned.

When multiple column name/value pairs are specified then a row must match all of them.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column 1 Name Column1Name String Optional Name of the column as assigned in the Mendix Studio Pro. This is not the caption of the column.
Column 1 Value Column1Value String Optional This value is used to identify a specific row in the data grid. The search is performed on the column that matches the ‘Column 1 Name’.
Column 2 Name Column2Name String Optional Name of the column as assigned in the Mendix Studio Pro. This is not the caption of the column.
Column 2 Value Column2Value String Optional This value is used to identify a specific row in the data grid. The search is performed on the column that matches the ‘Column 2 Name’.
Column 3 Name Column3Name String Optional Name of the column as assigned in the Mendix Studio Pro. This is not the caption of the column.
Column 3 Value Column3Value String Optional This value is used to identify a specific row in the data grid. The search is performed on the column that matches the ‘Column 3 Name’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement A data grid row as a web element.

You can use the functions ‘Find/Assert DataGrid Row’ and ‘Find Item/Row’

to obtain a reference to the correct web element.

Find/Assert Item/Row (by index)

Function Key

FindItemRowNegetable

Description

Finds/asserts a row/item in a data grid, template grid, or list view by index.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Index Index Integer Required Starts from 0, meaning the first element has index 0, the second element has index 1 etc.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement A data grid row or an item from a template grid or a list view.

Use the ‘Find/Assert DataGrid Row’, ‘Find Item/Row’ or ‘Find Item/Row (by child element)’ to get a reference to the correct web element.

Find Item/Row (by child element)

Function Key

FindItemRowByChildElement

Description

Returns a row/item of a template grid, data grid or list view, which contains the specified element.

Input Parameters

Name Key Datatype Description
Widget Child Node Widget Child Node WebElement Required The child node of the widget as a web element.

Return Value

WebElement Menu Item as a Web Element.

Find/Assert Selected Item/Row

Function Key

FindSelectedItemRowNegetable

Description

Finds/asserts the first selected item/row as a web element.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement A data grid row or an item from a template grid or a list view.

Use the ‘Find/Assert DataGrid Row’, ‘Find Item/Row’ or ‘Find Item/Row (by child element)’ to get a reference to the correct web element.

Find/Assert Widget

Function Key

FindAssertWidgetNegetable

Description

Finds/asserts a Mendix widget by its given name and optionally value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Optional The value in the widget. Supply this if you want to restrict the result by this value. For example, when there are several instances of a widget with the same name. Supported widgets: text box, text area, date picker, drop down, radio button, referece selector, search input text, search input drop down, label.
Visible Only VisibleOnly Boolean Optional If set to true, it will only return widgets that are visible. When false the all widgets are returned, reagardles of visiblity. Defaults to false.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Additional Selector AdditionalSelector String Optional Used to additionaly constrain the matching widgets. For example, use \”:contains(‘foo’)\” to find all widget that contain the text ‘foo’. Check the ATS reference guide for a complete list of available selectors.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement The Widget as a Web Element.

Find/Assert Checkbox Set Selector

Function Key

FindCheckboxSetSelectorNegetable

Description

Finds/asserts a check box by a given cell value and column caption. Returns the first match.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement

Find Checkbox Set Selector (all)

Function Key

FindCheckboxSetSelectorAll

Description

Returns the ‘select all’ checkbox for a set selector widget.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.

Return value

WebElement

Find/Assert Simple Checkbox Set Selector

Function Key

FindSimpleCheckboxSetSelectorNegetable

Description

Finds/asserts the check box by the given entity attribute value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement

Find/Assert Grid Selector

Function Key

FindGridSelectorNegetable

Description

Finds/asserts a check box/radio button for a given column and row captions in a grid selector widget.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Row Caption RowCaption String Required Used to identify a row by it’s caption in a grid selector widget. The caption should match the label as shown in the browser.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement

Find/Assert Dialog

Function Key

FindAssertDialogNegetable

Description

Finds/asserts a dialog by title or type.

Supported widgets: window, dialog message, confirmation dialog.

Input Parameters

Name Key Datatype Description
Dialog Title DialogTitle String Optional The dialog title as shown in the browser.
Dialog Type DialogType Enumeration Optional Used to distignguish between the different dialogs. For example: info, warning or error.
Text DialogText String Optional The message or confirmation text to be asserted.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement A Mendix dialog as a web element.

Use the ‘Find/Assert Dialog’ to get a reference to the correct web element.

Widget_Other

Interact with data grid controls (for example, search), menu items and group-boxes. Offers support for toggling checkboxes and sliders.

Function Name Description
Click DataGrid Row Clicks a data grid row by a certain column value.
Click Dropdown Div Converter dropdown button Clicks the ‘drop down div converter’ drop down button.
Click Dropdown Div Converter split button Clicks the ‘drop down div converter’ split button.
Click Menu Item Clicks a menu item in a navigation tree, menu bar, and simple menu bar.
Click Widget Clicks a Mendix widget (for example, button, link, image) by its name.
Click Widget Button Clicks on one of the following special widget buttons: refresh, load more, clear search field (list view), go to, add (reference selector).
Close GroupBox Closes a group box.
Open GroupBox Opens a group box.
Sort DataGrid Sorts a data grid by a given column.
Toggle BooleanSlider Value Toggles the value of a Booleanslider.
Toggle Checkbox Set Selector Finds a check box by a given entity attribute and inverses the value.
Toggle Checkbox Set Selector (all) Inverses the ‘select all’ check box.
Toggle Checkbox Value Clicks on a check box to toggle its value.
Toggle Grid Selector Checkbox Value Inverses the check box found by a given column and row caption.
Toggle Simple Checkbox Set Selector Value Inverses the value of the check box found by a given entity attribute value.
Cancel Dialog Clicks ‘Cancel’ on a confirmation dialog. The dialog can optionally be constrained by name or type.
Close Dialog Clicks the ‘X’ button on a confirmation, error, warning or info dialog box. The dialog can optionally be constrained by name or type.
Confirm Dialog Clicks the ‘Proceed/Ok’ button on a confirmation, error, warning or info dialog box. The dialog can optionally be constrained by name or type.
Set ListView Search Sets the search text for a list view.

Click DataGrid Row

Function Key

ClickDataGridRow

Description

Clicks a data grid row by a certain column value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Name ColumnName String Required Name of the column as assigned in the Mendix Studio Pro. This is not the caption of the column.
Column Value ColumnValue String Required Value that you expect in the column of the row.
Doubleclick Doubleclick Boolean Optional If true performs a doubleclick, otherwise does a single click. Defaults to false.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

None

Click Dropdown Div Converter dropdown button

Function Key

ClickDropdownDivConverterDropdownButton

Description

Clicks the ‘drop down div converter’ drop down button.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.

Return Value

None.

Click Dropdown Div Converter split button

Function Key

ClickDropdownDivConverterSplitButton

Description

Clicks the ‘drop down div converter’ split button.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.

Return Value

None.

Click Menu Item

Function Key

ClickMenuItem

Description

Clicks a menu item in a navigation tree, menu bar, and simple menu bar.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Caption Caption String Required Caption of the menu item as shown in the browser.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

None.

Click Widget

Function Key

ClickWidget

Description

Clicks a Mendix widget (for example, button, link, image) by its name.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Doubleclick Doubleclick Boolean Optional If true performs a doubleclick, otherwise does a single click. Defaults to false.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

None.

Click Widget Button

Function Key

ClickWidgetButton

Description

Clicks on one of the following special widget buttons: refresh, load more, clear search field (list view), go to, add (reference selector).

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Button Button Enumeration Required Defines which widget button to click.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

None.

Close GroupBox

Function Key

CloseGroupBox

Description

Closes a group box.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

None.

Open GroupBox

Function Key

OpenGroupBox

Description

Opens a group box.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

None.

Sort DataGrid

Function Key

SortDataGrid

Description

Sorts a data grid by a given column.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Name ColumnName String Required Name of the column as assigned in the Mendix Studio Pro. This is not the caption of the column.

Return Value

None.

Toggle BooleanSlider Value

Function Key

ToggleBooleanSliderValue

Description

Toggles the value of a Booleanslider.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.

Return Value

None.

Toggle Checkbox Set Selector

Function Key

ToggleCheckboxSetSelector

Description

Finds a check box by a given entity attribute and inverses the value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.

Return Value

None.

Toggle Checkbox Set Selector (all)

Function Key

ToggleCheckboxSetSelectorAll

Description

Inverses the ‘select all’ check box.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.

Return Value

None

Toggle Checkbox Value

Function Key

ToggleCheckboxValue

Description

Clicks on a check box to toggle its value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

None.

Toggle Grid Selector Checkbox Value

Function Key

ToggleGridSelectorCheckboxValue

Description

Inverses the check box found by a given column and row caption.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Column Caption ColumnCaption String Required Used to identify a column by it’s caption in a set/grid selector widget. The caption should match the label as shown in the browser.
Row Caption RowCaption String Required Used to identify a row by it’s caption in a grid selector widget. The caption should match the label as shown in the browser.

Return Value

None.

Toggle Simple Checkbox Set Selector Value

Function Key

ToggleSimpleCheckboxSetSelectorValue

Description

Inverses the value of the check box found by a given entity attribute value.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Required The entitiy attribute value which is used to find the correct row in the widget.

Return Value

None.

Cancel Dialog

Function Key

CancelDialog

Description

Clicks ‘Cancel’ on a confirmation dialog.

The dialog can optionally be constrained by name or type.

Input Parameters

Name Key Datatype Description
Dialog Title DialogTitle String Optional The dialog title as shown in the browser.
Dialog Type DialogType Enumeration Optional Used to distignguish between the different dialogs. For example: info, warning or error.

Return Value

None.

Close Dialog

Function Key

CloseDialog

Description

Clicks the ‘X’ button on a confirmation, error, warning or info dialog box.

The dialog can optionally be constrained by name or type.

Input Parameters

Name Key Datatype Description
Dialog Title DialogTitle String Optional The dialog title as shown in the browser.
Dialog Type DialogType Enumeration Optional Used to distignguish between the different dialogs. For example: info, warning or error.

Return Value

None.

Confirm Dialog

Function Key

ConfirmDialog

Description

Clicks the ‘Proceed/Ok’ button on a confirmation, error, warning or info dialog box.

The dialog can optionally be constrained by name or type.

Input Parameters

Name Key Datatype Description
Dialog Title DialogTitle String Optional The dialog title as shown in the browser.
Dialog Type DialogType Enumeration Optional Used to distignguish between the different dialogs. For example: info, warning or error.

Return Value

None.

Set ListView Search

Function Key

SetListViewSearch

Description

Sets the search text for a list view.

Input Parameters

Name Key Datatype Description
Widget Name WidgetName String Required The name that was assigned in the Studio Pro to that widget, for example, ‘textBox1’. Use the ‘ATS Helper’ bookmarklet to see the names of different widgets in you page. For further qualification you can additionally put in the names of surrounding widgets separated by a single space, for example, ‘dataView1 textBox1’.
Value Value String Required The value to set.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.

Return Value

None

Mendix

Inspect and interact with Mendix elements such as validation messages, dialogs, pages, tabs and more.

Function Name                 Description
Mendix Wait Wait for microflow and UI activities.
Login Logs in to the Mendix application with the standard login page or on the cloud using Mendix single-sign on.
Logout Triggers the logout/logoff from application via the Client API. Use this keyword in the teardown of your test cases to end the user session. This function will work regardless of the UI state.
Get Current Page Title Returns the current page/form title.
Assert Current Page Asserts that a certain page is open, by checking the current page title. Note that the page title may depend on the user’s language! For dialog boxes use the Find/Assert Dialog function.
Open Mendix Application Opens a Mendix application at the website URL in a browser with Mendix-specific settings.

Mendix Wait

Function Key

MendixWaitCustomTimeout

Description

Wait for microflow and UI activities.

Input Parameters

Name Key Datatype Description
Timeout (ms) Timeout_ms) Integer Optional Timeout for implicit wait in milliseconds (defaults to 60 seconds if left empty)

Return Value

None.

Login

Function Key

Login

Description

Logs in to the Mendix application with the standard login page or on the cloud using Mendix single-sign on.

Input Parameters

Name Key Datatype Description
Username Username String Required Account username. For Mendix SSO this it the email that is associated to the Mendix profile.
Password Password String Required Account password. For Mendix SSO this is the same password that is used to access the Mendix cloud portal.
Use MxID UseMxID Boolean Optional If true will use the Mendix single sign on, otherwise the default login page is used. Deafaults to false.

Return Value

None.

Logout

Function Key

Logout

Description

Triggers the logout/logoff from application via the Client API.

Use this keyword in the teardown of your test cases to end the user session.

This function will work regardless of the UI state.

Input Parameters

None.

Return Value

None.

Get Current Page Title

Function Key

GetCurrentPageTitle

Description

Returns the current page/form title.

Input Parameters

None

Return Value

String Title of the current Mendix page. Language dependant.

Assert Current Page<

Function Key

AssertCurrentPageNegatable

Description

Asserts that a certain page is open, by checking the current page title.

Note that the page title may depend on the user’s language!

For dialog boxes use the Find/Assert Dialog function.

Input Parameters

Name Key Datatype Description
Page Title PageTitle String Required Expected title of the current Mendix page. Language dependant.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Open Mendix Application

Function Key

OpenMendixApplication

Description

Opens a Mendix application at the website URL in a browser with Mendix-specific settings.

Input Parameters

Name Key Datatype Description
URL URL String Required Website URL, must start with ‘http://’ or ‘https://‘.

Return Value

None.

Web

Uses the Selenium web driver to interact with the browser and the native html elements. Also offers actions for JavaScript injection.

Function Name                 Description
Close Window Closes currently active window. Does not switch to another window automatically.
Close Window & Auto-Switch Closes the currently active window and automatically switches to the next one.
Element matches Selector Returns whether the given element matches a selector for example, :contains(‘foo’) or :first-child. Check out the reference guide for a complete list of possible selectors.
Execute Javascript Integer Executes a JavaScript snippet. Runs asynchronously when a timeout is set. Returns an Integer.
Execute Javascript String Executes a JavaScript snippet. Runs asynchronously when a timeout is set. Returns a String.
Execute Javascript WebElement Executes a JavaScript snippet. Runs asynchronously when a timeout is set. Returns a WebElement
Find/Assert Element Find/assert a web element using a host of selectio techniques. Optionally restrict search to the specified SearchContext element. Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).
Find/Assert Element by CSS Find/assert a web element by CSS. Optionally restrict search to the specified SearchContext element. Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).
Find/Assert Element by ID Find/assert a web element by ID. Optionally restrict search to the specified SearchContext element. Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).
Find/Assert Element by Sizzle Finds/asserts a web element by Sizzle. Optionally restrict search to the specified SearchContext element. Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).
Find/Assert Element by XPath Find/assert a web element by XPath. Optionally restrict search to the specified SearchContext element. Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).
Get Property Value Returns property value from web element. Does not have access to dojo widget properties.
Get Current Window Handle Returns the handle meaning, the identifier of the currently active window.
Get Selected Option Index Returns the index of the first selected option in a select element.
Get Selected Option Value Returns the value of the first selected option in a select element.
Get Selected Option Text Returns the text of the first selected option in a select element.
Get Text Get the visible, meaning, not hidden by CSS, innerText of this element, including sub-elements, without any leading or trailing whitespace.
Is Element Displayed Returns true if an element is displayed, meaning, visible.
Is Selected Check whether a check box is selected.
Maximize Maximizes the current browser window.
Switch to Window Switch to window via its identifier. An error is thrown if the window is not found.
Switch to Next Window Switch to the next open window. An error is thrown if there is only one window. Returns the window handle, meaning, identifier, of the new active window.
Set Page Load Timeout Sets the amount of time (in milliseconds) to wait for a page load to complete before throwing an error. If the timeout is negative, page loads can be indefinite.
Set Size Sets the size of the current browser window. This will change the outer window dimension, not just the view port.
Select Option By Index Select the option at the given index.
Select Option by Text Select all options that display text matching the argument.
Select Option by Value Select all options that have a value matching the argument.
Wait for Condition Repeatedly runs the condition java script snippet every interval (in milliseconds) until one of the following is fulfilled: * the snippet returns neither null nor false * the snippet throws an unignored exception * the timeout (in milliseconds) expires.
Wait for Condition JS Waits until the given expression returns true.
Unfocus WebElement Removes focus from a web element by calling the blur method.
Assert Element Attribute Equals Asserts that an attribute of the given element equals the specified value.
Assert Element matches Selector Mx4/Mx5 - Returns whether given element matches the selector.

Close Window

Function Key

CloseWindow

Description

Closes currently active window. Does not switch to another window automatically.

Input Parameters

None

Return value

None

Close Window & Auto-Switch

Function Key

CloseWindowAndAutoSwitch

Description

Closes the currently active window and automatically switches to the next one.

Input Parameters

None.

Return Value

String Identifier of active window

Element Matches Selector

Function Key

ElementMatchesSelector

Description

Returns whether the given element matches a selector for example, :contains(‘foo’) or :first-child.

Check out the reference guide for a complete list of possible selectors.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.
Selector Selector String Required CSS/jQuery selector

Return Value

Boolean

Execute Javascript Integer<

Function Key

ExecuteJavascriptInteger

Description

Executes a JavaScript snippet. Runs asynchronously when a timeout is set. Returns an Integer.

Input Parameters

Name Key Datatype Description
Script Script String Required
Timeout (ms) Timeout_ms Integer Optional
Argument 0 Argument0 Any Optional
Argument 1 Argument1 Any Optional
Argument 2 Argument2 Any Optional
Argument 3 Argument3 Any Optional

Return Value

Integer

Execute Javascript String

Function Key

ExecuteJavascriptString

Description

Executes a Javascript snippet. Runs asynchronously when a timeout is set. Returns a String.

Input Parameters

Name Key Datatype Description
Script Script String Required
Timeout (ms) Timeout_ms Integer Optional
Argument 0 Argument0 Any Optional
Argument 1 Argument1 Any Optional
Argument 2 Argument2 Any Optional
Argument 3 Argument3 Any Optional

Return Value

String

Execute Javascript WebElement

Function Key

ExecuteJavascriptWebElement

Description

Executes a JavaScript snippet. Runs asynchronously when a timeout is set. Returns a WebElement

Input Parameters

Name Key Datatype Description
Script Script String Required
Timeout (ms) Timeout_ms Integer Optional
Argument 0 Argument0 Any Optional
Argument 1 Argument1 Any Optional
Argument 2 Argument2 Any Optional
Argument 3 Argument3 Any Optional

Return Value

WebElement

Find/Assert Element

Function Key

FindElementNegetable

Description

Find/assert a web element using a host of selectio techniques. Optionally restrict search to the specified SearchContext element.
Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).

Input Parameters

Name Key Datatype Description
Find By FindBy String Required Possible values: ClassName, CssSelector, Id, LinkText, Name, PartialLinkText, TagName, XPath, Sizzle
Find Using FindUsing String Required
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Occurrence Occurrence Integer Optional Occurrence of the element on the page. 1 corresponds to the first element, 2 to the second elements etc. Negative number can also be used. -1 corresponds to the last element, -2 to the scond last, etc
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement Use one of the ‘Find element by X’ functions to get this object.

Find/Assert Element by CSS

Function Key

FindElementbyCSSNegetable

Description

Find/assert a web element by CSS. Optionally restrict search to the specified SearchContext element.

Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).

Input Parameters

Name Key Datatype Description
CSS Selector CSSSelector String Required Input the CSS Selector. for example, if you want to query by a class name, your selector would look like this: .classname
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Occurrence Occurrence Integer Optional Occurrence of the element on the page. 1 corresponds to the first element, 2 to the second elements etc. Negative number can also be used. -1 corresponds to the last element, -2 to the scond last, etc
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement Use one of the ‘Find element by X’ functions to get this object.

Find/Assert Element by ID

Function Key

FindElementbyIDNegetable

Description

Find/assert a web element by ID. Optionally restrict search to the specified SearchContext element.
Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).

Input Parameters

Name Key Datatype Description
ID ID String Required
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Occurrence Occurrence Integer Optional Occurrence of the element on the page. 1 corresponds to the first element, 2 to the second elements etc. Negative number can also be used. -1 corresponds to the last element, -2 to the scond last, etc
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement Use one of the ‘Find element by X’ functions to get this object.

Find/Assert Element by Sizzle

Function Key

FindElementBySizzleNegetable

Description

Finds/asserts a web element by Sizzle. Optionally restrict search to the specified SearchContext element.
Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).

Input Parameters

Name Key Datatype Description
Sizzle Selector SizzleSelector String Required Sizzle selector. ATS also supports these additional pseudo selectors: :containsExact() - match innerHTML of element with (case insensitive) :containsExactCase() - as :containsExact but case sensitive :containsRegex - match innerHTML with regular expression :containsText() - match onle plain text within the element :val() - match the value ($(element).val()) of element with , only input,textarea elements have a value other than the empty string.
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Occurrence Occurrence Integer Optional Occurrence of the element on the page. 1 corresponds to the first element, 2 to the second elements etc. Negative number can also be used. -1 corresponds to the last element, -2 to the scond last, etc
FilterSelector FilterSelector String Optional Acts as an additional selector to further specify which elements to query. Uses the same notation as sizzle selectors.
Timeout (ms) Timeout_ms) Integer Optional Timeout for implicit wait in milliseconds (defaults to 10 seconds if left empty)
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement Use one of the ‘Find element by X’ functions to get this object.

Find/Assert Element by XPath

Function Key

FindElementByXpathNegetable

Description

Find/assert a web element by XPath. Optionally restrict search to the specified SearchContext element.

Occurence lets you specify which element to fetch from the result-list, starting at 1 for the first element (defaults to the first element).

Input Parameters

Name Key Datatype Description
XPath XPath String Required Standard XPath syntax ‘//tagname[@attribute=‘value’]‘. Can be usefull to navigate up the DOM tree for example, ‘//*[text()=‘Special Value’]//ancestor::[contains(@class,‘mx-templategrid-row’)]’
Search Context SearchContext WebElement Optional Limits the search of the widget to this web element and its children. Can be used to dynamically restrict the search at runtime, for instance to a certain template grid item.
Occurrence Occurrence Integer Optional Occurrence of the element on the page. 1 corresponds to the first element, 2 to the second elements etc. Negative number can also be used. -1 corresponds to the last element, -2 to the scond last, etc
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

WebElement Use one of the ‘Find element by X’ functions to get this object.

Get Property Value

Function Key

GetPropertyValue

Description

Returns property value from web element.

Does not have access to dojo widget properties.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.
Attribute Name AttributeName String Required

Return Value

String The value to set.

Get Current Window Handle

Function Key

GetCurrentWindowHandle

Description

Returns the handle meaning, the identifier of the currently active window.

Input Parameters

None

Return Value

String identifier of active window

Get Selected Option Index

Function Key

GetSelectedOptionIndex

Description

Returns the index of the first selected option in a select element.

Input Parameters

Name Key Datatype Description
Select Element SelectElement WebElement Required

Return Value

Integer Starts from 0, meaning the first element has index 0, the second element has index 1 etc.

Get Selected Option Value

Function Key

GetSelectedOptionValue

Description

Returns the value of the first selected option in a select element.

Input Parameters

Name Key Datatype Description
Select Element SelectElement WebElement Required

Return Value

String

Get Selected Option Text

Function Key

GetSelectedOptionText

Description

Returns the text of the first selected option in a select element.

Input Parameters

Name Key Datatype Description
Select Element SelectElement WebElement Required

Return Value

String

Get Text

Function Key

GetText

Description

Get the visible, meaning, not hidden by CSS, innerText of this element, including sub-elements, without any leading or trailing whitespace.

Input Parameters

Name Key Datatype Description
Web Element WebElement WebElement Required

Return Value

String The value to set.

Is Element Displayed

Function Key

IsElementDisplayed

Description

Returns true if an element is displayed, meaning, visible.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.

Return Value

Boolean

Is Selected

Function Key

IsSelected

Description

Check whether a check box is selected.

Input Parameters

Name Key Datatype Description
Checkbox Checkbox WebElement Required The Checkbox element

Return Value

Boolean

Maximize

Function Key

Maximize

Description

Maximizes the current browser window.

Input Parameters

None.

Return value

None.

Switch to Window

Function Key

SwitchToWindow

Description

Switch to window via its identifier. An error is thrown if the window is not found.

Input Parameters

Name Key Datatype Description
Window Handle WindowHandle String Required Identifier of active window

Return Value

None.

Switch to Next Window

Function Key

SwitchToNextWindow

Description

Switch to the next open window. An error is thrown if there is only one window.

Returns the window handle, meaning, identifier, of the new active window.

Input Parameters

None.

Return Value

String identifier of active window

Set Page Load Timeout

Function Key

SetPageLoadTimeout

Description

Sets the amount of time (in milliseconds) to wait for a page load to complete before throwing an error.

If the timeout is negative, page loads can be indefinite.

Input Parameters

Name Key Datatype Description
Timeout (ms) Timeout_ms Integer Required

Return Value

None.

Set Size

Function Key

SetSize

Description

Sets the size of the current browser window.

This will change the outer window dimension, not just the view port.

Input Parameters

Name Key Datatype Description
Width Width Integer Required width of the browser window
Height Height Integer Required height of the browser window

Return Value

None.

Select Option By Index

Function Key

SelectOptionByIndex

Description

Select the option at the given index.

Input Parameters

Name Key Datatype Description
Index Index Integer Required Starts from 0, meaning the first element has index 0, the second element has index 1 etc.
Dropdown Dropdown WebElement Required Input the DropDown as Web Element.

Return Value

None.

Select Option by Text

Function Key

SelectOptionByText

Description

Select all options that display text matching the argument.

Input Parameters

Name Key Datatype Description
Selected Option Text SelectedOptionText String Required
Dropdown Dropdown WebElement Required Input the DropDown as Web Element.

Return Value

None.

Select Option by Value

Function Key

SelectOptionByValue

Description

Select all options that have a value matching the argument.

Input Parameters

Name Key Datatype Description
Selected Option Value SelectedOptionValue String Required
Dropdown Dropdown WebElement Required Input the DropDown as Web Element.

Return Value

None.

Wait for Condition

Function Key

WaitForCondition

Description

Repeatedly runs the condition java script snippet every interval (in milliseconds) until one of the following is fulfilled:

  • The snippet returns neither null nor false
  • The snippet throws an unignored exception
  • The timeout (in milliseconds) expires

Input Parameters

Name Key Datatype Description
Condition Condition String Required
Timeout (ms) Timeout_ms Integer Required
Polling Interval (ms) PollingInterval_ms Integer Required

Return Value

None.

Wait for Condition JS

Function Key

WaitForConditionJS

Description

Waits until the given expression returns true.

Input Parameters

Name Key Datatype Description
Condition Condition String Required
Timeout (ms) Timeout_ms Integer Required
Polling Interval (ms) PollingInterval_ms Integer Optional
Argument 0 Argument0 Any Optional
Argument 1 Argument1 Any Optional
Argument 2 Argument2 Any Optional

Return Value

None.

Unfocus WebElement

Function Key

UnfocusWebElement

Description

Removes focus from a web element by calling the blur method.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.

Return Value

None.

Assert Element Attribute Equals

Function Key

AssertElementAttributeEqualsNegetable

Description

Asserts that an attribute of the given element equals the specified value.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.
Attribute Attribute String Required
Value Value String Required Expected value.
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert Element matches Selector

Function Key

AssertElementMatchesSelectorNegetable

Description

Mx4/Mx5 - Returns whether given element matches the selector.

Input Parameters

Name Key Datatype Description
Assert Element AssertElement WebElement Required
Assert Selector AssertSelector String Required Selector for Assertion
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

MouseNKeyboard

Perform mouse clicks, scrolling and hover, as well as focus on web elements and emulate keystrokes.

Function Name Description
Hover Hover a web element.
Click Clicks in the middle of a given web element.
Click Coordinates Clicks on the given point on the page, described by X and Y Offset. If no reference element is given, the upper left corner of the page is used as point of origin for calculating the desired point. Otherwise the upper left corner of the reference element is used.
Send Enter Simulates pressing Enter in element, after waiting for any mendix activities to finish.“).
Send Keys Simulates typing Text into a web element, after waiting for any mendix activities to finish.
Doubleclick Performs a double-click on a web element.
Focus and Clear Element Value Sets an input element to an empty string, after waiting for mendix activities to finish.
Focus WebElement Focuses the web element and then waits for Mendix activities.
Click/Doubleclick Performs a click or double-click and waits for Mendix activities.
Accept Browser Alert Accepts the alert available.
Clear WebElement Clear a web element (input or text area).
Dismiss Browser Alert Dismisses the alert available.

Hover

Function Key

Hover

Description

Hover a web element.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.

Return Value

None.

Click

Function Key

Click

Description

Clicks in the middle of a given web element.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Web element to click.
Modifier Key Set ModifierKeySet String Optional Simulate that some buttons are depressed during the click. Possible values: ‘CONTROL’, ‘ALT’, ‘SHIFT’ and ‘META’. If multiple values are specified they need to be separated by a comma.

Return Value

None.

Click Coordinates

Function Key

ClickCoordinates

Description

Clicks on the given point on the page, described by X and Y Offset.

If no reference element is given, the upper left corner of the page is used as point of origin for calculating the desired point.

Otherwise the upper left corner of the reference element is used.

Input Parameters

Name Key Datatype Description
X Offset XOffset Integer Required The horizontal coordinate to move to, from the top left corner of either the page or the given reference element.
Y Offset YOffset Integer Required The vertical coordinate to move to, from the top left corner of either the page or the given reference element.
Reference Element ReferenceElement WebElement Optional If given, the reference element is used as point of origin for measuring the coordinates.

Return Value

None.

Send Enter

Function Key

SendEnter

Description

Simulates pressing Enter in element, after waiting for any mendix activities to finish.“).

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.

Return Value

None.

Send Keys

Function Key

SendKeys

Description

Simulates typing Text into a web element, after waiting for any mendix activities to finish.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.
Text Text String Required The text to type in.

Return Value

None.

Doubleclick

Function Key

Doubleclick

Description

Performs a double-click on a web element.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Web element to click.

Return Value

None.

Focus and Clear Element Value

Function Key

FocusAndClearElementValue

Description

Sets an input element to an empty string, after waiting for mendix activities to finish.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.

Return Value

None.

Focus WebElement

Function Key

FocusWebElement

Description

Focuses the web element and then waits for Mendix activities.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.

Return Value

None.

Click/Doubleclick

Function Key

ClickDoubleclick

Description

Performs a click or double-click and waits for Mendix activities.

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Web element to click.
Doubleclick Doubleclick Boolean Optional If true performs a doubleclick, otherwise does a single click. Defaults to false.

Return Value

None.

Accept Browser Alert

Function Key

AcceptBrowserAlert

Description

Accepts the alert available.

Input Parameters

None.

Return Value

None.

Clear WebElement

Function Key

ClearWebElement

Description

Clear a web element (input or text area).

Input Parameters

Name Key Datatype Description
Element Element WebElement Required Use one of the ‘Find element by X’ functions to get this object.

Return Value

None.

Dismiss Browser Alert

Function Key

DismissBrowserAlert

Description

Dismisses the alert available.

Input Parameters

None.

Return Value

None.

Logic

Logical expressions for asserting page elements, text and numbers. Also includes actions for text manipulation, explicit sleep and return.

Function Name Description
Assert all not null Fails if any of the objects is null.
Assert at least one not null Fails if all objects are null.
Assert Both not null Fails if one or both objects are null.
Assert Condition Fails This assert always fails when it is executed. However, if an attached condition fails, instead of failing it is just not executed. Use this function to assert that a conditional keyword fails.
Concatenate String Concatenate strings. Any number of the arguments can be null.
Is not Null Returns true if object is not null, false otherwise.
Assert containsString Asserts that the examined string ‘Subject’ (does not) contains the specified string ‘Matcher Parameter’ anywhere. For example, ‘testcasetool’ contains ‘case’.
Assert endsWith Asserts that Subject ends with string that is equal to Matcher Parameter. For example, ‘testcase’ ends with ‘case’.
Assert equalTo Asserts that the examined object ‘Object 1’ is logically equal to the specified operand ‘Object2’. Equality is determined by calling the Object.equals method on the examined object. Examples: 100 is equal to 100 or house is equal to house.
Assert equalToIgnoringCase Asserts that the examined string ‘Object 1’ is equal to the specified string ‘Object 2’, ignoring case. For example: ‘house’ is equal to ‘House’, ignoring case.
Assert equalToIgnoringWhiteSpace Asserts that the examined string ‘Object 1’ is equal to the specified string ‘Object 2’ after the following rules are applied: * all leading and trailing whitespaces of both string are removed. * any remaining whitespace, appearing within either string, is collapsed to a single space. For example: ‘ my\tfoo bar ‘ is equal to ’ my foo bar’, ignoring whitespace.
Assert greaterThan Asserts that the examined number ‘Object 1’ is greater than the specified number ‘Object 2’. For example: 2 is greater than 1.
Assert greaterThanOrEqualTo Asserts that the examined number ‘Object 1’ is greater than or equal to the specified number ‘Object 2’. For example: 1 is greater than or equal to 1.
Assert lessThan Asserts that the examined number ‘object 1’ is smaller than the specified number ‘object 2’. For example: 1 is smaller than 2.
Assert lessThanOrEqualTo Asserts that the examined number ‘object 1’ is smaller than or equal to the specified number ‘object 2’. For example: 1 is smaller than or equal to 1.
Assert startsWith Asserts that the examined string ‘Object 1’ starts with the specified string ‘Object 2’. For example: ‘testcase’ starts with ‘test’.
Assert XML equivalent Assert that two XMLs are equivalent.
Return First Valid Boolean Object Returns the first boolean from the parameter list which is not null.
Return First Valid Integer Object Returns the first integer from the parameter list which is not null.
Return First Valid String Returns the first string from the parameter list which is not null.
Return First Valid WebElement Returns the first webelement from the parameter list which is not null.
RegExp Match Return the n’th match of the given Regular Expression in the Search String. Uses JS string.match.
Set Return Value Use this function in custom actions to set the return value of the custom action. When using the ‘extract action’ feature this function call will be added automatically, where applicable.
Sleep Waits ‘sleep time’ milliseconds.

Assert All Not Null

Function Key

AssertAllNotNull

Description

Fails if any of the objects is null.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Optional
Object 2 Object2 Any Optional
Object 3 Object3 Any Optional

Return Value

None.

Assert at Least One Not Null

Function Key

AssertAtLeastOneNotNull

Description

Fails if all objects are null.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Optional
Object 2 Object2 Any Optional
Object 3 Object3 Any Optional

Return Value

None.

Assert Both not null

Function Key

AssertBothNotNull

Description

Fails if one or both objects are null.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Optional
Object 2 Object2 Any Optional

Return Value

None.

Assert Condition Fails

Function Key

AssertConditionFails

Description

This assert always fails when it is executed. However, if an attached condition fails, instead of failing it is just not executed.

Use this function to assert that a conditional keyword fails.

Input Parameters

None.

Return Value

None.

Concatenate String

Function Key

ConcatenateString

Description

Concatenate strings. Any number of the arguments can be null.

Input Parameters

Name Key Datatype Description
String 1 String1 String Optional
String 2 String2 String Optional
String 3 String3 String Optional
String 4 String4 String Optional
String 5 String5 String Optional

Return Value

String

Is Not Null

Function Key

IsNotNull

Description

Returns true if object is not null, false otherwise.

Input Parameters

Name Key Datatype Description
Object Object Any Optional

Return Value

Boolean

Assert containsString

Function Key

AssertContainsStringNegetable

Description

Asserts that the examined string ‘Subject’ (does not) contains the specified string ‘Matcher Parameter’ anywhere.

For example, ‘testcasetool’ contains ‘case’.

Input Parameters

Name Key Datatype Description
Subject Subject Any Required
Matcher Parameter MatcherParameter Any Required
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert endsWith

Function Key

AssertEndsWithNegetable

Description

Asserts that Subject ends with string that is equal to Matcher Parameter.

For example, ‘testcase’ ends with ‘case’.

Input Parameters

Name Key Datatype Description
Subject Subject Any Required
Matcher Parameter MatcherParameter Any Required
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert equalTo

Function Key

AssertEqualToNegetable

Description

Asserts that the examined object ‘Object 1’ is logically equal to the specified operand ‘Object2’.

Equality is determined by calling the Object.equals method on the examined object.

Examples: 100 is equal to 100 or house is equal to house.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Required
Object 2 Object2 Any Required
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert equalToIgnoringCase

Function Key

AssertEqualToIgnoringCaseNegetable

Description

Asserts that the examined string ‘Object 1’ is equal to the specified string ‘Object 2’, ignoring case.

For example: ‘house’ is equal to ‘House’, ignoring case.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Required
Object 2 Object2 Any Required
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert equalToIgnoringWhiteSpace

Function Key

AssertEqualToIgnoringWhiteSpaceNegetable

Description

Asserts that the examined string ‘Object 1’ is equal to the specified string ‘Object 2’ after the following rules are applied:

  • All leading and trailing whitespaces of both string are removed
  • Any remaining whitespace, appearing within either string, is collapsed to a single space; for example: ‘ my\tfoo bar ‘ is equal to ’ my foo bar’, ignoring whitespace

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Required
Object 2 Object2 Any Required
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert greaterThan

Function Key

AssertGreaterThan

Description

Asserts that the examined number ‘Object 1’ is greater than the specified number ‘Object 2’.

For example: 2 is greater than 1.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Required
Object 2 Object2 Any Required

Return Value

None.

Assert greaterThanOrEqualTo

Function Key

AssertGreaterThanOrEqualTo

Description

Asserts that the examined number ‘Object 1’ is greater than or equal to the specified number ‘Object 2’.

For example: 1 is greater than or equal to 1.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Required
Object 2 Object2 Any Required

Return Value

None.

Assert lessThan

Function Key

AssertLessThan

Description

Asserts that the examined number ‘object 1’ is smaller than the specified number ‘object 2’.

For example: 1 is smaller than 2.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Required
Object 2 Object2 Any Required

Return Value

None.

Assert lessThanOrEqualTo

Function Key

AssertLessThanOrEqualTo

Description

Asserts that the examined number ‘object 1’ is smaller than or equal to the specified number ‘object 2’.

For example: 1 is smaller than or equal to 1.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Required
Object 2 Object2 Any Required

Return Value

None.

Assert startsWith

Function Key

AssertStartsWithNegetable

Description

Asserts that the examined string ‘Object 1’ starts with the specified string ‘Object 2’.

For example: ‘testcase’ starts with ‘test’.

Input Parameters

Name Key Datatype Description
Object 1 Object1 Any Required
Object 2 Object2 Any Required
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Assert XML equivalent

Function Key

AssertXMLEquivalentNegetable

Description

Assert that two XMLs are equivalent.

Input Parameters

Name Key Datatype Description
XML 1 XML1 String Required
XML 2 XML2 String Required
Identifier Identifier String Required
Negate NegateParameter Boolean Required Negetes the asssert

Return Value

None.

Return First Valid Boolean Object

Function Key

ReturnFirstValidBoolean

Description

Returns the first Boolean from the parameter list which is not null.

Input Parameters

Name Key Datatype Description
Boolean 1 Boolean1 Boolean Optional
Boolean 2 Boolean2 Boolean Optional
Boolean 3 Boolean3 Boolean Optional
Boolean 4 Boolean4 Boolean Optional
Boolean 5 Boolean5 Boolean Optional

Return Value

Boolean

Return First Valid Integer Object

Function Key

ReturnFirstValidInteger

Description

Returns the first integer from the parameter list which is not null.

Input Parameters

Name Key Datatype Description
Integer 1 Integer1 Integer Optional
Integer 2 Integer2 Integer Optional
Integer 3 Integer3 Integer Optional
Integer 4 Integer4 Integer Optional
Integer 5 Integer5 Integer Optional

Return Value

Integer

Return First Valid String

Function Key

ReturnFirstValidString

Description

Returns the first string from the parameter list which is not null.

Input Parameters

Name Key Datatype Description
String 1 String1 String Optional
String 2 String2 String Optional
String 3 String3 String Optional
String 4 String4 String Optional
String 5 String5 String Optional

Return Value

String

Return First Valid WebElement

Function Key

ReturnFirstValidWebElement

Description

Returns the first webelement from the parameter list which is not null.

Input Parameters

Name Key Datatype Description
Web Element 1 WebElement1 WebElement Optional
Web Element 2 WebElement2 WebElement Optional
Web Element 3 WebElement3 WebElement Optional
Web Element 4 WebElement4 WebElement Optional
Web Element 5 WebElement5 WebElement Optional

Return Value

WebElement

RegExp Match

Function Key

RegExpMatch

Description

Return the n’th match of the given Regular Expression in the Search String.

Uses JS string.match.

Input Parameters

Name Key Datatype Description
Search String SearchString String Required
Regular Expression RegularExpression String Required
Modifier Modifier String Optional
Match Index MatchIndex Integer Optional

Return Value

String

Set Return Value

Function Key

SetReturnValue

Description

Use this function in custom actions to set the return value of the custom action.

When using the ‘extract action’ feature this function call will be added automatically, where applicable.

Input Parameters

Name Key Datatype Description
Value Value Any Required Value to be set as return value

Return Value

None.

Sleep

Function Key

Sleep

Description

Waits ‘sleep time’ milliseconds.

Input Parameters
Name Key Datatype Description
Sleep time (ms) SleepTimeMS Integer Required

Return Value

None.

Generators

Generate random numbers, UUIDs or pieces of text; or get the current date time.

Function Name Description
Generate GUID Generates and returns a globally unique identifier.
Random Number Creates a random integer using: Math.floor(Math.random() * (max - min)) + min; You need to define the min (included) and max (excluded).
Random String Creates a random aphanumerical string using: Math.random().toString(36).slice(2,8) Optionally allows to add a prefix or postfix.
Get Current DateTime String Returns the current server date and time UTC in supplied format. The formating language is based on the java date format. An example of a correct format: ‘yyyy-MM-dd HH:mm:ss’.

Generate GUID

Function Key

GenerateGUID

Description

Generates and returns a globally unique identifier.

Input Parameters

None.

Return Value

String GUID

Random Number

Function Key

RandomNumber

Description

Creates a random integer using Math.floor(Math.random() * (max - min)) + min.

You need to define the min (included) and max (excluded).

Input Parameters

Name Key Datatype Description
Min Min Integer Required Lowest possible value for the generated number, inclusive.
Max Max Integer Required Highest possible value for the generated number, exclusive.

Return Value

Integer A whole number.

Random String

Function Key

RandomString

Description

Creates a random aphanumerical string using Math.random().toString(36).slice(2,8). Optionally allows to add a prefix or postfix.

Input Parameters

Name Key Datatype Description
Prefix Prefix String Optional
Postfix Postfix String Optional
Length Length Integer Optional

Return Value

String The text to type in.

Get Current DateTime String

Function Key

GetCurrentDateTimeString

Description

Returns the current server date and time UTC in supplied format.

The formating language is based on the java date format.

An example of a correct format: ‘yyyy-MM-dd HH:mm:ss’.

Input Parameters

Name Key Datatype Description
Date Format DateFormat String Required Based on the SimpleDateFormat by java. Check the official javadocs for details. If left empty, a default pattern is used.

Return Value

String