Custom

  1. Custom Object can be used in the following scenarios:

    • Objects which are dynamic in the AUT (either position/visible text changes during execution).

    • If object-specific keywords are not supported for the operations.

  2. The Custom object does not require scraping. These keywords can be used for all valid HTML tags (Textbox, Button, Link, Image, Div, Span..), User should provide the appropriate tag name in the input: "Object Type_Input".

  3. The "verifyExists" step is required before using @custom functionality. (This indicates the starting point for execution of custom keywords until it encounters the next verifyExists keyword).

Input Syntax: <Object Type_Input>; <Visible Text>; <index>

Note:

  1. If visible text is unique then the index should be 0 (default index). (For example: link;Click Next;0) This performs an action on the link that has unique visible text "Click Next".

  2. In AUT, if multiple matches are present for the visible text or if the visible text is not given in the input, then the user should provide index numbers appropriately.

    • Ex 1: link;Next;2- This performs action on the 3rd link from the reference object that has visible text "Next".

    • Ex 2: link;;2- This performs action on the 3rd link from the reference object.

Input Syntax Table

S.No.

Object Type

Object Type_Input

Visible Text

1

Radiobutton

radio;; <index>

Empty

2

Checkbox

checkbox;; <index>

Empty

3

Dropdown

dropdown; <visibleText>; <index>

Should be the value selected in the dropdown by default/empty. Note: All single selection objects come under dropdown

4

Listbox

listbox; <visibleText>; <index>

Should be the value selected in the list by default/empty. Note: All single selection objects come under list.

5

Table

table;; <index>

Optional

6

Textbox/search, email, password, number, file, textarea

textbox; <visibleText>; <index>

Optional

7

Button, submit, reset

button; <visibleText>; <index>

button name

8

Valid html tags (Eg: span, div)

<tag>; <visibleText>; <index>

Optional

Keyword: CLICKELEMENT

Description: This keyword or action instructs ICE to perform a “click” action on the object as specified in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

ClickElement

<Object Type_Input>; <Visible text>; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, Click operation will be performed on the element and the execution status “True”/ “False” will be stored in variable {Click}.

Keyword: DOUBLECLICK

Description: This keyword or action instructs ICE to perform a “doubleClick” action on the object as specified in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

doubleClick

<Object Type_Input>; <Visible text>; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, DoubleClick operation will be performed on the button and the execution status “True”/ “False” will be stored in variable {DoubleClick}.

Keyword: GETELEMENTTEXT

Description: This keyword or action instructs ICE to fetch the text of the element and save the result in the output variable.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

GetElementText

<Object Type_Input>; <Visible text>; <index>

{Variable}

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the operation will fetch the element text and store it in variable {ElementText} and the execution status “True”/ “False” will be stored in variable {Status}.

Keyword: GETSTATUS

Description: This keyword or action instructs ICE to fetch the status of the object and save the result in the output variable.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

GetStatus

<Object Type_Input>; <Visible text>; <index>

{Variable}

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the operation will fetch the checkbox status and store it in variable {GetStatus}.

Keyword: GETTEXT

Description: This keyword or action instructs ICE to perform the “GetText” operation on the object and save the result in the output variable.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

GetText

<Object Type_Input>; <Visible text>; <index>

{Variable}

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the text of the textbox will be fetched and stored in variable {GetText} and the execution status “True”/ “False” will be stored in variable {status}.

Keyword: SELECTRADIOBUTTON

Description: This keyword or action instructs ICE to “select” the object specified in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

SelectRadioButton

<Object Type_Input>;; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the operation will select the Radiobutton and the execution status “Fail”/ “Pass” will be stored in variable {Select}.

Keyword: SELECTVALUEBYINDEX

Description: This keyword or action instructs ICE to select the object based on index value specified in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

SelectValueByIndex

<Object Type_Input>; <Visible text>; <index>; <keyword Input>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Note: Only numerical values are allowed in the input. The index starts with “0” which will be the first value from the dropdown/list.

Find the snippet of the keyword below:

In the above example, after the test case debug, the provided index value will be selected and the execution status “True”/ “False” will be stored in variable {SelectValIndex}.

Keyword: SELECTVALUEBYTEXT

Description: This keyword or action instructs ICE to select the value from the dropdown based on the text provided in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

SelectValueByText

<Object Type_Input>; <Visible text>; <index>; <keyword Input>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the provided value will be selected and the execution status “True”/ “False” will be stored in variable {SelectValText}.

Keyword: SETFOCUS

Description: This keyword or action instructs ICE to set the focus on the element/object specified in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

SetFocus

<Object Type_Input>; <Visible text>; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the provided object will be focused and the execution status “True”/ “False” will be stored in variable {SetFocus}.

Keyword: SETTEXT

Description: This keyword or action instructs ICE to set the text/string on the object specified in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

SetText

<Object Type_Input>; <Visible text>; <index>; <keyword input>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the operation will set the provided text and the execution status “Fail”/ “Pass” will be stored in variable {SetText}.

Keyword: SETSECURETEXT

Description: This keyword or action instructs ICE to accept and encrypted text and pass the decrypted value into the application.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

SetSecureText

<Object Type_Input>; <Visible text>; <index>; <Encrypted Text>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the decrypted text will be printed and the execution status “Fail”/ “Pass” will be stored in variable {SetSecuretext}.

Keyword: UNSELECTCHECKBOX

Description: This keyword or action instructs ICE to “unselect” the object specified in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

UnselectCheckbox

<Object Type_Input>;; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the operation will unselect the checkbox provided and the execution status “True”/ “False” will be stored in variable {UnselectChkbx}.

Keyword: SELECTCHECKBOX

Description: This keyword or action instructs ICE to select the object specified in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

SelectCheckbox

<Object Type_Input>;; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the operation will select the checkbox provided and the execution status “True”/ “False” will be stored in variable {SelectChkBx}.

Keyword: VERIFYELEMENTTEXT

Description: This keyword or action instructs ICE to verify if the element text is the same as that given in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

VerifyElementText

<Object Type_Input>; <Visible text>; <index>; <keyword input>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the operation will verify the input text and the execution status “Fail”/ “Pass” will be stored in variable {VerifyElmntTxt}.

Keyword: VERIFYEXISTS

Description: This keyword or action instructs ICE to verify if the object is present in the AUT screen.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

VerifyExists

<Object Type_Input>; <Visible text>; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, it verifies if the object is present in AUT screen and the execution status “True”/ “False” will be stored in variable {VerifyExist}.

Keyword: MOUSEHOVER

Description: This keyword or action instructs ICE to place a “Mouse pointer” on the object specified in the input.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

MouseHover

<Object Type_Input>; <Visible text>; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the operation will place the mouse pointer on the object specified in the input and the execution status “True”/ “False” will be stored in variable {MouseHover}.

Keyword: VERIFYHIDDEN

Description: This keyword or action instructs ICE to verify if the object is hidden in the AUT screen.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

VerifyHidden

<Object Type_Input>; <Visible text>; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, it verifies if the object is hidden on the AUT screen and the execution status “True”/ “False” will be stored in variable {VerifyHidden}.

Keyword: VERIFYVISIBLE

Description: This keyword or action instructs ICE to verify if the object is visible in the AUT screen.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

VerifyVisible

<Object Type_Input>; <Visible text>; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, it verifies if the object is visible on the AUT screen and the execution status “True”/ “False” will be stored in variable {VerifyVisible}.

Keyword: GETALLVALUES

Description: This keyword or action instructs ICE to get all the values that are present in the dropdown/list.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

getAllValues

<Object Type_Input>; <Visible text>; <index>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, it gets all the values present in the element and the result is stored in variable {GetAllValues}.

Keyword: VERIFYALLVALUES

Description: This keyword or action instructs ICE to verify if all of the input values provided by the user are present in the dropdown/list.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

VerifyAllValues

<Object Type_Input>; <Visible text>; <index>; <Input Text>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, it verifies if all the values are present in the element and the execution status “Fail”/ “Pass” is stored in variable {VerifyAllValues}.

Keyword: SELECTTREENODE

Description: This keyword or action instructs ICE to select the node in a tree

Keyword

Input Syntax

Output Syntax

Supported Input Formats

SelectTreeNode

<Object Type_Input>; <Visible text>; <index>; <Node path>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, the operation will select the node and the result is stored in variable {SelectTreeNode}.

Keyword: GETNODENAMEBYINDEX

Description: This keyword or action instructs ICE to fetch the node name for values provided by the user are present in the dropdown/list.

Keyword

Input Syntax

Output Syntax

Supported Input Formats

GetNodeNameByIndex

<Object Type_Input>; <Visible text>; <index>; <Node Path (index)>

(Optional)

  • Text

  • Static Values

  • Dynamic Variables

Find the snippet of the keyword below:

In the above example, after the test case debug, it fetches the node name and stores it in {GetNodeNameByIndex} and the execution status “Fail”/ “Pass” is stored in variable {Status}.

Keyword: SENDSECUREFUNCTIONKEYS

Description: This keyword or action instructs ICE to accept an encrypted text and send the individual keystrokes to the application’s element specified in the input.

Following is the syntax for performing the operation on a custom object:

Keyword

Input Syntax

Output Syntax

Supported Input Formats

sendSecureFunctionKeys

<Object Type_Input>; <Visible text>; <index>; <Encrypted Text>

(Optional)

  • Text

  • Static values

  • Dynamic Variables

Note:

In order to provide encrypted text as input to the sendSecureFunctionKeys keyword, the user should encrypt the required text using “AES Encryption” from the tool encryption utilities.

Find the snippet of the keyword below, with input specified directly:

In the above example, after the test case debug, the decrypted text will be entered in the custom object specified in the input and the execution status “Fail”/ “Pass” will be stored in variable {output}.

PreviousTreeNextCommon_Desktop

Last updated

Logo