Finding the Action You Need

Last modified: November 19, 2024

Introduction

This document explains the best way to find the action you need in ATS. This is done by using six main categories for what you are trying to achieve. Each category explains the generic solution and the widget specific solutions using examples. These are the categories:

  • Finding a widget
  • Clicking a widget
  • Covering an input widget
  • Retrieving a value from a widget
  • Asserting values/information
  • Generating values/information

Select the category that covers your situation. If you are not sure, use the widget name to search for an action inside ATS and take a look at what pops up.

For a quick summary and action plan, go straight to section 8 Summary.

Finding a Widget

In ATS there are many actions for finding a widget, from generically finding a widget to finding a specific data grid row. The first part of this section explains the generic action for finding a widget, and the second part explains the actions that conduct a more specific search. The last part of the section provides a summary of the first two parts. The magic word while searching for an action that can find something is “Find.”

Generic Action

When you want to find a widget, the main choice is always the Find/Assert Widget action. It finds the widget you need using the mx-name of the widget.

ATS uses the widget name parameter instead of mx-name. The widget name is found using the ATS Helper, and the value is the widget name:

The Find/Assert Widget action works on every widget that has a mx-name.

This is the Find/Assert Widget action:

If the generic action does not work, check if there is a specific one.

Specific Action

When you are looking for a specific widget or content of that widget, use the widget name in the search.

Example 1

In this example, you want to find a row inside a data grid widget. You can use the Find/Assert Widget action in combination with the column name, but that doesn’t work if there are multiple data grids.

The solution in this situation is to use the following search term: “Find Datagrid”. ATS checks all the actions and returns those that match these words. There is an action called Find/Assert DataGrid Row, which enables searching for a data grid row containing a specific value in a specific column. This action also works on list views and template grids.

Example 2

In this example, you want to find the checkbox in a simple checkbox set selector widget. You cannot use the Find/Assert Widget action here, because the checkbox does not have its own mx-name. It is part of the simple checkbox set selector widget.

The solution in this situation is to use the following search term: “Find Simple Checkbox Set Selector”. ATS checks all the actions and returns those that match these words. There is an action called Find Simple Checkbox Set Selector, which finds the checkbox based on the widget name of the entire widget and the value displayed by the checkbox.

Example 3

In this example, you want to find a dialog box based on the title or text inside. You cannot use the Find/Assert Widget action, because the dialog box does not have a mx-name.

The solution in this situation is to use the following search term: “Find Dialog”. ATS checks all the actions and returns those that match these words. There is an action called Find/Assert Dialog, which can find a dialog based on title, text, or only a dialog.

Summary

When you want to find a widget, always use the Find/Assert Widget action if possible.

If you want to find something more specific inside a widget or the widget does not have an mx-name, use “Find” in combination with the widget name as displayed in the Mendix Marketplace and Mendix Studio Pro. You can also find the name using the ATS Helper.

If you cannot find a widget because it has no unique name or because it is not supported, see How to Create Custom Actions for more information.

Clicking a Widget

In ATS, there are many actions for clicking a widget, from generically clicking a widget to clicking a specific data grid row. The first part of this section explains the generic action for clicking a widget, and the second part explains the actions that conduct a more specific click. The last part of the section provides a summary of the first two parts. The magic word while searching for an action that can click something is “Click.”

Generic Action

When you want to click a widget, the main choice is always the Click Widget action. It clicks the widget you need using the mx-name of the widget.

ATS uses the widget name parameter instead of mx-name. The widget name is found using the ATS Helper, and the value is the widget name:

The Click Widget action works on every widget that has a mx-name.

This is the Click Widget action:

If the generic action does not work, check if there is a specific one.

Specific Action

ATS also has a few specific click actions. To find these, use the search term “Click” in combination with the widget name.

Example 1

In this example, you want to click the Load more button inside a list view widget. You cannot use the Click Widget action, because the button does not have its own mx-name. It is part of the list view widget.

The solution in this situation is to use one of the following search terms: “Click Widget Button” because you want to click a button that is part of a widget. ATS checks all the actions and returns those that match these words. There is an action called Click Widget Button, which uses the mx-name of the widget and the button type to click the right button. In this case, select the “load more” type.

Example 2

In this example, you want to click a specific data grid row inside a data grid. You can use the Click Widget action in combination with the column name, but if there are multiple data grids, ATS cannot distinguish them.

The solution in this situation is to use the following search term: “Click DataGrid”. ATS checks all the actions and returns those that match these words. There is an action called Click DataGrid Row, which enables you to click a data grid row containing a specific value in a specific column. This action also works on list views and template grids.

Example 3

In this example, you want to click a menu item in a menu bar widget. You cannot use the Click Widget action, because the menu item does not have its own mx-name. It is part of the menu bar widget.

The solution in this situation is to use the following search term: “Click menu”. ATS checks all the actions and returns those that match these words. There is an action called Click Menu Item, which clicks on a menu item inside a menu bar widget using the caption.

Example 4

In this example, you want to click an element you found in a previous step. You cannot use the Click Widget action, because it does not accept an element as input.

The solution in this situation is to use the following search term: “Click/Doubleclick”. ATS checks all the actions and returns those that match these words. You see there is an action called Click/Doubleclick, which you should use when you want to click an element found in a previous step.

Summary

When you want to click a widget, always use the Click Widget action if possible.

If you want to click something more specific inside a widget or the widget does not have an mx-name, use “Click” in combination with the widget name as displayed in the Mendix Marketplace and Mendix Studio Pro. You can also find the name using the ATS Helper.

If you cannot click a widget because it has no unique name or because it is not supported, see How to Create Custom Actions for more information.

Setting an Input Widget

In ATS, there are several actions for setting an input widget, from a simple action that covers most situations to checkboxes inside tables. The first part of this section explains the generic action for setting an input widget, and the second part explains the actions that set a more specific input widget. The last part of the section provides a summary of the first two parts. The magic word while searching for an action that can handle an input widget is “Set.”

Generic Action

When you want to set an input widget, the main choice is always the Set Value action. It sets the input widget using the mx-name of the widget and the value to set.

ATS uses the widget name parameter instead of mx-name. The widget name is found using the ATS Helper, and the value is the widget name:

The Set Value action works on almost every widget that is an input widget.

This is the Set Value action:

If the generic action does not work, check if there is a specific one.

Specific Action

ATS also has a few specific actions for setting an input widget. To find these, use the search term “Set” in combination with the widget name.

Example 1

In this example, you want to set the value of a checkbox widget, but you want to set it to a specific state. You cannot use the Set Value action because it does not work.

The solution in this situation is to use the following search term: “Set Checkbox”. ATS checks all the actions and returns those that match these words. There is an action called Set Checkbox Value, which uses the mx-name of the widget and the Boolean value you set to check or clear the checkbox.

Example 2

In this example, you want to set the BooleanSlider widget to certain value. You cannot use the Set Value action because it does not work.

The solution in this situation is to use the following search term: “Set BooleanSlider”. ATS checks all the actions and returns those that match these words. There is an action called Set BooleanSlider Value, which uses the mx-name of the widget and the value to which you want to set the slider.

Example 3

In this example, you want to set a radio button inside a GridSelector widget. You cannot use the Set Value, because the radio button does not have its own mx-name. It is part of the GridSelector widget.

The solution in this situation is to use the following search term: “Set Grid Selector”. ATS checks all the actions and returns those that match these words. There is an action called Set Grid Selector Value, which uses the mx-name of the widget, column caption, and row caption to locate the radio button.

Example 4

In this example, you want to set an input reference selector widget. You cannot use the Set Value action because it does not work.

The solution in this situation is to use the following search term: “Set InputReferenceSelector”. ATS checks all the actions and returns those that match these words. There is an action called Set InputReferenceSelector Value, which uses the mx-name and the value to which you set the InputReferenceSelector widget.

Summary

When you want to set an input widget, always use the Set Value action if possible.

If you want to set a special input widget or the widget does not have an mx-name, use “Click” in combination with the widget name as displayed in the Mendix Marketplace and Mendix Studio Pro. You can also find the name using the ATS Helper.

If you cannot set an input widget because it has no unique name or because it is not supported, see How to Create Custom Actions for more information.

Retrieving a Value from a Widget

In ATS, there are several actions for getting a value from a widget. The first part of this section explains the generic action for getting a value from a widget, and the second part explains the actions that get a specific value from a widget. The last part of the section provides a summary of the first two parts. The magic word while searching for an action that can get a value is “Get.”

Generic Action

When you want to get a value from a widget, the main choice is always the Get Value action. It retrieves the value of a widget using the mx-name of the widget.

ATS uses the widget name parameter instead of mx-name. The widget name is found using the ATS Helper, and the value is the widget name:

The Get Value action works on almost every widget that is an input widget.

This is the Get Value action:

If the generic action does not work, check if there is a specific one.

Specific Action

ATS has a few specific actions for getting a value from an widget. To find these, use the search term “Get” in combination with the widget name.

Example 1

In this example, you want to get the value of an InputReferenceSelector widget. You cannot use the Get Value action, because it does not work.

The solution in this situation is to use the following search term: “Get InputReferenceSelector”. ATS checks all the actions and returns those that match these words. There is an action called Get InputReferenceSelector, which returns the value the InputReferenceSelector widget is set to using the mx-name.

Example 2

In this example, you want to get the value displayed in the CKEditor widget. You cannot use the Get Value action because it does not work.

The solution in this situation is to use the following search term: “Get CKEditor”. ATS checks all the actions and returns those that match these words. There is an action called Get CKEditor Value, which uses the mx-name to return the value displayed in the CKEditor widget.

Example 3

In this example, you want to get the message displayed in the dialog box widget. You cannot use the Get Value action because there is no mx-name.

The solution in this situation is to use the following search term: “Get Dialog”. ATS checks all the actions and returns those that match these words. There is an action called Get Dialog Message Text, which uses the dialog as a WebElement to retrieve the message text. You use the Find/Assert Dialog action to get the dialog as a WebElement.

Summary

When you want to get a value from a widget, always use the Get Value action if possible.

If you want to get the value from a specific widget or the widget does not have an mx-name, use “Get” in combination with the widget name as displayed in the Mendix Marketplace and Mendix Studio Pro. You can also find the name using the ATS Helper.

If you cannot get the value from a widget because it has no unique name or because it is not supported, see How to Create Custom Actions for more information.

Asserting Values/Information

In ATS, there are several actions for asserting values. The first part of this section explains the generic action for asserting a value inside your app, and the second part explains the actions that assert specific values inside your app or inside ATS. The last part of the section provides a summary of the first two parts. The magic word while searching for an action that can assert a value is “Assert.”

Generic Action

When you want to assert a value inside a widget, the main choice is always the Assert Value action. It asserts the value of a widget using the mx-name of the widget.

ATS uses the widget name parameter instead of mx-name. The widget name is found using the ATS Helper, and the value is the widget name:

The Assert Value action works on almost every widget that is an input widget.

This is the Assert Value action:

If the generic action does not work, check if there is a specific one.

Specific Action

ATS has a few specific actions for asserting values in a widget or inside ATS. To find these, use the search term “Assert” in combination with the name of the widget or in combination with what you want to assert.

Example 1

In this example, you want to assert that a specific validation message appears. You cannot use the Assert Value action, because that would assert the value inside the widget and not the validation message.

The solution in this situation is to use the following search term: “Assert Validation”. ATS checks all the actions and returns those that match these words. There is an action called Assert Validation Message, which uses the mx-name of a widget to assert the validation message that appears in the widget.

Example 2

In this example, you want to assert that the right page has opened. You cannot use the Assert Value, because there is no mx-name that you can use.

The solution in this situation is to use the following search term: “Assert Page”. ATS checks all the actions and returns those that match these words. There is an action called Assert Current Page, which uses the page title to assert that the right page has opened.

Example 3

The above examples show actions meant to assert something in your Mendix app. ATS also has actions that assert internal outcomes/values.

In this example, you want to assert that the outcome of an earlier test step is not the same as a certain value. You cannot use the Assert Value action, because you want to assert a value inside ATS.

The solution in this situation is to use the following search term: “Assert not equal”. ATS checks all the actions and returns those that match these words. There is an action called Assert Not Equals, which compares two provided values and checks if they are equal or not.

Summary

When you want to assert a value from a widget always use the Assert Value action if possible.

If you want to assert a value from a specific widget or the widget does not have a mx-name. Then use “Assert” in combination with the widget name as displayed in the Mendix Marketplace, Mendix Studio Pro. You can also find the name using the ATS Helper.

In case you cannot assert the value from a widget due to no unique name or because it is not supported, go to How to Create Custom Actions.

Generating Values/Information

In ATS, there are several actions for generating random or present time values. The first part of this section explains a generic action that makes a reusable string, and the second part explains the actions that perform more specific tasks. The last part of the section provides a summary of the first two parts. In this case, there is no magic word to find the actions you need.

Generic Action

In some test cases, you want to enter the same value a few times. Instead of entering the same value every time, you can use the Concatenate String action, which combines the text you enter and returns it so that you can reuse that value in different actions.

It is also used for creating variable selectors.

This is the Concatenate String action:

Specific Action

ATS also has a few specific actions for generating values to use in your test case. The search terms used to find these are “Random” and “Current.”

Example 1

In this example, you want to have a unique value in your test case. That also makes your test case reusable.

The solution in this situation is to use the following search term: “Random”. ATS checks all the actions and returns those that match this word. There is an action called Random String, which generates a random value and allows you to set a prefix and/or postfix.

Example 2

In this example, you want to have a unique number value in your test case. That also makes your test case reusable.

The solution in this situation is to use the following search term: “Random”. ATS checks all the actions and returns those that match this word. There is an action called Random Number, which generates a random number and allows you to set a minimum and maximum.

Example 3

In this example, you want to use today’s date in your test case. This makes your test case reusable, but you don’t want to enter it every time you execute the test case.

The solution in this situation is to use the following search term: “Current Date”. ATS checks all the actions and returns those that match these words. There is an action called Get Current DateTime String, which retrieves the current date and allows you to set the date format.

Summary

For generating values or information, you should follow the first two parts of this section. There is no generic solution regarding this, only a constant provider like the Concatenate String action.

Summary

It all comes down to following these steps to achieve the right result

  1. Use the ATS Recorder. If the ATS Recorder does not work, go to step 2 below.

  2. If the ATS Recorder does not work, that does not also mean that ATS cannot interact with the widget. Select the action that goes with the task you want to perform:

    Task Action
    Finding a widget Find/Assert Widget action
    Clicking a widget Click Widget action
    Cover an input widget Set Value action
    Retrieving a value from a widget Get Value action
    Asserting values/information Assert Value action
    Generating values/information See 6 Generating Values/Information for more information

    If these do not work because you do not have an mx-name or they don’t cover the task, go to step 3 below.

  3. If your task is not covered by the generic action, use the following search terms depending on your task:

    Task Search Term
    Finding a widget “Find” in combination with the name of the widget
    Clicking a widget “Click” in combination with the name of the widget
    Cover an input widget “Set” in combination with the name of the widget
    Retrieving a value from a widget “Get” in combination with the name of the widget
    Asserting values/information “Assert” in combination with the name of the widget
    Generating values/information See 6 Generating Values/Information for more information

    If you are certain that ATS does not support your task, go to step 4 below.

  4. If ATS does not support your task with a standard solution, you must create your own solution. For more information, see How to Create Custom Actions.