Note: You are looking at a static snapshot of documentation related to Robot Framework automations. The most recent documentation is at https://robocorp.com/docs

Dialogs

Pauses execution until user sets the keyword status.

Arguments

ArgumentTypeDefault value
messagenull
default_error

User can press either PASS or FAIL button. In the latter case execution fails and an additional dialog is opened for defining the error message.

message is the instruction shown in the initial dialog and default_error is the default value shown in the possible error message dialog.

Pauses execution and asks user to select a value.

Arguments

ArgumentTypeDefault value
messagenull
valuesnull

The selected value is returned. Pressing Cancel fails the keyword.

message is the instruction shown in the dialog and values are the options given to the user.

Usage

${user} =Get Selection From UserSelect useruser1user2admin

Pauses execution and asks user to select multiple values.

Arguments

ArgumentTypeDefault value
messagenull
valuesnull

The selected values are returned as a list. Selecting no values is OK and in that case the returned list is empty. Pressing Cancel fails the keyword.

message is the instruction shown in the dialog and values are the options given to the user.

Usage

${users} =Get Selections From UserSelect usersuser1user2admin

Pauses execution and asks user to input a value.

Arguments

ArgumentTypeDefault value
messagenull
default_value
hiddenFalse

Value typed by the user, or the possible default value, is returned. Returning an empty value is fine, but pressing Cancel fails the keyword.

message is the instruction shown in the dialog and default_value is the possible default value shown in the input field.

If hidden is given a true value, the value typed by the user is hidden. hidden is considered true if it is a non-empty string not equal to false, none or no, case-insensitively. If it is not a string, its truth value is got directly using same rules as in Python.

Usage

${username} =Get Value From UserInput user namedefault
${password} =Get Value From UserInput passwordhidden=yes

Pauses execution until user clicks Ok button.

Arguments

ArgumentTypeDefault value
messageExecution paused. Press OK to continue.

message is the message shown in the dialog.