Actions - CognizantOpenSource/Cognizant-Intelligent-Test-Scripter GitHub Wiki

• Web Actions
• WebService Actions
• Mobile Actions
• WebPage Performance Actions
• Accessibility Testing
• Database Validation
• Image
• Layout Validation

• Set

Description: This function is used to enter data in an object.

Input Format : @Expected Text

Example:

Inputs in the Input column can be either hardcoded (in this case the data is preceded by a "@"), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• Click

Description: This function is used to perform click operation on an object.

Example:

• rightClick

Description: This function is used to perform right click operation on an object or in the browser.

Example:

• SubmitIfExists

Description: This function will check if an object exists. If the object exists, it will submit else it will ignore that step.

Example:

• RestartBrowser

Description: This function is used to restart browser.

Example:

• changeWaitTime

Description: This function is used to change the default wait time(Default 10 sec). .The default wait time for all the wait actions defined after changeWaitTime action will be the same as defined in the changeWaitTime action.

Input Format : @Time in seconds

Example:

• setElementTimeOut

Description: This function is used to change the default timeout for Cognizant Intelligent Test Scripter's Object finding logic.(Default 10 second). The same action needs to be called with the default time (10 sec) as parameter when there is a need to switch to the default time for the succeeding steps.

Input Format : @Time in seconds

Example:

• setBrowserSize

Description: This function will Set the browser size

Input Format : In pixels for example @700x800 or @700,800 or @700 800

Example:

• clickIfExists

Description: This function will check if an element exists. If the element exists, it will click the element, else it will ignore that step.

Example:

• SetIfExists

Description: This function will check if an element exists. If the element exists, data will be set for that element or that step will be ignored.

Input Format : @Expected Text

Example:

• setAndCheck

Description: This function is used to enter data in object and check if the element's value matches with the entered value.

Input Format : @Expected Text

Example:

• setEncrypted

Description: This function is used to enter encrypted data to the object specified

Input Format : @Encrypted text

Example:

Note: If the data is passed from a data sheet, the data in the datasheet should be encrypted

• filler

Description: This is an empty action (does nothing), useful in some cases like looping/debugging.

Example:

• StartBrowser

Description: This function is used to start a specified browser.

Input Format : @Browser's Name

Example:

• StopBrowser

Description: This function is used to stop the current browser

Example:

• AddVar

Description: This function is used to add a user-defined variable with a desired value and the scope of this variable is till the end of the test case in which it is defined

Input Format : @Expected Text

Condition : %variable name%

Example:

• AddGlobalVar

Description: Same as AddVar but scope is till the end of the test set execution.

Input Format : Text in Input

Condition : %variable name%

Example:

• clear

Description: This function is used to clear the object's text

Example:

• moveTo

Description: Move the browser view to the specified element.

Example:

• Open

Description: This function will open the URL provided by the user in the default browser

Input Format : @Expected Text

Example:

• highlight

Description: Make a rectangular border around the element

Input Format : Color in hexcode like @#ff44ff. If it is left empty red will be taken as default.

Example:

• verifyElementNotPresent

Description: This function will check if the specified element is not present in the web page ie. In the DOM .

Example:

• verifyElementNotSelected

Description: This function will check if the specified element is not selected.

Example:

• verifyElementNotDisplayed

Description: This function will verify if the element is not displayed.

Example:

• verifyElementNotEnabled

Description: This function will check if the specified element is not enabled

Example:

• verifyElementDisplayed

Description: This function will check if the object is displayed on web page.

Example:

• verifyHSrollBarPresent

Description: This function will check if the horizontal scrollbar is present.

Example:

• verifyHSrollBarNotPresent

Description: This function will check if the horizontal scrollbar is not present.

Example:

• verifyVSrollBarPresent

Description: This function will check if the vertical scrollbar is present.

Example:

• verifyVSrollBarNotPresent

Description: This function will check if the vertical scrollbar is not present.

Example:

• verifyElementPresent

Description: This function will check if the specified element is present in the web page ie) in the DOM.

Example:

• verifyElementSelected

Description: This function will check if the element is selected.

Example:

• verifyElementEnabled

Description: This function will check if the element is enabled.

Example:

• verifyPageSource

Description: This function will check if the page source content of the current page is matching with the expected page source content provided by the user.

Input Format : @Expected PageSource Content

Example:

• maximize

Description:This function is used for maximizing the browser window.

Example:

• authenticate

Description:This function is used for handing the authentication window. Supports IE only. If executed for other browsers the script will fail. You can skip this by setting optional value in the Condition field.

Input Format : @username##password

Condition : optional

Example:

• setInputByLabel

Description: This function will set an input element, with the given data, that is adjacent to the provided label element.

Example:

• clickInputByLabel

Description: This function will click an input element that is adjacent to the provided label element.

Example:

• clickInputByText

Description: This function will click an input element that is adjacent to the provided text

Input Format : @Expected Text

Example:

• submitInputByLabel

Description: This function will submit input element adjacent to the provided label element.

Example:

• assertElementTextContainsByLabel

Description: This function will check if the text of the input element adjacent to provided label element contains the given text(in the Input Column)

Input Format : @Expected Text.

Example:

• assertElementTextByLabel

Description: This function will check if the text of the input element adjacent to provided label element equals the given text(in the Input Column)

Example:

• verifyVariableFromDataSheet

Description: This function will validate the value of a given variable against data in a datasheet cell.

Input Format : Datasheet:column

Condition: %variable%

Example:

• verifyCookiePresent

Description: This function will check if the cookie is present. Search will occur based on the cookie name.

Input Format:@Cookie name.

Example:

• verifyCookieByName

Description: This function will search for the cookie by name and then compare the cookie value with the user-provided value.

Input Format : @Cookie name:Cookie value.

Example:

• verifyAlertText

Description: This function will match the alert text with the expected value.

Input Format : @Expected Text

Example:

• verifyAlertPresent

Description:This function will verify the presence of an alert.

Example:

• verifyVariable

Description: This function will check if the stored variable value matches the expected value.

Input Format : @VariableName=Value

Example:

• verifyTextPresentInPage

Description: This function will search for the text inside html tag of the page.

Input Format:@Expected Text

Example:

• waitForElementToBeVisible

Description: This function will wait till the element is visible on the screen

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForElementToBeInVisible

Description: This function will wait till the element becomes invisible.

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForElementToBeClickable

Description: This function will wait till the element becomes clickable.

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForElementToBeSelected

Description: This function will wait till the element is selected

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForElementToContainText

Description: This function will wait till the element contains the given text

Input Format : @Text to check.

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForElementToContainValue

Description: This function will wait till the element contains the given value

Input Format : @Text to check.

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForElementToBePresent

Description: This function will wait till the element loads in the DOM.

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForFrameAndSwitch

Description: This function will wait for the frame to be available and switch to it.

Input: @id or name or index

The input is optional if you choose to give the web element (the frame itself) under the object name.This element can be added as an object under the Object repository.

If the object name used is "Browser", then you need to give the frame id or name or index under the input column

Condition : Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForPageLoaded

Description: This function will wait till the page is loaded. Note: This is not for Ajax calls

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForAlertPresent

Description: This function will wait for alert to appear on the page.

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForTitleToBe

Description: This function will wait till the title of the page matches with the given text.

Input Format : @Text to check

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForTitleToContain

Description: This function will wait till the title of the page has the given text.

Input Format : @Text to check

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitTillCustomScript

Description: This function will wait till the given javascript condition returns true. It is applicable only for JavaScript functions that return a boolean value.

Input Format : @Javascript to evaluate

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• clickAndWait

Description: This function is used for clicking and waiting for the page to be loaded.

Example:

• waitForElementSelectionToBeTrue

Description: This function will wait till the element selection becomes true

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use "ChangeWaitTime" function with the desired wait time

Example:

• waitForElementSelectionToBeFalse

Description: This function will wait till the element selection becomes false.

Condition :Time in seconds [Optional]. If left empty default waitTime[10 sec] will be considered. If you want to increase the default wait time then you can use ChangeWaitTime function with the desired wait time

Example:

To switch to a new frame, you can either go for these actions or you can set the frame id or name under the frame property of your object in the UI of the tool.

• switchToFrameByIndex

Description: This function is used for switching control to a frame by given index.

Input Format : @Frame's Index

Example:

• switchToWindowByTitle

Description: This function is used for switching control to a window by given title.

Input Format : @Window's Title

Example:

• switchToWindowByIndex

Description: This function is used for switching control to a window by given index.

Input Format : @Window's Index

Example:

• switchToFrame

Description: This function is used for switching control to frame with id or name specified.

Input Format : @Frame Name or Id

Example:

• switchToWindowByTitleStartsWith

Description: This function is used for switching control to another window whose title begins with the provided data.

Input Format : @Expected text

Example:

• switchToWindowByTitleContains

Description: This function is used for switching control to another window whose title has the provided data.

Input Format : @Expected text

Example:

• switchToWindowByTitleEndsWith

Description: This function is used for switching control to another window whose title ends with the provided data

Input Format : @Expected text

Example:

• switchToWindowByTitleMatches

Description: This function is used for switching control to another window whose title matches with the provided data (can use regex also).

Input Format : @Expected text

Example:

• switchToDefaultContent

Description: This function is used for switching control to the default window.

Example:

• createAndSwitchToWindow

Description: This function is used to create a new window and then for switching control to the newly created window.

Input Format : @url to open after creating a new window. If this input column is empty then empty url will be loaded

Example:

• closeAndSwitchToWindow

Description: This function will close the current window and switch back to the default window.

Example:

• selectByIndex

Description: This function will select an option from a drop down whose index matches the given index.

Input Format : @Expected Value's Index

Example:

• deSelectAll

Description: This function will clear all the selected entries. This is only valid when there is support for multiple selections in the drop down.

Example:

• selectByVisibleText

Description: This function will select an option from a drop down whose visible text matches the given text.

Input Format : @Expected Value's Index

Example:

• selectMultipleByText

Description: This function will select all options that display the text matching the given text.

Input Format : @Expected Text1,Expected Text2

Example:

• selectMultipleByValue

Description: This function will select all options that have value matching the given value.

Input Format : @Expected value1,Expected value2

Example:

• selectByValue

Description: This function will select an option from a drop down whose value ('value' attribute of option HTML tag) matches the given value.

Input Format : @Expected Text

Example:

• selectMultipleByIndex

Description: This function will select all multiple options that have index matching the given set of indices.

Input Format : @Expected index1,Expected index2

Example:

• deSelectByVisibleText

Description: This function will de-select an option that displays text matching the given text.

Input Format : @Expected Text

Example:

• deSelectByValue

Description: This function will de-select an option that has value matching the given value.

Input Format : @Expected value

Example:

• deSelectByIndex

Description: This function will de-select an option that has index matching the given index.

Input Format : @Expected index

Example:

• assertSelectContains

Description: This function will assert if the selected element from the drop down matches the user-specified input.

Input Format : @Expected Text

Example:

• selectValueFromUnorderedList

Description: This function will select the value based on the visible text from an unordered list.

Input Format : @Expected Text

Example:

• selectIndexFromUnorderedList

Description: This function will select the value from an unordered list based on the index.

Input Format : @Expected Value's index

Example:

• deSelectMultipleByText

Description: This function will deselect all options that display text matching the given text.

Input Format : @Expected Text1,Expected Text2

Example:

• deSelectMultipleByValue

Description: This function will de-select all options that has value matching the given values.

Input Format : @Expected value1,Expected value2

Example:

• deSelectMultipleByIndex

Description: This function will de-select all options that has index matching the given indices. This is done by examining the "index" attribute of an element, and not merely by counting.If there is no index attribute used then option identified by the count

Input Format : @Expected index1,Expected index2

Example:

• selectAll

Description: This function will select all options from a select element.

Example:

• getCellValue

Description: This function is used to get data from the desired cell of the web table and store it in a user-defined variable.

Input Format : @RowNo;ColNo,%variableName%

Example:

• getColCount

Description: This function is used to count the number of columns in a desired row in a web table and store it in a user-defined variable.

Input Format : @RowNo,%variableName%

Example:

• getRowNumber

Description: This function is used to get the number of the row of the desired data in a web table and store it in a user-defined variable.

Input Format : @Expected Data,%variableName%

Example:

• getColNumber

Description: This function is used to get the column number of the desired data in a web table and store it in a user-defined variable.

Input Format : @Expected Data,%variableName%

Example:

• getRowCount

Description: This function is used to count the number of rows in a web table and store it in a user-defined variable.

Input Format : %variableName%

Example:

• set_Relative

Description: This function will set data in an element based on the property of its parent (Useful when a page has objects with similar properties but their parents are unique).

Example:

• click_Relative

Description: This function will click an element based on the property of its parent (Useful when a page has objects with similar properties but their parents are unique)

Example:

• setglobalObjectProperty

Description: This function is used to customize all objects’ property based on the requirement at runtime.User can give his desired value as an input which will replace the matching condition in the object's property. **For more details, please refer to Help>Faq>Dynamic Object Handling>How to change Object property at runtime? **

Input Format :Input Column : @User Defined Text String

Condition Column : #Variable name

Example:

• setObjectProperty

Description: This function is used to customize any object property based on the requirement during the runtime. User can give a desired value as an input which will replace the matching condition in the object property. For more details, refer to: Help>Faq>Dynamic Object Handling>How to change Object property at runtime?

Input Format : @User Defined Text String

Condition Column : #Variable name

Example:

• uncheck

Description: This function will uncheck the specified check box.

Example:

• checkAllCheckBoxes

Description: This function will check all the checkboxes on a page.

Example:

• check

Description: This function will check the specified checkbox element.

Example:

• clickByJS

Description: This function will use JavaScript to click an object (useful when selenium functions do not work).

Example:

• setByJS

Description: This function will use JavaScript to set data in an object (useful when selenium functions do not work).

Input Format : @Expected data

Example:

• setEncryptedByJS

Description: This function will use JavaScript to set encrypted data in an object (useful when selenium functions do not work).

Input Format : @Expected encrypted data

Example:

• clearByJS

Description: This function will use JavaScript to clear an objects text content (useful when selenium functions do not work).

Example:

• selectByJS

Description: This function is used to select a given option from a drop down and is useful when selenium functions do not work.

Example:

• assertInsideBounds

Description: To function is used to check if the given object is inside the boundary.

Example:

• executeEval

Description: This function is used to execute the JavaScript commands

Input Format : @java script scripts

Example:

• assertElementNotPresent

Description: This function will check if the specified element is not present in the web page ie. In the DOM itself.

Example:

• assertElementNotSelected

Description: This function will check if the specified element is not selected

Example:

• assertElementNotDisplayed

Description: This function will check if the specified element is not displayed.

Example:

• assertElementNotEnabled

Description: This function will check if the specified element is not enabled.

Example:

• assertElementDisplayed

Description: This function will check if the object is displayed on web page.

Example:

• assertHScrollBarPresent

Description: This function will check if horizontal scrollbar is present.

Example:

• assertHScrollBarNotPresent

Description: This function will check if horizontal scrollbar is not present.

Example:

• assertVScrollBarPresent

Description: This function will check if vertical scrollbar is present.

Example:

• assertVScrollBarNotPresent

Description: This function will check if vertical scrollbar is not present.

Example:

• assertElementPresent

Description: This function will check if specified element is present in the web page ie. In the DOM of the page

Example:

• assertElementSelected

Description: This function will check if the element is selected.

Example:

• assertElementEnabled

Description: This function will check if the element is enabled.

Example:

• assertPageSource

Description: This function will check if the page source content of the current page is matching with the expected page source content provided by the user.

Input Format : @Expected PageSource content

Example:

• refreshDriver

Description: This function will refresh the current web page.

Example:

• forward

Description: This function is used for navigating forward to next page.

Example:

• submit

Description: This function will Submit an element.

Example:

• dragElement

Description: This function will drag the specified element(under Object column) which can be later dropped on to other element by using dropElement.

Example:

• dropElement

Description: This function will drop the element which is dragged by using dragElement over the object specified here.

Example:

• dragAndDropBy

Description: This function will drag and drop an object by specified coordinates in the input column.

Input Format :@x-coordinate,y-coordinate

Example:

• addCookie

Description: This function will add a cookie defined in the input column.

Input Format : @Cookie Name:Cookie Value

Example:

• back

Description: This function is used for navigating to the previous page.

Example:

• pause

Description:This function is used for giving a pause (Thread.sleep) in execution.

Input Format : @Time in miliseconds

Example:

• doubleClickElement

Description: This function will double-click on an object.

Example:

• mouseOverElement

Description: This function will perform the mouse over action on the object.

Example:

• dragToAndDropElement

Description: This function is used to perform drag and drop operation. Specify the object which you want to drag, in the 'Object' column and specify the object on which you want to drop ,in the 'input' column.

Input Format : @PageName:ObjectName(Destination)

Example:

• releaseElement

Description: This function is used to release the element held by clickAndHoldElement

Example:

• saveScreenshot

Description: This function will capture the screenshot and save in the specific location.

Input Format : @File destination (eg. @D:\filename.png)

Example:

• takeScreenshot

Description: This function will take a screenshot

Example:

• saveElementScreenshot

Description: This function will take a screenshot of the web element and save it in the location specified under the Input column. If no location is specified then the default location is your project folder\ObjectRepository\Pagename\objectname.

This function can also be used to save screenshots for the entire set of page objects, under the default location which is inside the ObjectRepository folder.

Input Format (Optional) : @File destination (eg. @D:\foldername)

Example:

• storeCurrentUrl

Description: This function will store the current URL into a user defined variable.

Input Format : %variable name%

Example:

• storeTextinDataSheet

Description: This Function will store the element's text into respective column of a given datasheet.

Input Format : @Expected datasheet name:column name

Example:

Note: Ensure that your data sheet doesn't contain column names with spaces.

• storeTextPresent

Description: This function will check if the element has expected text and store the flag 'True' or 'False' in the variable.

Input Format : @Expected text

Condition : %variable name%

Example:

• storePageSource

Description: This function will store the page source content into a user-defined variable.

Input Format : %variable name%

Example:

• storeElementSelected

Description: This function will check if the element is selected and store the flag 'True' or 'False' in the variable.

Input Format : %variable name%

Example:

• storeElementAttribute

Description: This function will store the element's attribute value into a user-defined variable.

Input Format : @Elements_Attribute_Name

Condition : %variable name%

Example:

• storeElementValue

Description: This function will store the element's ‘value‘ attribute into a user-defined variable.

Input Format : %variable name%

Example:

• storeCookiePresent

Description: This function will check if the given cookie is present and store the flag 'True' or 'False' in the variable.

Input Format : @cookieName

Condition: %variable%

Example:

• storeCookieByName

Description: This function will store the given cookie's value in the variable.

Input Format : @cookieName

Condition: %variable%

Example:

• storeAlertText

Description: This function will store alert text into a user defined variable.

Input Format: %variable%

Example:

• storeAlertPresent

Description: This function will check if alert is present and store the flag 'True' or 'False' in a given variable.

Input Format: %variable%

Example:

• sendKeysToElement

Description: This function is used to perform keyboard events with respect to object.

Input Format : @Keyboard_Keys(like Enter,Shift,Ctrl,Ctrl+A)

Example:

• sendKeysToWindow

Description: This function is used to perform the keyboard actions with respect to window.

Input Format : @Keyboard_Keys(like Enter,Shift,Ctrl,Ctrl+T)

Example:

• deleteCookie

Description: This function will delete the cookie specified by the user.

Input Format : @Cookie Name

Example:

• answerAlert

Description: This function is used for switch control to alert and answer it.

Input Format : @Expected Text

Example:

• acceptAlert

Description: This function is used for switch control to alert and accept it.

Example:

• dismissAlert

Description: This function is used to switch control to alert and to dismiss it.

Example:

• storeVariable

Description: This function will store the given data (in the input column) into a user-defined variable.This function is same as AddVar action.

Input Format : @Desired Value

Condition: %variable name%

Example:

• storeVariableInDataSheet

Description: This function will store the variable's value (as given in the condition column) in the given data sheet and data column

Input Format: Sheetname:columnname

Condition: %variable name%

Example:

• storeTitle

Description: This function will store the current web page title into a user-defined variable.

Input Format : %variable name%

Example:

• storeText

Description: This function will store the element's text into a user-defined variable.

Input Format : %variable name%

Example:

• storeEval

Description: Function to store a Javascript expression's value in a variable.

For example if you have a variable as 'a' and 'b' and want to add them and store the sum in a variable, you can follow the following syntax.

Now the value 50(a+b), will be stored in var.

Input Format : javascript

Example:

• print

Description: This function can be used for printing expected data in report.

Input Format : @Expected Text or variable can also be printed like %var_name%

Example:

• close

Description: This function will close the selenium Web Driver.

Example:

• scrollHorizontallyTo

Description: This function will scroll horizontally to a user defined position.

Input Format : @left|right|number

Example:

• scrollVerticallyTo

Description: This function will scroll vertically to a user defined position.

Input Format : @left|right|number

Example:

• scrollToBottom

Description: This function will scroll to the bottom of the page

Example:

• scrollTo

Description: This function will scroll to a user specified position.

Input Format : @x co-ordinate,y co-ordinate

Example:

• scrollToTop

Description: This function will scroll to the top of the page

Example:

• scrollToLeft

Description: This function will scroll to the left of the page

Example:

• scrollToRight

Description: This function will scroll to the right of the page

Example:

• assertTextPresentInPage

Description: This function will search for the expected text within the html tag of the page and assert the same

Input Format : @Expected Text

Example:

• assertVariable

Description: This function will assert a stored variable's value with the value given by the user.

Input Format : @%var_name%=Expected Value

Example:

• assertCookiePresent

Description: This function will assert the presence of a cookie by it's specified name and store the result in a variable.

Input Format : @CookieName

Example:

• assertCookieByName

Description: This function will assert the cookie's (the name of the cookie is given is specified in the input column) value with the one in the input column

Input Format : @CookieName:CookieValue

Example:

• assertAlertText

Description: This function will assert the text present in alert with the given text.

Input Format : @Expected Text

Example:

• assertAlertPresent

Description: This function will assert the presence of an alert

Example:

• assertEval

Description: This function will assert if the evaluated javascript expression equals the expected value provided.

Input Format : @javascript:expectedvalue.

Example:

• assertVariableFromDataSheet

Description: This function will check if the variable given in the condition column has a value equals to the value from the datasheet mentioned in the input column.

Input Format : Datasheet name:Column name

Condition Format: %Variable name%

Example:

• assertTitleIStartsWith

Description: This function will validate if the current page title begins with the user-provided data. This function will ignore case of the user-provided data.

Input Format : @Expected text

Example:

• assertTitleEquals

Description: This function will validate if the title of the current page is equals the user-provided data.

Input Format : @Expected text

Example:

• assertTitleContains

Description: This function will validate if the title of the current page has the user-provided data.

Input Format : @Expected text

Example:

• assertTitleStartsWith

Description: This function will validate if the title of the current page begins with the user-provided data.

Input Format : @Expected text

Example:

• assertTitleEndsWith

Description: This function will validate if the title of the current page ends with the user-provided data.

Input Format : @Expected text

Example:

• assertTitleMatches

Description: This function will validate if the title current page matches the user-provided data. You can also use regular expression in the Input field.

Input Format : @Expected text

Example:

• assertTitleIEquals

Description: This function will validate if the title of the current page is equals the user-provided data. This function will ignore case of user provided data.

Input Format : @Expected text

Example:

• assertTitleIContains

Description: This function will validate if the title of the current page contains the user-provided data. This function will ignore case of the user-provided data.

Input Format : @Expected text

Example:

• assertTitleIEndsWith

Description: This function will validate if the title of the current page ends with the user-provided data. This function will ignore case of the user-provided data.

Input Format : @Expected text

Example:

• assertElementAttrEquals

Description: This function will validate if specified attribute for an element is equal to the user-provided data.

Input Format : attributeName attributeValue

Example:

• assertElementAttrContains

Description: This function will validate if the specified attribute for an element contains the user-provided data.

Input Format : attributeName attributeValue

Example:

• assertElementAttrStartsWith

Description: This function will validate if specified attribute for an element begins with the user-provided data.

Input Format : attributeName attributeValue

Example:

• assertElementAttrEndsWith

Description: This function will validate if specified attribute for an element ends with user provided data.

Input Format : attributeName attributeValue

Example:

• assertElementAttrMatches

Description: This function will validate if specified attribute for an element matches with the user-provided data. You can also use regular expression in the Input field.

Input Format : attributeName attributeValue

Example:

• assertElementAttrIEquals

Description: This function will validate if specified attribute for an element is equals the user-provided data.This function will ignore case of the user-provided data.

Input Format : attributeName attributeValue

Example:

• assertElementAttrIContains

Description: This function will validate if specified attribute contains user-provided data.This function will ignore case of the user-provided data.

Input Format : attributeName attributeValue

Example:

• assertElementAttrIStartsWith

Description: This function will validate if specified attribute for an element begins with the user-provided data. This function will ignore case of the user-provided data.

Input Format : attributeName attributeValue

Example:

• assertElementAttrIEndsWith

Description: This function will validate if specified attribute for an element ends with the user-provided data. This function will ignore case of the user-provided data.

Input Format : attributeName attributeValue

Example:

• verifyElementAttribute

Description: This function will check if the value of the specified attribute of the element matches the user provided value.

Input Format : attributeName attributeValue

Example:

• assertElementTextEquals

Description: This function will validate if a specified element text is equal to the user-provided text.

Input Format : @Expected Text

Example:

• assertElementTextContains

Description: This function will check if an element text contains the expected text.

Input Format : @Expected Text

Example:

• assertElementTextStartsWith

Description: This function will validate if specified element text starts with user provided data.

Input Format : @Expected Text

Example:

• assertElementTextEndsWith

Description: This function will validate if the specified element text ends with user-provided data.

Input Format : @Expected Text

Example:

• assertElementTextMatches

Description: This function will validate if a specified element text matches with the user-provided data. You can also use regular expression in the Input field .

Input Format : @Expected Text

Example:

• assertElementTextIEquals

Description: This function will validate if a specified element text is equal to the user-provided data. This function will ignore case of the user-provided data.

Input Format : @Expected Text

Example:

• assertElementTextIContains

Description: This function will validate if a specified element text contains the user-provided data. This function will ignore case of the user-provided data.

Input Format : @Expected Text

Example:

• assertElementTextIStartsWith

Description: This function will validate if a specified element text begins with the user-provided data. This function will ignore case of the user-provided data.

Input Format : @Expected Text

Example:

• assertElementTextIEndsWith

Description: This function will validate if a specified element text ends with the user-provided data. This function will ignore case of the user-provided data.

Input Format : @Expected Text

Example:

• assertUrlEquals

Description:This function will validate if the current URL equals the user-provided data.

Input Format : @Url value

Syntax:

• assertUrlContains

Description:This function will validate if the current URL has the user-provided data.

Input Format : @Url value

Syntax:

• assertUrlStartsWith

Description:This function will validate if the current URL beings with the user-provided data.

Input Format : @Url value

Syntax:

• assertUrlEndsWith

Description:This function will validate if the current URL text ends with user-provided data.

Input Format : @Url value

Syntax:

• assertUrlMatches

Description: This function will validate if the current URL matches with the user-provided data. You can also use regular expression in the Input field.

Input Format : @Url value

Syntax:

• assertUrlIEquals

Description: This function will validate if the current URL is equal to the user-provided data. This function will ignore case of user-provided data.

Input Format : @Url value

Syntax:

• assertUrlIContains

Description: This function will validate if the current URL has the user-provided data.This function will ignore case of user-provided data.

Input Format : @Url value

Syntax:

• assertUrlIStartsWith

Description: This function will validate if the current URL begins with the user-provided data. This function will ignore case of user provided data.

Input Format : @Url value

Syntax:

• assertUrlIEndsWith

Description: This function will validate if the current URL ends with the user-provided data. This function will ignore case of user-provided data.

Input Format : @Url value

Syntax:

• postRestRequest

Description: This function is used to perform POST action on a Rest API.

Input Format : @Expected Payload

Example:

Inputs in the Input column can be either hardcoded , passed inside the JSON editor which is capable of parameterising the Payload (Press ctrl+space to see the list of variables available ), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• putRestRequest

Description: This function is used to perform PUT action on a Rest API.

Input Format : @Expected Payload

Example:

Inputs in the Input column can be either hardcoded , passed inside the JSON editor which is capable of parameterising the Payload (Press ctrl+space to see the list of variables available ), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• postSoapRequest

Description: This function is used to perform POST action on a SOAP API.

Input Format : @Expected Payload

Example:

Inputs in the Input column can be either hardcoded , passed inside the XML editor which is capable of parameterising the Payload (Press ctrl+space to see the list of variables available ), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• getRestRequest

Description: This function is used to perform GET action on a Rest API.

Example:

• deleteRestRequest

Description: This function is used to perform DELETE action on a Rest API.

Example:

• assertResponseCode

Description: This function is used to validate the response code of SOAP/REST response.

Input Format : @Expected code

Example:

Inputs in the Input column can be either hardcoded , passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• assertResponseMessage

Description: This function is used to validate the response message of SOAP/REST response.

Input Format : @Expected message

Example:

Inputs in the Input column can be either hardcoded , passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• assertResponsebodycontains

Description: This function is used to validate whether the response body of SOAP/REST request contains an expected text or not.

Input Format : @Expected Text

Example:

Inputs in the Input column can be either hardcoded , passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• assertJSONelementEquals

Description: This function is used to validate whether a certain JSON tag of the response body of REST request contains an expected text or not.

Input Format : @Expected Text

Condition Format : JSON Path of the tag

Example:

Inputs in the Input column can be either hardcoded , passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

The Condition expects a JSON Path in the format : $.JSONPath. Please follow the example in Appendix I.

• assertXMLelementEquals

Description: This function is used to validate whether a certain XML tag of the response body of SOAP request contains an expected text or not.

Input Format : @Expected Text

Condition Format: XPath of the tag

Example:

Inputs in the Input column can be either hardcoded , passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

The Condition expects a XPath in the format : /Parent/Child/text(). Please follow the example in Appendix II.

• storeJSONelementInDataSheet

Description: This function is used to store a certain JSON tag value inside the response body of REST request, into a respective column of a given datasheet.

Input Format : @Expected datasheet name:column name

Condition Format: JSONPath of the tag

Example:

Note: Ensure that your data sheet doesn't contain column names with spaces.

The Condition expects a JSON Path in the format : $.JSONPath. Please follow the example in Appendix I.

• storeXMLelementInDataSheet

Description: This function is used to store a certain XML tag value inside the response body of SOAP request, into a respective column of a given datasheet.

Input Format : @Expected datasheet name:column name

Condition Format: XPath of the tag

Example:

Note: Ensure that your data sheet doesn't contain column names with spaces.

The Condition expects an XPath in the format : /Parent/Child/text(). Please follow the example in Appendix II.

• storeJSONelement

Description: This function is used to store a certain JSON tag value inside the response body of REST request, into a variable.

Input Format : @JSONPath of the tag

Condition Format: %variable name%

Example:

The Input expects a JSON Path in the format : $.JSONPath. Please follow the example in Appendix I.

The Condition expects the name of a variable in this format : %var% where ‘var’ is the variable name.

• storeXMLelement

Description: This function is used to store a certain XML tag value inside the response body of SOAP request, into a variable.

Input Format : @XPath of the tag

Condition Format: %variable name%

Example:

The Input expects an XPath in the format : /Parent/Child/text(). Please follow the example in Appendix II.

The Condition expects the name of a variable in this format : %var% where ‘var’ is the variable name.

• storeResponseBodyInDataSheet

Description: This function is used to store the response body of SOAP/REST request, into a respective column of a given datasheet.

Input Format : @Expected datasheet name:column name

Example:

Note: Ensure that your data sheet doesn't contain column names with spaces.

• storeHeaderElementByName

Description: This function is used to store a Header Value of the response of SOAP/REST request, into a variable.

Input Format : @Header Name

Condition Format : %variable name%

Example:

• setEndPoint

Description: This function is used to set the End Point for a Rest/SOAP API.

Input Format : @End point

Example:

Inputs in the Input column can be either hardcoded , passed inside the Endpoint editor which is capable of parameterising the Endpoint (Press ctrl+space to see the list of variables available ), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• addHeader

Description: This function is used to add a header for a Rest/SOAP API request.

Input Format : @HeaderName=HeaderValue

Example:

Inputs in the Input column can be either hardcoded , passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• closeConnection

Description: This function is used to close a connection for a Rest/SOAP API request.

Example:

Inputs in the Input column can be either hardcoded , passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• setBasicAuthorization

Description: This function is used to set Basic Authorization for a Rest/SOAP API request.

Input Format : @EncryptedAuthorizationDetails

Example:

Inputs in the Input column can be either hardcoded , passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• JSON Path Example :

JSON Body :

{ 
   "name":"TestName",
   "salary":"12300",
   "age":"29"
}

JSON Path for retrieving “TestName” is $.name

• XPath Example :

XML Body :

<root xmlns:foo="http://www.foo.org/" xmlns:bar="http://www.bar.org">
	<actors>
		<actor id="1">Christian Bale</actor>
		<actor id="2">Liam Neeson</actor>
		<actor id="3">Michael Caine</actor>
	</actors>
</root>

XPath for retrieving “Liam Neeson” is /root/actors/actor[2]/text() or simply //actor[2]/text()

• How a complete Request Test Case should look like -

1. A request should contain a setEndPoint action. This action is always marked in blue.

2. A request should contain an HTTP Method . This action is always marked in green.

3. A request should contain a closeConnection action. This action is always marked in brown.

• Troubleshooting :

1. If you get an error like this :

PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target - You need to add the certificate of the application whose APIs you are trying to test.

To add the certificate follow the steps below :

a. Download the certificate b. Import the Trusted Root Certificate into your cacerts keystore, using following command : keytool -import -trustcacerts -keystore $JAVA_HOME/jre/lib/security/cacerts -storepass changeit -alias Root -import -file mycertificate.pem

• swipeRight

Description: This function will swipe right (from left)

Input Format : @start,end (for example, @10,80 10-10 % of width, 80 -80 % of width)

Input is Optional

Screenshot : No

Example:

• swipeLeft

Description: This function will swipe left (from right)

Input Format :@start,end (for example, @80,10 10-10 % of width, 80 -80 % of width)

Input is Optional

Example:

• swipeDown

Description: This function will swipe down (from Top).

Input Format : @start,end (for example, @10,80 10-10 % of height, 80 -80 % of height)

Input is Optional

Example:

• swipeUp

Description: This function will swipe up (from bottom)

Input Format :@start,end (for example, @80,10 10-10 % of height, 80 -80 % of height)

Input is Optional

Example:

• tap

Description: Convenience method for tapping the center of an element on the screen

Parameters : fingers- number of fingers/appendages to tap with element - element to tap duration - how long between pressing down, and lifting fingers/appendages.

Input Format :@no.of.fingers ,time in seconds [1,1]

Example:

• tapAt

Description: Convenience method for tapping a position on the screen

Parameters : fingers- number of fingers/appendages to tap with x - x coordinate y - y coordinate duration - how long between pressing down, and lifting fingers/appendages

Input Format :@no.of.fingers,x,y,time_in_seconds [1,50,60,1]

Example:

• zoom

Description: Convenience method for zooming in on an element on the screen. "zooming in" refers to the action of two appendages pressing the screen and sliding away from each other.

NOTE: This convenience method slides touches away from the element, if this would happen to place one of them off the screen, appium will return an outOfBounds error. In such a case, revert to using the MultiTouchAction api instead of this method.

Example:

• pinch

Description: Convenience method for pinching an element on the screen. "pinching" refers to the action of two appendages pressing the screen and sliding towards each other.

NOTE: This convenience method places the initial touches around the element, if this would happen to place one of them off the screen, appium will return an outOfBounds error. In such a case, revert to using the MultiTouchAction api instead of this method.

Example:

• toggleLocationServices

Description: This function will toggle location Services from your settings.

Example:

• zoomAt

Description: This function will zoom at the user-provided location.

Input Format : @x,y

The x,y coordinates are given in the input column

Example:

• pinchAt

Description: This function will pinch at the user-provided location.

Input Format :@x,y

The x,y coordinates are given in the input column

Example:

• lockScreen

Description: This function will lock the device (bring it to the lock screen) for a given number of seconds

Input Format : @time in seconds

Example:

• switchContext

Description: This function will switch context of the driver

Input Format : @Context to switch

Example:

• launchApp

Description: This function will launch the application which was provided in the emulator Capabilities when creating session.

Example:

• installApp

Description: This function will install an application on the mobile device.

Input Format : @path of the apk or app

Example:

• hideKeyboard

Description: This function will hide the software keyboard .

Example:

• resetApp

Description:This function will reset the currently running application (given in emulator Capabilities) for the current session.

Example:

• clear

Description: This function is used to clear the object's text

Example:

• openNotifications

Description: This function opens the notification view in the device.

Example:

• mobile_back

Description: This action is used to traverse back to the previous page.

Example:

• settings

Description: MakThis function will press settings key [Android]

Example:

• search

Description: This function will press Search key

Example:

• enter

Description: This function will press the Enter key [Android].

Example:

• menu

Description: This function will press the Menu key [Android].

Example:

• home

Description: This function will press the Home key [Android].

Example:

• setKey

Description: This function will press the given key [Android]

Input Format : @AndroidKeyCode [http://appium.github.io/javaclient/io/appium/java_client/android/AndroidKeyCode.html]

Example:

• capturePageTimings

Description: This action captures page navigation and resource timings parameters of the web page last opened using Open action and stores it in the report and HAR.

Input Format : @Page Name

Example:

• ClearCache

Description: Clears browser's data for example cookies.

Example:

• testAccessibility

Description: This function will generate the accessibility report for the entire web page based on the input parameters passed, Report name is mandatory under the input.

Example:

Inputs in the Input column can be either hardcoded (in this case the data is preceded by a "@"), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

• testAccessibilityElement

Description: This function will generate the accessibility report for a particular web element based on the input parameters passed. The input parameters are optional. In case no input parameter is passed the report will be generated for all tags associated with the element, the default name for the report will be the name of the element.

Example:

• initDBConnection

Description: This function will initialize the database connection

Example:

• closeDBConnection

Description: This function will close the database connection

Example:

• assertDBResult

Description: This function will assert if the SQL result contains a particular data in a specific column after the execution of a SQL select statement.

Input Format : @ExpectedValue

Condition : Name of the column in which result is expected

Example:

• executeSelectQuery

Description: This function will execute the given select query on the database

Input Format : @sqlQuery

Example:

• executeDMLQuery

Description: This query will execute an SQL DML statement on the database and will commit the results back to the database

Input Format : @sqlQuer

Example:

• storeDBValueinDataSheet

Description: This action will store the value of a specific cell(from specific row and column) from the result of an SQL select statement in the data sheet

Input Format : @DatasheetName:ColumnName , Condition : DatabaseColumnName, ResultSetRowNumber

Example:

• storeValueInVariable

Description: This action will store the value of a specific cell(from specific row and column) from the result of an SQL select statement in a user defined variable

Input Format : %variableName% , Condition : DatabaseColumnName, ResultSetRowNumber

Example:

• storeValueInGlobalVariable

Description: This action will store the value of a specific cell(from specific row and column) from the result of an SQL select statement in global variable

Input Format : %variableName% , Condition : DatabaseColumnName, ResultSetRowNumber

Example:

• storeResultInDataSheet

Description: This action will store the result of an SQL select statement in the test data sheet in Cognizant Intelligent Test Scripter

Input Format : @sqlQuery , Condition : DatasheetName

Example:

• storeResultInVariable

Description: This action will store the result of an SQL select statement in a user defined variable. The select query in this case should return a single column, the query may return multiple rows. In case the query returns a single value, the value will be stored in the variable name given (for eg:- var), In case if the select query returns multiple rows, multiple variables will be created by adding indexes to the variable name given and the value will be stored in these variables(for eg:- var1, var2, var3.....)

Input Format : @sqlQuery , Condition : %VariableName%

Example:

• imgAssertText

Description: This function is used to check if the given expected text is present in the image object.

Input Format : @Expected Text

Example:

• imgVerifyText

Description: This function is used to verify if the given expected text is present in the image object.

Input Format : @Expected Text

Example:

• imgStoreText

Description: This function is used to store image text in a user-defined variable.

Input Format : %Variable_Name%

Example:

• imgAssertTextAbove

Description: This function is used to check if the expected text is above the image object.

Input Format : @Expected Text

Example:

• imgAssertTextBelow

Description: This function is used to check if the expected text is below the image object.

Input Format : @Expected Text

Example:

• imgAssertTextRight

Description:This function is used to check if the expected text is at the right to the image object.

Input Format : @Expected Text

Example:

• imgAssertTextLeft

Description: This function is used to check if the expected text is at the left of the image object.

Input Format : @Expected Text

Example:

• imgVerifyTextAbove

Description: TThis function is used to check if the expected text is above the image object.

Input Format : @Expected Text

Example:

• imgVerifyTextBelow

Description: This function is used to check if the expected text is below the image object.

Input Format : @Expected Text

Example:

• imgVerifyTextRight

Description: This function is used to check if the expected text is to the right of the image object.

Input Format : @Expected Text

Example:

• imgVerifyTextLeft

Description: This function is used to check if the expected text is to the left of the image object.

Input Format : @Expected Text

Example:

• imgStoreTextAbove

Description: This function is used to store a text above the object in a user-defined

Input Format : %Variable_Name%

Example:

• imgStoreTextBelow

Description: This function is used to store a text below the object in a user-defined

Input Format : %Variable_Name%

Example:

• imgStoreTextRight

Description: This function is used to store a text to the right of the object in a userdefined variable.

Input Format : %Variable_Name%

Example:

• imgStoreTextLeft

Description: This function is used to store a text to the left of the object in a user-defined variable.

Input Format : %Variable_Name%

Example:

• imgClearAndSet

Description: This function will clear an image object and then it will set the user provided data in that object.

Input Format : @Expected data.

Example:

• imgSetEncrypted

Description: This function is used to enter the encrypted data into image objects.

Input Format : @Expected data.

Example:

Note: If the data is passed from data sheet, then the data in the sheet should be encrypted.

• imgDoubleClick

Description: This function is used to find and double-click the image on the screen.

Example:

• imgVerifyImage

Description: This function is used to verify if the image object is on the screen.

Example:

• imgAssertImage

Description: This function is used to check if the image is on the screen.

Example:

• imgClick

Description: Finds and clicks the image on the screen.

Input Format : Give Optional parameter as keyModifiers (i.e., Ctrl/Shift/Alt)

Example:

• imgType

Description: This function is used for typing any user given data in an image.

Input Format : @Expected Data

Example:

• typeOnScreen

Description: This function is used to type any text on the screen where the cursor/focus is currently available.

Input Format : @Text to be typed

Example:

• imgClearText

Description: This function is used to delete the whole text from the image objects such as from a text.

Example:

• imgHover

Description: This function is used to hover the mouse over the image object on the screen.

Example:

• imgSet

Description: This function is used to set (Paste) the input data on the image.

Input Format : @Expected Data

Example:

• imgRightClick

Description: This function is used to right-click the specificed image on the screen.

Example:

• imgWait

Description: Waits for the image to appear on the screen

Input Format : @time in seconds .If the input column is left empty default time of 10 seconds will be used.

Example:

• imgWaitVanish

Description: This function is used to wait for the image to disappear from the screen.

Input Format : @time in seconds. If the input column is left empty default time of 10 seconds will be used

Example:

• imgFindinPage

Description: This function is used to find any image on the page within the desired time.

Input Format : @Time in miliseconds

Example:

• imgmouseDown

Description: This function is used to perform the mouse down operation. Keys integer value can be given as the input.

Input Format : @Keys Integer Representation (16, 8, 4, -1, 1 respectively for mouse left, middle, right, wheel up, wheel down buttons)

Example:

• imgmouseUp

Description: This function is used to perform the mouse up operation. Keys integer value can be given as the input.

Input Format : @Keys Integer Representation (16, 8, 4, -1, 1 respectively for mouse left, middle, right, wheel up, and wheel down buttons)

Example:

• moveMouseTO

Description: This function will move the mouse to a user-defined location.

Input Format : @Location

Example:

• shortcutKeys

Description: This function is used to perform the keyboard shortcut actions.

Input Format : @Combination of keys such as Ctrl+a

Example: