17.2 System Keywords
Action Keywords
HandleExpectedPopup
This keyword handles specified popup once during the execution using TAB and ENTER keys combination.
It takes WindowTitle, Number Of Tabs & WaitTime as input parameter.
For example, you want to remove or handle the popup present on window then you can use this keyword.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
Window Title |
Yes |
This Keyword takes value in String |
Number of Tabs |
Yes |
This Keyword takes Value in integer |
Wait Time |
Yes |
This Keyword takes Value in Integer |
Output
True |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to Handle the popup, here is how you will use this keyword.
HandleExpectedPopup
Window Title |
Please select a Valid From City |
Number of Tabs |
2 |
Wait Time |
10 |
Output |
True |
Error conditions
Condition |
Debug Information |
Message |
If Data input Argument is null or Window Title is null |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Window Title must not be empty |
KeyPress
This keyword is used to send keystrokes to the active application window.
It takes Key, No. of repetition as input parameter.
For example, you want to press a key from keyboard then you can use this keyword.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
Key |
Yes |
This Keyword takes value in String |
Output
True |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to press a key, here is how you will use this keyword
KeyPress
Key |
{ENTER} |
Output |
True |
Error conditions
Condition |
Debug Information |
Message |
If Key Value is null |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value |
KillProcess
This keyword kills the specified Process. It takes the process name (notepad.exe) as input parameter.
For example, you want to kill the process.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
Process Name |
Yes |
This Keyword takes value in String |
Output
True |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to kill the process, here is how you will use this keyword
KillProcess
Process Name |
notepad.exe |
Output |
True |
Error conditions
Condition |
Debug Information |
Message |
If Process Value is null |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
Process name can not blank |
SendString
This keyword is used to send string to the active application window. It takes KeyName as input parameter.
For example, you want to sendString.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
KeyName |
Yes |
This Keyword takes value in String |
Output
True |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to Send a key (in String), here is how you will use this keyword
SendString
KeyName |
{ENTER} |
Output |
True |
Note: Please provide the String name in Curly Braces.
Error conditions
Condition |
Debug Information |
Message |
If String Value is null |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value |
Assertion Keywords
CompareString
This keyword is used to compare the two strings whether they are equal or not.
It returns True if the two strings are equal. It takes String1 & String2 as input parameter.
For example, you want to verify the CompareString
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String1 |
Yes |
This Keyword takes value in Operand 1 |
String2 |
Yes |
This keyword takes Value in Operand 2 |
Ignore Case |
Not Mandatory |
This Keyword takes Value in Ignore Case. |
Output
True or False |
If the keyword passes successfully |
Example
If you want to compare the two strings, this is how you will use this keyword.
CompareString
String1 |
<18> |
Output2 |
<18> |
IsEqual
This keyword is used to verify whether the given Values are Equal or not.
It returns True if the two given Integers are Equal. It takes String1 & String2 as input parameter.
For example, you want to verify the IsEqual.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
Operand1 |
Yes |
This Keyword takes value in Operand 1 |
Operand2 |
Yes |
This keyword takes Value in Operand 2 |
Output
True or False |
If the keyword passes successfully |
Example
If you want to verify that both the operands value are equal or not.
IsEqual
Operand1 |
<18> |
Operand2 |
<18> |
IsGreater
This keyword is used to verify whether the First Operand Value is Greater than the second One. It returns True if First specified integer value is greater than second one. It takes String1 & String2 as input parameter.
For example, you want to verify the IsGreater.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
Operand1 |
Yes |
This Keyword takes value in Operand 1 |
Operand2 |
Yes |
This keyword takes Value in Operand 2 |
Output
True or False |
If the keyword passes successfully |
Example
If you want to verify that the first operand value is greater than the second one, here is how you will use this keyword.
IsGreater
Operand1 |
<18> |
Operand2 |
<11> |
IsNotEqual
This keyword verifies that the specified Operands are not equal. It returns true if the given strings are not equal. It takes String1 & String2 as input parameter.
For example, you want to verify the IsNotEqual.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
Operand1 |
Yes |
This Keyword takes value in Operand 1 |
Operand2 |
Yes |
This keyword takes Value in Operand 2 |
Output
True or False |
If the keyword passes successfully |
Example
If you want to verify that the first operand value is not equal to the second operand value, here is how you will use this keyword.
IsNotEqual
Operand1 |
<8> |
Operand2 |
<11> |
IsSmaller
This keyword verifies that the first string value is smaller than the second one or not.
It is mostly used in situations where you want to verify that the first value present in string is smaller or not.
For example, you want to verify the IsSmaller.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
Operand1 |
Yes |
This Keyword takes value in String1 |
Operand2 |
Yes |
This keyword takes Value in String2 |
Output
True or False |
If the keyword passes successfully |
Example
If you want to verify that the first operand is smaller as compared to the second one, here is how you will use this keyword.
IsSmaller
Operand1 |
<8> |
Operand2 |
<11> |
StringContains
This keyword verifies the sub String into the Specified String. It is mostly used in situations where you want to verify that the sub string is the part of string or not.
For example, you want to verify the sub string.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String1 |
Yes |
This Keyword takes value in String1 |
String2 |
Yes |
This keyword takes Value in String2 |
Output
True/False |
If the keyword passes successfully |
Example
If you want to verify that the sub string is the part of string or not, here is how you will use this keyword.
StringContains
String1 |
Selenium is the Test Automation
|
Output2 |
Automation
|
VerifyValueInProcedure
This keyword is used to validate the value returned in the result when a procedure is executed. It takes Value, Procedure Name, Parameter Name, Parameter Value as data input arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Value |
Yes |
Specify the Value returned from the Procedure. |
Procedure Name | Yes | Specify the Procedure Name. |
Param Name | Yes | Specify the Name of the parameter |
Param Value | Yes | Specify the Value of the parameter |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
Let us consider the Following Procedure in MySQL
If you want to validate the value returned in the result when a procedure is executed, you can do so by using VerifyValueInProcedure keyword as follows:
VerifyValueInProcedure
Value |
1000000130 |
Procedure Name |
Proc |
Param Name | @input1 |
Param Value | SchemaVersion |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
If no Data Input Argument is provided |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have been provided a value. |
When Invalid Data Input Arguments are provided |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Data Not Provided |
VerifyValueInRecordSet
This keyword is used to match the specified value with actual value available in database. It takes a value and database query as data input arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Value |
Yes |
Specify the Value to be verified |
Query | Yes | Specify the Query. |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
Consider the screenshot above of a table, if you want to validate the value in the Record Set, you can do so by using VerifyValueInRecordSet keyword as follows:
VerifyValueInRecordSet
Value |
49 |
Query |
select * from main_settings; |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When invalid Data Input Arguments are provided. Value: 4 5464 |
Unable to verify value no- 45564 record found |
|
When Blank Data Input Arguments are passed |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value. |
Clipboard Keywords
CopyToClipBoard
This keyword copies data to clipboard. It takes CopyString as input parameter. It is mostly used in situations where you want to copy some data from opkey and paste it to a text file (example: notepad, word, etc).
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required |
Data Input Arguments |
Required? |
Description |
CopyString |
Yes |
Provide copy string Note: Give the string value which needs to be copied. |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
If you use this keyword and give the value in CopyString and then execute it. When execution is complete, open notepad (or Word, etc.) and paste it. It will paste the string given in data input argument of the keyword.
Error conditions
Condition |
Message |
Debug Info |
If no value is given in Data Input Arguments |
Argument Data Missing |
Copy argument string is missing |
Conversion Keywords
ConvertToBoolean
This keyword converts the Input value to boolean. It takes input value as input parameter.
It is mostly used in situations where you want to convert value into Boolean.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required |
Data Input Arguments |
Required? |
Description |
Input Value |
Yes |
Specify the Input Value. Note: Give the valid values (Value can be String, Integer, Boolean or Double) |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
Here, you can use this keyword to convert String (or Integer or Boolean or Double) value of DataType into Boolean and the output will be True/False.
Error conditions
Condition |
Message |
Debug Info |
If invalid values are provided |
Argument Data Invalid |
Conversion from string “hello123.235uyrt^&%^&” to type ‘Boolean’ is not valid. |
ConvertToDateTime
This keyword converts the string of specified format to DateTime. It takes SourceString & SourceFormat as input parameter. This keyword is mostly used in situations where you want to convert value into DateTime.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required |
Data Input Arguments |
Required? |
Description |
SourceString |
Yes |
A String which contains the Date. Note: Give the valid values (Value can be String, Integer, Boolean or Double) |
SourceFormat |
Yes |
The Format used in the Source String (eg dd/mm/yy). |
Output
If the value provided is correct then the output will be in Date Time format otherwise it will display no value.
Example
Here, you can use this keyword to convert String value of DataType into DateTime format and the output will be in Date Time.
Error conditions
Condition |
Message |
Debug Info |
If invalid values are provided |
Argument Data Invalid |
String was not recognized as a valid DateTime. |
ConvertToDouble
This keyword converts the Input value to double. It takes Input Value & Precision as input parameter.
It is mostly used in situations where you want to convert value in Double, ie. in decimal format.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required |
Data Input Arguments |
Required? |
Description |
Input Value |
Yes |
Specify the Input Value. Note: Give the integer value. |
Precision |
Yes |
Specify the number of fractional digits in the return value. Note: Give the integer value. |
Output
If the value provided is correct then the output will be in Double otherwise it will display no value.
Example
Here, you can use this keyword to convert Integer value of DataType into Double and the output will be in Decimal format.
Error conditions
Condition |
Message |
Debug Info |
If invalid values are provided |
Argument Data Invalid |
Conversion from string “hello.mnnb” to type ‘Double’ is not valid. |
ConvertToInteger
This keyword converts the Input value to integer. It takes Input Value & RoundOff as input parameter.
It is mostly used in situations where you want to convert value in Integer.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required. |
Data Input Arguments |
Required? |
Description |
Input Value |
Yes |
Specify the Input Value. Note: Give the integer value. |
RoundOff |
Yes |
Specify whether roundoff the input value or not. |
Output
If the value provided is correct then the output will be in Integer otherwise it will display no value.
Example
Here, you can use this keyword to convert Integer (or Double) value of DataType into Integer and the output will be in Integer format.
Error conditions
Condition |
Message |
Debug Info |
If invalid values are provided |
Argument Data Invalid |
Conversion from string “hello” to type ‘Integer’ is not valid. |
ConvertToString
This keyword converts the Input value to string. It takes Input Value as input parameter.
It is mostly used in situations where you want to convert value in String.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required. |
Data Input Arguments |
Required? |
Description |
Input Value |
Yes |
Specify the Input Value. Note: Give the integer value. |
Output
If the value provided is correct then the output will be String.
Example
Here, you can use this keyword to convert String (or Integer or Boolean or Double) value of DataType into String and the output will be in String format.
Note: No error condition available for this keyword.
Database Keywords
ConnectDatabase
This keyword is used to Connect to a Database. It takes database Driver Name and connection string as data input arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Driver |
Yes |
Specify the Driver Name. Example: MySQL :- MySQL Oracle :- Oracle SQLSERVER :System.Data.SQlClient SQLLite :Sqlite |
Connection String | Yes | Specify the Connection String required to connect to the database. |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to connect to a database , you can do so by using ConnectDataBase keyword as follows:
ConnectDataBase
Driver |
< Specify the Driver Name > Here, mysql |
Connection String |
server=localhost;uid=root;pwd=root; database= mydatabase; < Here, Database Name= mydatabase > |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When Invalid data arguments are provided. |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Data Not Provided |
When no data input arguments are provided |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value. |
DisconnectDatabase
This keyword is used to disconnect from a Database. It does not take any input arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
No |
No |
This keyword doesn’t take any data input argument. |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to disconnect from a DataBase, you can do so by using Disconnect DataBase keyword. Before using Disconnect DataBase keyword, It is mandatory to successfully connect to the DataBase.
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When DataBase has never been connected |
Unsatisfied Dependencies (-14200) DESCRIPTION: Some dependency was required but could not be located or loaded. Mostly the dependencies are binaries in form of jar/exe/dll, but others are also possible. They could be network resources like databases, DCOM servers, RMI targets, web services etc. |
Currently the connection with DataBase is not present |
ExecuteQuery
This keyword is used to execute a Database query. It takes Query as Data Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Query |
Yes |
Specify the Database Query |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to execute a DataBase Query, you can do so by using ExecuteQuery keyword as follows:
ExecuteQuery
Query |
Select * from main_settings; |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When Blank Data Input Argument is provided. |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value. |
When Invalid Data Input Argument is provided. |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
CresTech.OpKey.Exceptions. MalformedQueryException: Unable to execute query. Possibly syntax error or insufficient parameters. |
FetchAllRecordsFromDatabase
This keyword is used to fetch a @:@:@:@ separated recordset database. It takes database Query as data input argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Query |
Yes |
Specify the Database Query. |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to fetch a @:@:@:@ separated recordset database, you can do so by using FetchAllRecordsFromDataBase keyword as follows:
FetchAllRecordsFromDatabase
Query |
select * from main_settings; |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When Invalid data arguments are provided. |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
CresTech.OpKey. Exceptions. MalformedQuery Exception: Unable to execute query. Possibly syntax error or insufficient parameters. |
When no data input arguments are provided |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value. |
FetchRecordSetFromDatabase
This keyword is used to fetch a #:#:#:# separated recordset database. It takes database Query as data input argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Query |
Yes |
Specify the Database Query. |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to fetch a #:#:#:# separated recordset database, you can do so by using FetchRecordSetFromDataBase keyword as follows:
FetchRecordSetFromDataBase
Query |
select * from main_settings; |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When Invalid data arguments are provided. |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
CresTech.OpKey. Exceptions. MalformedQuery Exception: Unable to execute query. Possibly syntax error or insufficient parameters. |
When no data input arguments are provided |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value. |
FetchValueFromDatabase
This keyword is used to fetch a single value from database. It takes Query as Data Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Query |
Yes |
Specify the Database Query |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to fetch to fetch a single value from database, you can do so by using FetchValueFromDataBase keyword as follows:
FetchValueFromDatabase
Query |
select * from main_settings; |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When Invalid data arguments are provided. |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
CresTech.OpKey. Exceptions. MalformedQuery Exception: Unable to execute query. Possibly syntax error or insufficient parameters. |
When no data input arguments are provided |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value. |
FetchValueFromProcedure
This keyword is used to fetch single value from a procedure. It takes Procedure Name, Param Name, Param Value as data Input Arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Value |
Yes |
Specify the Value returned from the Procedure. |
Procedure Name | Yes | Specify the Procedure Name. |
Param Name | Yes | Specify the Name of the parameter |
Param Value | Yes | Specify the Value of the parameter |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
Let us consider the Following Procedure in MySQL
If you want to to fetch single value from a procedure, you can do so by using FetchValueFromProcedure keyword as follows:
FetchValueFromProcedure
Value |
1000000130 |
Procedure Name |
Proc |
Param Name | @input1 |
Param Value | SchemaVersion |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
If no Data Input Argument is provided |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have been provided a value. |
When Invalid Data Input Arguments are provided |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Data Not Provided |
GetColumnCountOfRecordSet
This keyword is used to fetch the number of columns of a recordset. It takes Query as Data Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Query |
Yes |
Specify the Database Query |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to fetch the number of columns of a recordset, you can do so by using GetColumnCountOfRecordSet keyword as follows:
GetColumnCountOfRecordSet
Query |
select * from main_settings; |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When Invalid data arguments are provided. |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
CresTech.OpKey. Exceptions. MalformedQuery Exception: Unable to execute query. Possibly syntax error or insufficient parameters. |
When no data input arguments are provided |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value. |
GetRowCountOfRecordSet
This keyword is used to fetch the number of rows of a recordset. It takes Query as Data Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Query |
Yes |
Specify the Database Query |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to fetch the number of rows of a recordset, you can do so by using GetRowCountOfRecordSet keyword as follows:
GetRowCountofRecordSet
Query |
select * from main_settings; |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When Invalid data arguments are provided. |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
CresTech.OpKey. Exceptions. MalformedQuery Exception: Unable to execute query. Possibly syntax error or insufficient parameters. |
When no data input arguments are provided |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value. |
UpdateDatabase
This keyword is used to execute update query in database. It takes a query as data input argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Query |
Yes |
Specify the Database Query |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to update query in database, you can do so by using UpdateDataBase keyword as follows:
UpdateDatabase
Query |
update main_settings set value=’130′ where Parameter_ID=’58faa9dd-d96f-4734-b7fc-6259d7c6718d’ and parameter=’SchemaVersion’; |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
When Invalid data arguments are provided |
Argument Data Invalid (-13300) DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
CresTech.OpKey. Exceptions. MalformedQuery Exception: Unable to execute query. Possibly syntax error or insufficient parameters. |
When no data input arguments are provided |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value. |
Date Time Keywords
ConvertTimeToTimeZone
This keyword converts the time from source to destination time zone with respect to time of our local system.
It is used in situations where you want to convert the time from source time zone to destination time zone and your working system is being configured in different time zone.
For Example: you want to change time from “India Standard Time”, to “US Eastern Standard Time”, you can use this keyword.
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Description |
SourceTime |
Yes |
Specify your required which you want to use for conversion. Note: This time will be available to you as per your local system. |
SourceTimeZone |
Yes |
Specify your Source Time Zone. Note: Note:All timezone are specified at “https://technet.microsoft.com /en-us/library/cc749073(v=ws.10).aspx”. |
DestinationTimeZone |
Yes |
Specify your Destination Time Zone, in which you want your output. Note: All timezone are specified at “https://technet.microsoft.com /en-us/library/cc749073(v=ws.10).aspx”. |
Output
Time according to destination time zone |
If provided time zone is of correct format. |
False |
If provided data input arguments are blank or have invalid format. |
Example
In the example above, if you want to get the time of US and your local system is configured in Indian time zone, then provide data input arguments.
Select source time from “SourceTime” argument, provide “SourceTimeZone” as “India Time Zone” and provide “DestinationTimeZone” as “US Eastern Standard Time”.
It will provide time of according to destination time zone in output. here is how you will use this keyword “ConvertTimeToTimeZone”.
SourceTime |
2/7/2017 12:00:00 AM |
SourceTimeZone |
India Time Zone |
DestinationTimeZone |
US Eastern Standard Time |
Note: Source time will be time of your system, and for getting name of time zones you can go to this link” https://technet.microsoft.com/en-us/library/cc749073(v=ws.10).aspx.
Error conditions
Condition |
Message |
Debug Info |
If specified timezone is blank. |
Argument Data Missing |
Timezone argument is missing. |
If specified timezone is invalid. |
Argument Data Invalid |
The time zone ID ‘US’ was not found on the local computer |
GetTimeAtTimeZone
This keyword provides the time of specified time zone with respect to time of our local system. It is used in situations where you want to get the time of different time zone and your working system is being configured in different time zone.
For Example: your working system is configured in “India Standard Time”, but you want to see time in “US Eastern Standard Time”.
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Description |
Timezone |
Yes |
Specify the time zone in which you want to get your output. Note: All timezone are specified at “https://technet.microsoft.com/ en-us/library/cc749073(v=ws.10).aspx”. |
Output
Time of specified timezone |
If provided time zone is of correct format. |
False |
If timezone provided is blank or have invalid format. |
Example
In the example above, if you want to get the time of US, then provide it in data input argument“timezone” as “US Eastern Standard Time” and it will provide time of specified time zone. here is how you will use this keyword “GetTimeAtTimeZone”.
TimeZone |
Provide correct time zone |
Note: Source time will be time of your system, and for getting name of time zones you can go to this link” https://technet.microsoft.com/en-us/library/cc749073(v=ws.10).aspx .
Error conditions
Condition |
Message |
Debug Info |
If specified timezone is blank. |
Argument Data Missing |
Timezone argument is missing. |
If specified timezone is invalid. |
Argument Data Invalid |
The time zone ID ‘US’ was not found on the local computer |
Date Time Keywords
AddDateTime
This keyword is used to add a specific amount of days, months, year, hours, mins and seconds in a given date value.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
Date Time Years Months Days Hours Minutes Seconds |
Yes Yes Yes Yes Yes Yes Yes |
Provide Date time Format Provide Years Provide Months Provide Days Provide Hours Provide Minutes Provide Second |
Output
It should give Date Time of current Day |
If the keyword passes successfully |
Positive Condition
Keyword Name |
Input |
Output |
Status |
AddDateTime |
DateTime : 2/15/2017 12:00:00 AM Years : 2 Months : 2 Days : 2 Hours : 2 Minutes : 2 Seconds : 2 |
4/17/2019 2:02:02 AM |
Pass |
Error conditions
Don’t Provide Input Argument
Input |
Output |
Status |
Error Message |
DateTime : Years : Months : Days : Hours : Minutes : Seconds : |
Fail |
Argument Data Missing |
ConvertDateTimeFormat
This keyword converts a dateTime value according to some specified format.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
DateTime:4/17/2019 2:02:02 AM FormatString:M/d/yyyy/m/h/s |
Yes |
Provide Date Time Provide Date time Format |
Output
It should give Converted date time as par Provided date time |
If the keyword passes successfully |
Positive Condition
Keyword Name |
Input |
Output |
Status |
ConvertDateTimeFormat |
DateTime: 4/17/2019 2:02:02 AM FormatString: M/d/yyyy/m/h/s |
4/17/2019/0/12/0 |
Pass |
Keyword Name |
Input |
Output |
Status |
ConvertDateTimeFormat |
DateTime: FormatString: |
False |
Fail |
Message: Argument Data Missing
DateTimeDifference
This keyword returns the date difference in total days.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
FirstDate |
Yes |
Give Date string For Example:2/15/2017,2-15-2017 |
Second Date |
Yes |
Give Date string For Example:2/15/2017,2-15-2017 |
Format |
Yes |
Give Date Format dd/MM/yyyy, dd-MM-yyyy |
Output
It should give Number of days difference. |
If the keyword passes successfully. |
Positive Condition
Keyword Name |
Input |
Output |
Status |
DateTimeDifference |
FirstDate:2/16/2017 SecondDate:2/16/2018 DateFormat:M/dd/yyyy |
365 |
Pass |
Error conditions
Provide Valid String and Invalid Format
Input |
Output |
Status |
Error Message |
FirstDate:2/16/2017 SecondDate:2/16/2018 DateFormat:MM-dd-yyyy |
Fail |
Argument Data Invalid |
Provide FirstDate, SecondDate but don’t Provide Format
Input |
Output |
Status |
Error Message |
FirstDate:2/16/2017 SecondDate:2/16/2018 DateFormat: |
365 |
Pass |
Done |
Don’t Provide Input Argument
Input |
Output |
Status |
Error Message |
FirstDate: SecondDate: DateFormat: |
Fail |
Argument Data Missing |
GetCurrentDateTime
This keyword is used to get Current Date Time of the system. It used in such a condition when user want to get current day Date Time.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
Input Argument |
No |
Output
It should give Date Time of current Day |
If the keyword passes successfully |
Positive Condition
Keyword Name |
Input |
Output |
Status |
GetCurrentDateTime |
No |
2/15/2017 7:43:19 PM |
Pass |
GetDayOfWeek
This Keyword is used to get the current week day number. It uses date on the basis of Date it gives the week number.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
Input Argument |
No |
Output
It should give Date Time of current Day. |
If the keyword passes successfully. |
Example
If user use this keyword on 14 of Feb then it gives the output as 2 and if user use this keyword on 15 of Feb then it gives the output as 3.
Positive Condition
Keyword Name |
Input |
Output |
Status |
GetDayOfWeek |
No |
3 |
Pass |
IsDate
This Keyword verifies that given format is date or not. It is used in such a condition where user want to verify provided date is date format or not.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
DateString |
Yes |
Give Date string For Example: 2/15/2017,2-15-2017 |
DateFormat |
Yes |
Give Date Format dd/MM/yyyy, dd-MM-yyyy |
Output
True |
If the keyword passes successfully |
Positive Condition
Keyword Name |
Input |
Output |
Status |
IsDate |
DateString: 2/15/2017 DateFormat: MM/dd/yyyy |
True |
Pass |
Error conditions
Provide Valid String and Invalid Format
Input |
Output |
Status |
Error Message |
DateString:2/15/2017 DateFormat:MM-dd-yyyy |
False |
Fail |
Argument Data Invalid |
Not Provide Input Argument
Input |
Output |
Status |
Error Message |
DateString:2/15/2017 DateFormat:MM-dd-yyyy |
False |
Fail |
Argument Data Missing |
SubtractDateTime
This keyword is used to Subtract Date Time a specific amount of days, months, year, hours, mins and secs in a given date value.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
Date Time Years Months Days Hours Minutes Seconds |
Yes Yes Yes Yes Yes Yes Yes |
Provide Date time Format Provide Years Provide Months Provide Days Provide Hours Provide Minutes Provide Second |
Output
It Should give Date time after subtraction of years, Months, Days, Hours, Minutes, Seconds |
If the keyword passes successfully |
Positive Condition
Keyword Name |
Input |
Output |
Status |
SubtractDateTime |
DateTime : 2/15/2017 12:00:00 AM Years : 2 Months : 2 Days : 2 Hours : 2 Minutes : 2 Seconds : 2 |
4/17/2019 2:02:02 AM |
Pass |
Error conditions
Don’t Provide Input Argument
Input |
Output |
Status |
Error Message |
DateTime : Years : Months : Days : Hours : Minutes : Seconds : |
Fail |
Argument Data Missing |
File Handling Keywords
AppendTextToFile
This keyword appends specified text to the given File. It used in such condition where user want to add Specific Text in file.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
FilePath |
Yes |
Give Path of File which is exist on system |
TextToAppend |
Yes |
Give Text which you want to add in File |
Output
True |
If the keyword passes successfully |
Positive Condition
Keyword Name |
Input |
Output |
Status |
AppendTextToFile |
FilePath: File path which exists TextToAppend:ABCD |
True |
Pass |
Error conditions
Don’t Provide FilePath or TextToAppend
Input |
Output |
Status |
Error Message |
FilePath: TextToAppend: |
False |
Fail |
Argument Data Missing |
Provide File path which does not exist.
Input |
Output |
Status |
Error Message |
FilePath: TextToAppend: |
Fail |
Argument Data Invalid |
CheckFileExists
This keyword is used to check whether the file exists or not.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
FilePath |
Yes |
Give Path of File which is exist on system |
Output
True |
If the keyword passes successfully |
Positive Condition
Keyword Name |
Input |
Output |
Status |
CheckFileExist |
FilePath:File path which exists |
True |
Pass |
Error conditions
Provide File path which does not Exist.
Input |
Output |
Status |
Error Message |
FilePath: File path which does not exist. |
False |
Fail |
Argument Data Invalid |
CopyFile
This Keyword is used to copy file from source to destination. It is in such a condition where user want to copy file from one location to another location.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Data Input Arguments |
Required? |
Description |
Source File Path: Destination Directory Path: Destination File Name: Overwrite: |
Yes Yes Yes Yes |
Provide File Path Provide Destination File Directory where you want to copy File Provide Destination File Name(with extension or Without Extension) If checked so Overwrite Existing file if not checked then not Overwrite Existing File |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Positive Condition
Keyword Name |
Input |
Output |
Status |
CopyFile |
SourceFilePath:C:UsersABCD.txt Destination Directory Path:C:UsersUserNameDesktop Destination File Name:EFGH Overwrite:True |
True |
Pass |
Error conditions
Don’t Provide Input Argument
Input |
Output |
Status |
Error Message |
Source File Path: Destination Directory Path: Destination File Name: Overwrite:False |
False |
Fail |
Argument Data Missing |
Provide Destination Directory Path and Destination File Name which is not Exist.
Input |
Output |
Status |
Error Message |
Source File Path:C:UsersABCD.txt Destination Directory Path:C:UsersUserNameD Destination File Name:IJKL Overwrite:False |
Fail |
Argument Data Invalid |
CreateFile
This keyword is used to Create a File at the given Path.
It is used when you want to create any File at any location and it takes the Directory Path, Filename and Overwrite (Y/N).
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
NO |
No Object Input Arguments is required. |
Data Input Arguments |
Required? |
Description |
DirectoryPath |
Yes |
Specify the Path where File has to be created. |
FileName |
Yes |
Specify the FileName from which name you want to Create File. |
Overwrite |
Yes |
Select the checkbox as True or False Note: If already any File with the same name exists at that location then you can Overwrite the file by selecting Checkbox. |
Output
True |
If the keyword passes successfully. |
False |
If there was an error. |
Blank |
If provide invalid path. |
Example
If we want to Create any file at any particular location like in D: in folder Create folder then use the Keyword Create File and give valid path in DirectoryPath, Specify name of File in FileName from which name you want to create file and if want Overwrite any File then select checkbox or deselect checkbox.
Createfile
Object |
< No Object Input Arguments is required. > |
DirectoryPath |
D:Create folder |
FileName |
Books |
Overwrite |
True |
Error conditions
Conditions |
Message |
Debug Information |
If provide Invalid Path |
< Argument Data Invalid (-13300) > |
System.ArgumentException: Please provide absolute path name at A.cdb4381.c7ad1535d27337 (String cdb7, String ca5989, Boolean c259643) in File681:line 218 |
If provide Null Path |
< Argument Data Missing (-13200) > |
One or more of the arguments have not been provided a value. |
If File Already Exist |
< Argument Data Invalid (-13300) > |
File Already Exist |
DeleteFile
This keyword is used to Delete a File from a location. This keyword is used when you want to delete any File from any location. It takes values in FilePath and deleteFilePermanently. If select deleteFilePermanently i.e. True then it will delete file permanently and if do not select deleteFilePermanently i.e. false then it will not delete file permanently.
File path can be provided as static value or through Global variable and Attachment in Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
No Object Input Arguments is required. |
Data Input Arguments |
Required? |
Description |
FilePath |
Yes |
Specify the Path from where File has to be deleted. |
DeleteFilePermanently |
Yes |
Select checkbox * True if want to delete file permanently * Deselect checkbox i.e. False if do not want to delete file permanently. |
Output
True |
If the keyword passes successfully. |
False |
If there was an error. |
Example
If we want to Delete any file from any particular location like in D: from folder “Create folder” then use the Keyword Delete File and give valid path in DirectoryPath and select check box in deletefilepermanently.
DeleteFile
Object |
< No Object Input Arguments is required.> |
FilePath |
D:Create folderbooks.txt |
deleteFilePermanently |
True |
Error conditions
Conditions |
Message |
Debug Information |
If provide Invalid Path |
< Argument Data Invalid (-13300) > |
Not a Valid Path. |
If provide Null Path |
< Argument Data Missing (-13200) > |
File Path argument is missing. |
If File doesn’t exist |
Argument Data Invalid (-13300) |
Not a Valid Path. |
GetCellValueFromExcel
This keyword is used to get the cell value of an excel file. It is used when you want to get cell value of an excel file. It takes ExcelFilepath, sheetName, rowNumber and columnNumber as input parameter. The File path should contain filename with .xls/.xlsx extension.
File path can be provided as static value or through Global variable and Attachment in Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
No Object Input Arguments is required. |
Data Input Arguments |
Required? |
Description |
ExcelFilepath |
Yes |
Specify the Path of file with csv extension from which you want to get value. |
sheetName |
Yes |
Specify the sheetname of Excel file. |
rownumber |
Yes |
Specify the Row number of the cell from where you want to get value. |
columnnumber |
Yes |
Specify the Column number of the cell from where you want to get value. |
Output
Value of Cell |
If the keyword passes successfully. |
False |
If there was an error. |
Example
If we want to get cell value from any particular Excel file “excel.xlsx” which is in folder Aishwarya in C: use this keyword as shown-
GetCellvaluefromExcel
Object |
< No Object Input Arguments is required.> |
ExcelFilepath |
C:Usersaishwaryaexcel.xlsx |
sheetName |
Sheet1 |
rowNumber |
1 |
columnNumber |
1 |
Error conditions
Conditions |
Message |
Debug Information |
If provide Invalid Path |
< Argument Data Invalid (-13300) > |
Sheet name sheet1 doesn’t exists. |
If provide Null Path |
< Argument Data Missing (-13200) > |
One or more of the arguments have not been provided a value |
If provide File which doesn’t exists |
Argument Data Invalid (-13300) |
Sorry, we couldn’t find C:UsersaishwaryaDesktopexcel.xls. Is it possible it was moved, renamed or deleted? |
If do not provide sheet name |
Argument Data Missing (-13200) |
One or more of the arguments have not been provided a value |
If provide invalid row and column number |
Argument Data Invalid (-13300) |
Invalid row or column |
GetFileExtension
This keyword is used to fetch the extension of any specified File. It is used when you want to get the file extension of any file and it takes Path of the specified file with extension as input parameter. File path can be provided as static value or through Global variable and Attachment in Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
No Object Input Arguments is required. |
Data Input Arguments |
Required? |
Description |
Path |
Yes |
Specify the Path of file with extension |
Output
Extension of file |
If the keyword passes successfully. |
False |
If there was an error. |
Example
If we want to get file extension of File test.html from C: then use the keyword GetFileExtension.
GetFileExtension
Object |
< No Object Input Arguments is required. > |
Path |
C:test.html |
It will get the Output “.html” i.e. extension of test.html file.
Error conditions
Conditions |
Message |
Debug Information |
If the provided path is without extension |
||
If provide Null Path |
< Argument Data Missing (-13200) > |
One or more of the arguments have not been provided a value. |
If provide path which do not exists |
Argument Data Invalid (-13300) |
System.IO.FileNotFoundException: Could not find a part of the path C:UsersaishwaryaDesktopdoc.doc File name: ‘C:UsersaishwaryaDesktopdoc.doc’ at A.cdb444caf4f5ad03e34dc7fb63812 7381.c1025fe81511a868364fbb0c6e 6f996b9(String c81276ea65115095562f9860658 a83374) in File681:line 257 |
GetFileName
This keyword is used to fetch the file name with extension of any specified File. It is used when you want to get the name of any file with extension and it takes Path of the specified file.
File path can be provided as static value or through Global variable and Attachment in Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
No Object Input Arguments is required. |
Data Input Arguments |
Required? |
Description |
Path |
Yes |
Specify the Path of file of which you want to get the filename with extension. |
Output
Name of file with extension |
If the keyword passes successfully. |
False |
If there was an error. |
Example
If we want to get filename with extension of File test.html from C: then use the keyword GetFileName
GetFileName
Object |
< No Object Input Arguments is required.> |
Path |
C:test.html |
It will get the Output “test.html” i.e. filename with extension of “test.html” file.
Error conditions
Conditions |
Message |
Debug Information |
If provide path without extension |
||
If provide Null Path |
< Argument Data Missing (-13200) > |
One or more of the arguments have not been provided a value. |
If file doesn’t exists |
Argument Data Invalid (-13300) |
System.IO.FileNotFoundException: Could not find a part of the path C:UsersADesktopdoc.doc File name: ‘C:UsersaishwaryaDesktopdoc.doc’ at A.cdb444caf4f5ad03e34dc7fb 638127381.c71b75821a828d689d c331e07040f3abb(String c81276ea65115095562f9860658a 83374) in File681:line 14 |
GetFileNameWithoutExtension
This keyword is used to fetch the file name without extension of any specified File. It is used when you want to get the name of any file without extension and it takes Path of the specified file.
File path can be provided as static value or through Global variable and Attachment in Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
No Object Input Arguments is required. |
Data Input Arguments |
Required? |
Description |
Path |
Yes |
Specify the Path of file of which you want to get the filename. |
Output
Name of file |
If the keyword passes successfully. |
False |
If there was an error. |
Example
If we want to get filename of File test.html from C: then use the keyword GetFileNamewithoutExtension.
GetFileNamewithoutExtension
Object |
< No Object Input Arguments is required.> |
Path |
C:test.html |
It will get the Output “test” i.e. filename of “test.html” file.
Error conditions
Conditions |
Message |
Debug Information |
If provide path without extension |
||
If provide Null Path |
< Argument Data Missing (-13200) > |
One or more of the arguments have not been provided a value. |
If provide file which do not exists |
Argument Data Invalid (-13300) |
System.IO.FileNotFoundException: Could not find a part of the path C:UsersaishwaryaDesktopdoc.doc File name: ‘C:UsersaishwaryaDesktopdoc.doc’ at A.cdb444caf4f5ad03e34dc7fb6381 27381 .c79f01309a5b360dea40b4a5ce9fa 05dc (String c81276ea65115095562f9860658 a83374) in File681:line 196 |
GetFilePath
This keyword is used to fetch the path of the specified File. This keyword is used when you want to get the path of any file and it takes the specified file. File path can be provided as static value or through Global variable and Attachment in Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
No Object Input Arguments is required. |
Data Input Arguments |
Required? |
Description |
Path |
Yes |
Select the file. |
Output
Path |
If the keyword passes successfully. |
False |
If there was an error. |
Example
If we want to get the Path of File OpKey.txt from C: then use the keyword as shown-
GetFileSize
Object |
< No Object Input Arguments is required. > |
Path |
C:UsersabcAppDataLocalAttachmentsOpKey.txt |
It will return the Output “C:UsersabcAppDataLocalAttachmentsOpKey.txt” i.e. file path of “OpKey.txt” file.
Error conditions
Conditions |
Message |
Debug Information |
If No file is provided |
< Argument Data Missing (-13200) > |
One or more of the arguments have not been provided a value. |
GetFileSize
This keyword is used to fetch the file size of any specified File. It is used when you want to get the size of any file and it takes Path of the specified file. File path can be provided as static value or through Global variable and Attachment in Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
No Object Input Arguments is required. |
Data Input Arguments |
Required? |
Description |
Path |
Yes |
Specify the Path of file of which you want to get the size. |
Output
Size of file |
If the keyword passes successfully. |
False |
If there was an error. |
Example
If we want to Get Size of File test.html from C: then use the keyword as shown-
GetFileSize
Object |
< No Object Input Arguments is required.> |
Path |
C:test.html |
It will get the Output “563KB” i.e. file size of “test.html” file.
Error conditions
Conditions |
Message |
Debug Information |
If provide Null Path |
< Argument Data Missing (-13200) > |
One or more of the arguments have not been provided a value. |
If file doesn’t exists |
Argument Data Invalid (-13300) |
System.IO.FileNotFoundException: Could not find a part of the path C:UsersNew Text Document File name: ‘C:UsersText Document’ at A.cdb4 in File681:line 174 |
GetValueFromCSV
This keyword is used to get value from a CSV file. It is used when you want to get value of any CSV file. It takes CSVFilepath, rowNumber and columnNumber as input parameter. The File path should contain filename with .csv extension.
File path can be provided as static value or through Global variable and Attachment in Input Argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
No Object Input Arguments is required. |
Data Input Arguments |
Required? |
Description |
CsvFilepath |
Yes |
Specify the Path of file with csv extension from which you want to get value. |
rownumber |
Yes |
Specify the Row number from where you want to get value. |
columnnumber |
Yes |
Specify the Column number from where you want to get value. |
Output
Value of CSV File |
If the keyword passes successfully. |
False |
If there was an error. |
Example
If we want to get value from any particular CSV file “._FL_insurance_sample.csv” which is in Folder ‘aishwarya’ in C: then use keyword as shown-
GetvaluefromCSV
Object |
< No Object Input Arguments is required.> |
CSVFilePath |
C:Usersaishwarya._FL_insurance_sample.csv |
rownumber |
1 |
columnnumber |
1 |
Error conditions
Conditions |
Message |
Debug Information |
If provide Invalid Path |
< Argument Data Invalid (-13300) > |
CSVFile path should contain file name with .csv extension |
If provide Null Path |
< Argument Data Missing (-13200) > |
File Path argument is missing. |
If Given File doesn’t exists |
Argument Data Invalid (-13300) |
File not found ‘C:UsersUsername Desktop._FL_insurance_sample.csv’ |
If provide invalid row and column |
Argument Data Invalid (-13300) |
Minimum value for Row and Column is 1 |
ReadTextFile
This keyword is used to read a given file (File path should contain the file name with .txt file extension). It takes FilePath as data input argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
File Path |
Yes |
Provide the full file path. Note: File must have .txt extension. |
Output
Mapped file having .txt file extension |
If the keyword passes successfully |
Mapped file having other than .txt file extension. |
If an error is there |
Example
This keyword is mostly used in situations where you want to read text written in the given text file.
Common Error conditions
Scenarios |
Error Message |
Debug Information |
If mapped file have other than .txt file extension |
Argument Data Invalid |
Given file is not a txt file |
RenameFile
This keyword is used to rename a specified file. It takes FilePath and NewFileName as data input arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
File Path |
Yes |
Provide the full file path. |
NewFilename | Yes | Provide the New File Name |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
This keyword is mostly used in situations where you want to read text written in the given text file.
Common Error conditions
Scenarios |
Error Message |
Debug Information |
Given file path doesn’t exist |
Argument Data Invalid |
Not a valid file path |
File path and New File name Not Given | Argument Data Missing (-13200) | One or more of the arguments have not been provided a value. |
SearchTextInFile
This keyword is used for searching a particular text written on the selected file. It takes FilePath, SearchString and IgnoreCase (T/F) as input parameters.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required |
Data Input Arguments |
Required? |
Description |
Input Value |
Yes |
This keyword requires the following data arguments as input: FilePath: It takes file’s path with extension “.txt” (e.g.: “D:EXECUTION TEST FILEText file.txt”) SearchString: This field takes the string to be searched in the specified file. It takes “String” value as input. (e.g. : “opkey”) IgnoreCase: Setting this option “True” or “False” decides whether case sensitivity is to be considered while searching string. It takes “Boolean” input. |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
For example, you want to search a text “opkey” in a file on filepath “D:EXECUTION TEST FILEText file.txt” of your PC. Then you can use this keyword for searching it.
Error conditions
Condition |
Message |
Debug Info |
Valid Data FilePath: D:EXECUTION TEST FILEDocFile.doc SearchString: opkey IgnoreCase: True |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Given file is not a txt file |
Valid Data FilePath: d-195Text file.txt (Location not accessible) SearchString: opkey IgnoreCase: True |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Not a valid file path |
Invalid Data FilePath: D:EXECUTION TEST FILE SearchString: OPKEY IgnoreCase: True |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Not a valid file path |
Blank Data FilePath: (Blank) SearchString: (Blank) IgnoreCase: False |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value |
SetCellValueToExcel
This keyword sets the value in a given excel file where starting row and column indexes are “1”. It takes “ExcelFilePath”, “Sheetname”, “rownumber”, “columnnumber” and “Value to set” as input parameters. Using this keyword you can set value to “.xls” or “.xlsx” extension type files only.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required |
Data Input Arguments |
Required? |
Description |
Input Value |
Yes |
Required This keyword requires the following data arguments as input: ExcelFilePath: It takes the excel file’s path with extension “.xls” or “.xlsx” (e.g. “D:ExcelFile.xls” or “D:ExcelFile.xlsx”) SheetName: Specified excel’s sheet name on which modification is to be done. It takes “String” value as input. (e.g. : “Sheet1”) rowNumber: Row ID of excel file starting with index 1. It takes “Integer” value as input. (e.g. “2”) columnNumber: Column ID of excel file starting with index 1. It takes “Integer” value as input. (e.g. “2”) Value to set: It takes value which is to be set. It takes “String” value as input. |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
For example, you want to set a cell value (say “opkey”) to an excel file at runtime, then here is how you can use this keyword in your testcase.
Error conditions
Condition |
Message |
Debug Info |
Invalid Data ExcelFilePath: D:ExcelFile.xlsx SheetName: Sheet1 rowNumber: 0 columnNumber: 0 Value to set: opkey |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Minimum value for Row or Column is 1 |
Invalid Data ExcelFilePath: D: SheetName: Sheet1 rowNumber: 2 columnNumber: 2 Value to set: opkey |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
The file could not be accessed. Try one of the following:
• Make sure the specified folder exists. • Make sure the folder that contains the file is not read-only. • Make sure the file name does not contain any of the following characters: < > ? [ ] : | or * • Make sure the file/path name doesn’t contain more than 218 characters.-One or more of the arguments have not been provided a valid value |
Invalid Data ExcelFilePath: D:ExcelFile.xlsx SheetName: Sheet5 rowNumber: 2 columnNumber: 2 Value to set: opkey |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Sheet name Sheet5 doesn’t exists |
Blank Data ExcelFilePath: (Blank) SheetName: (Blank) rowNumber: (Blank columnNumber: (Blank) Value to set: (Blank) |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value |
SetValueToCSV
This keyword is used for updating value in a CSV file where the starting row and column indexes are “1”. It takes “CSVFilePath”, “rownumber”, “columnnumber” and “Value to set” as input parameters. Using this keyword you can set value to “.csv” extension type files.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required. |
Data Input Arguments |
Required? |
Description |
Input Value |
Yes |
Required This keyword requires the following data arguments as input: CSVFilePath: It takes the CSV file’s path with extension “.csv” (e.g. “D:EXECUTION TEST FILECSVFile.csv”) rowNumber: Row ID of CSV file starting with index 1. It takes “Integer” value as input. (e.g. “2”) columnNumber: Column ID of CSV file starting with index 1. It takes “Integer” value as input. (e.g. “2”) Value to set: It takes value which is to be set. It takes “String” value as input. |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
For example, you want to set a value (say “opkey”) to a CSV file at runtime, then here is how you can use this keyword for the same.
Error conditions
Condition |
Message |
Debug Info |
Invalid Data CSVFilePath: D: rowNumber: 2 columnNumber: 2 Value to set: opkey |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
File not found at D: |
Blank Data CSVFilePath: (Blank) rowNumber: 2 columnNumber: 2 Value to set: opkey |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value |
Blank Data CSVFilePath: (Blank) rowNumber: (Blank) columnNumber: (Blank) Value to set: (Blank) |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value |
Function Keywords
CustomizeObject
This keyword is used to update/customize the properties of the specified object so that execution can be performed on the object even when properties are changed. It takes Property1, Value1, IsRegEx1, Property2, Value2, IsRegEx2, etc.
This keyword is used to update the object properties. It takes object input argument and data input argument.
Input Arguments
This keyword does not require any Object Input argument.
Data Input Arguments |
Data Required |
Description |
Property1 |
Yes |
Specify the property name of the mapped object. |
Value1 |
Yes |
Specify the customized value of the property. |
IsRegEx1 |
Boolean (True/False) |
Specify the IsRegEx value (True/False). |
Output
True |
If keyword passes successfully |
False |
If there is an error |
Example
If you want to get the cell value of the specified Shared Global DR, here is how you will use this keyword-
-
Add CustomizeObject.
-
Map Object.
-
Provide Data Input Argument (Property1, Value1 & IsRegEx1) values.
-
Similarly, provide Data Input Argument values for other object properties to be customized.
Error conditions
Conditions |
Message |
Debug Info |
Object Not Given |
Argument Data Missing |
Data not provided for argument: ‘Object’. Expected StaticValue was empty. |
GetAllErrorsInSuite
This keyword is used to generate a status file for all errors occurred while executing a suite. It takes DirectoryPath and Snap (T/F) as input parameters. As this is a system keyword, there is no need for any plugin to be selected while executing this keyword.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required. |
Data Input Arguments |
Required? |
Description |
Input Value |
Yes |
Required This keyword requires one data argument as input: Directory Path: This argument takes path of directory where the error file for failed steps is to be generated. (e.g.: “D:ExecutionErrors”) Snap(True/False): Setting this option “True” or “False” generates snapshot for the failed steps at the specified directory. It takes “Boolean” input. |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
For example, you want to set a value (say “opkey”) to a CSV file at runtime, then here is how you can use this keyword for the same.
Error conditions
Condition |
Message |
Debug Info |
Invalid Data DirectoryPath: ExecutionErrors Snap(True/False): False |
||
Invalid Data: DirectoryPath: ctnl0037ExecutionErrors (Location not accessible) Snap(True/False): False |
||
Blank Data DirectoryPath: (Blank) Snap(True/False): False |
GetElementsCountByXpath
This keyword is used to count the a particular element from the specified XML. It takes FilePath or XML & Xpath as data input argument.
Input Arguments
This keyword does not require any Object Input argument.
Data Input Arguments |
Data Required |
Description |
FilePath or XML |
Yes |
Specify the XML or map XML File. |
Xpath |
Yes |
Specify the Xpath of the elements to be counted. |
Output
Element Value |
If keyword passes successfully |
0 |
If there is an error |
Example
If you want to get the cell value of the specified Shared Global DR, here is how you will use this keyword-
-
Add GetElementsCountByXpath.
-
Provide Data Input Argument (FilePath or XML & Xpath) values.
Error conditions
Conditions |
Message |
Debug Info |
Invalid File path or XML and Invalid Xpath are given. |
Argument Data Invalid (-13300) |
Data at the root level is invalid. Line1, position1. |
No File path or XML & Xpath are given. |
Argument Data Missing (-13200) |
One or more of the arguments have not been provided a value. |
GetExecutionStatus
This keyword is used for generating a status file for all suite steps at runtime. It takes Directory Path as input parameter. This keyword is mostly used when user needs an execution status for a suite.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required. |
Data Input Arguments |
Required? |
Description |
Input Value |
Yes |
Required This keyword requires one data argument as input: Directory Path: It takes path of directory where status file for all suite steps is to be generated. (e.g.: “D:ExecutionStatus”) |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
For example, you want to generate a status file for the all the suite steps at runtime, then you can use this keyword for the same.
Error conditions
Condition |
Message |
Debug Info |
Invalid Data: DirectoryPath: XYZ123@!# |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
Directory Path not found |
Invalid Data: DirectoryPath: ctnl0037Executionstatus (Location not accessible) |
||
Blank Data DirectoryPath: (Blank) |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
Directory path can’t be blan |
GetScreenHeight
This keyword is used to retrieve the height of the Screen at runtime. This keyword does not need any input arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required. |
Data Input Arguments |
Required? |
Description |
Data Input |
No |
Not required. |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
For example, you want to get the height of screen at runtime, then here is how you can use this keyword for the same.
GetScreenWidth
This keyword is used to retrieve the width of Screen at runtime. It does not need any input arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required. |
Data Input Arguments |
Required? |
Description |
Data Input |
No |
Not required. |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
For example, you want to get the height of screen at runtime, then here is how you can use this keyword for the same.
GeSystemIPAddresst
This keyword is used to retrieve the current IP Address of the system at runtime. It does not need any input arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
Not required. |
Data Input Arguments |
Required? |
Description |
Data Input |
No |
Not required. |
Output
True |
If the keyword passes successfully |
False |
If there was an error |
Example
For example, you want to find your system’s IP Address at runtime, then here is how you can use this keyword for the same.
GetValueFromJson
This keyword is used to retrieve the parsed value of Json. User need to provide the Json value and its path as input parameter.
NOTE: This keyword can be tested through another way i.e. Rest services of Service Repository.
Input Arguments
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Description |
Json |
Yes |
Provide the Json value as data input argument. |
Json Path |
Yes |
Provide Json path as data input argument. |
Output
True |
If the keyword passes successfully |
False or |
If there is an error |
Example
In the above example, if you want to fetch the value of city from above specified Json data “city” : “Nara” then provide Json path: “$.address.city” in this way you use this keyword.
GetValueFromJson
Json |
< Provide Json value as data input argument> |
Json Path |
Provide Json path as data input argument> |
Error conditions
Condition |
Message |
Debug Info |
If user provide Json value and don’t provide the path. |
Argument Data Missing (-13200) |
Value cannot be Null. |
If user provide null Json value and null Json path. |
Argument Data Missing (-13200) |
One or more of the arguments have not been provided a value. |
GetValueFromXpath
This keyword is used to is used to retrieve the value from given xml xpath i.e. an xml file should have a file path. In this keyword, it takes three input parameters i.e. file path or xml file, Xpath and delimitby.
It is mostly used in situations where you need to get the value of Xpath from xml file. In this keyword user can provide the file path of XML with its extension or he can directly give the XML in data input argument then he needs to provide the Xpath of XML path.
NOTE 1: “DelimitedBy” it’s an optional part and it is used to get two or more than two values from Xpath and values can be separated by anything like comma( , ), semi-colon (: ), etc..
NOTE 2: There is another way to use this keyword i.e. through Service Repository by adding Soap Services.
Input Arguments:
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Description |
FilePathOrXML |
Yes |
Provide the FilePathOrXML, Xpath and DelimitedBy as data input argument. NOTE: User can also provide the Full XML or file path in data input argument. |
Xpath |
Yes |
Provide Xpath as data input argument. |
DelimitedBy |
Yes |
Provide DelimitedBy as data input argument. NOTE: As DelimitedBy it is an optional part. |
Output:
True |
If the keyword passes successfully |
False |
If there was an error |
Example
This keyword is used to get the value from given xml xpath i.e. an xml file should have a file path. In this keyword, it takes three input parameters i.e. file path or xml file, Xpath and delimitby.
It is mostly used in situations where you need to get the value of Xpath from xml file. In this keyword user can provide the file path of XML with its extension or he can directly give the XML in data input argument then he needs to provide the Xpath of XML path.
NOTE 1: “DelimitedBy” it’s an optional part and it is used to get two or more than two values from Xpath and values can be separated by anything like comma( , ), semi-colon (: ), etc..
NOTE 2: There is another way to use this keyword i.e. through Service Repository by adding Soap Services.
In the above example, if you want to fetch the xpath value then provide this XML and give Xpath i.e. “Prompt” and value is provided in its output in this way he can use this keyword.
GetValueFromXpath
FilePathOrXML |
< Provide FilePathOrXML as data input argument> |
Xpath |
Provide Xpath as data input argument> |
DelimitedBy |
ProvideDelimitedBy as data input argument> |
Error conditions
Condition |
Message |
Debug Info |
If user don’t provide FilePathOrXML, Xpath and DelimitedBy. |
Argument Data Missing (-13200) |
One or more of the arguments have not been provided a value. |
In the above example, if you want to fetch the xpath value then provide this XML and give Xpath i.e. “Prompt” and value is provided in its output in this way he can use this keyword.
GetValueFromXpath
FilePathOrXML |
< Provide FilePathOrXML as data input argument> |
Xpath |
Provide Xpath as data input argument> |
DelimitedBy |
ProvideDelimitedBy as data input argument> |
Error conditions
Condition |
Message |
Debug Info |
If user don’t provide FilePathOrXML, Xpath and DelimitedBy. |
Argument Data Missing (-13200) |
One or more of the arguments have not been provided a value. |
In the above example, if you want to fetch the xpath value then provide this XML and give Xpath i.e. “Prompt” and value is provided in its output in this way he can use this keyword.
GetValueFromXpath
FilePathOrXML |
< Provide FilePathOrXML as data input argument> |
Xpath |
Provide Xpath as data input argument> |
DelimitedBy |
ProvideDelimitedBy as data input argument> |
Error conditions
Condition |
Message |
Debug Info |
If user don’t provide FilePathOrXML, Xpath and DelimitedBy. |
Argument Data Missing (-13200) |
One or more of the arguments have not been provided a value. |
Global Scope Keywords
ResetORToOriginal
This keyword is used to go back to the original Object Repository and neutralizes the effect of previously executed SetOR for all subsequent steps generated after ResetORtoOriginal keyword. It takes no data input argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
No |
No |
This keyword doesn’t take any data input argument. |
Output
Example
This keyword is mostly used in situations where you want to test multilingual websites.
Common Error conditions
There are no negative Scenarios for this keyword.
RestoreStepTimeOut
This keyword is used to restore the default step timeout. It is called before set step timeout keyword. It does not require any input argument.
Input Arguments:
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Data |
No |
Output:
True |
If the keyword passes successfully |
Example:
If user want to restore it default timeout, then use this keyword.
RestoreStepTimeOut:
Step Timeout |
No input argument required |
NOTE: There is no error conditions for this keyword.
SetGlobalVariableValue
This keyword is used to set the global variable value at runtime.
Input Arguments
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Description |
VariableName |
Yes |
Specify the Global variable |
VariableValue |
Yes |
Specify the value |
Output
True |
If the keyword passes successfully |
False |
If there is an error |
Example
If you want to set Global variable value “Mozilla Firefox” of Open browser as “Chrome” then use this keyword as shown- SetGlobalVariableValue
SetGlobalvariablevalue
VariableName |
Default Browser |
Variablevalue |
Chrome |
Error conditions
Conditions |
Message |
Debug Information |
If user do not provide Variable Name and Variable Value |
< Argument Data Missing (-13200) > |
GlobalVariableName cannot be blank |
If user do not provide Variable Value and Variable Name |
< > |
|
If user do not provide variable name and variable value |
Argument Data Missing (-13200) |
GlobalVariableName cannot be blank |
NOTE:
If user want to sets the global variable value at runtime then, open any browser (along with specified URL of your web application) and use this keyword “SetGlobalVariableValue” and provide the variablename and variablevalue.
SetOR
This keyword is used to test a multilingual website. It sets a dynamic OR. All subsequent steps will use the specified OR instead of one associated during design time of a particular flow. It doesn’t take any object input argument. It takes OR File Path as data input argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
OR File Path |
Yes |
Provide the Path of object repository file. (For eg.:- OR Folder nameOR File name) Note: Object Repository file must be in shared mode. |
Output
Given OR Full Name exists |
If the keyword passes successfully |
Given OR Full Name doesn’t exists |
If an error is there |
Example
This keyword is mostly used in situations where you want to test multilingual websites.
Common Error conditions
Scenarios |
Error Message |
Debug Information |
If given OR full name is incorrect |
Argument Data Invalid (-13300) |
Debug Info: OR [setORO.R1] could not be located either it is not shared or Invalid Path. |
OR Full name is blank | Argument Data Missing (-13200) | OR full name cannot be blank |
SetStepTimeOut
This keyword is used to set the step timeout for the particular execution or step at run time. It is mostly used in situations where you need to set the step timeout time in seconds for the particular execution at run time. It takes time in seconds as data input argument.
Input Arguments:
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Description |
Step Timeout |
Yes |
Provide the step timeout in seconds as data input argument. |
Output:
True |
If the keyword passes successfully |
False |
If there is an error |
Example:
If user want to sets the timeout for a particular step or for execution then he can use this keyword and provide the time in seconds.
SetStepTimeOut
Step Timeout |
Provide value and digit as data input argument |
Error conditions
Condition |
Message |
Debug Info |
If user don’t provide step timeout value. |
Argument Data Missing (-13200) |
StepTimeout cannot be blank. |
NOTE
If user want to set the step timeout for any particular step or execution then, open any browser (along with specified URL of your web application) and use this keyword “SetStepTimeOut”.
Mathematical Operation Keywords
EvaluateExpression
This keyword is used to evaluate/calculate the given expression which is provided by the user in the input parameter. With the help of this keyword user can perform multiple calculations at a time.
It is mostly used in situations where you need to evaluate your given expression which takes integer values and operators as input argument and then it provides the result in its output.
NOTE: This keyword does not require any object argument. It only takes integer values and operator to calculate the expression.
Input Arguments:
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Description |
Integer value |
Yes |
Provide integer value then operator as data input argument. NOTE: Integer value here refer as operands. |
Operator |
Yes |
Provide operator value i.e. Addition, multiplication, etc.. |
Output:
Evaluated Value |
If the keyword passes successfully |
< Blank > |
If there was an error |
Example:
In the above example, if user want to evaluate any expression, then he needs to provide the integer values and the operator (i.e. Addition, Subtraction, Division & Multiplication) then he can use this keyword.
EvaluateExpression
Integer value |
< Provide the Integer value in the data input argument > |
Operators |
< Provide the operator in the data input argument > |
Error conditions:
Condition |
Message |
Debug Info |
Don’t provide integer value and operator. |
Argument Data Missing (-13200) |
System.ArgumentNullException: Value cannot be null. |
Provide integer value then provide operator then again don’t provide integer value. |
Argument Data Missing (-13300) |
System.Data.EvaluateException: Syntax error: Missing operand after ‘-‘ operator |
GetRandomNumber
This keyword is used to fetch any random number between the two integers i.e. provide minimum and maximum value in data input argument.
NOTE: This keyword does not requires any object. It only takes integer values.
Input Arguments:
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Description |
Min number |
Yes |
Provide the minimum value in data input argument. |
Max number |
Yes |
Provide the maximum value in data input argument. |
Output:
Any Random Number |
If keyword passes successfully |
0 |
If keyword fail |
Example:
If user want to fetch any random number between the min i.e. “500” and max i.e. “1000” then in output it gives the value then he can use this keyword.
GetRandomNumber
Min and Max value |
Error conditions:
Condition |
Message |
Debug Info |
Don’t provide min number and max number. |
Argument Data Missing (-13200) |
For random number please provide maximum value greater than 0 |
Provide min number greater than max num |
Argument Data Invalid (-13300) |
‘minValue’ cannot be greater than maxValue. Parameter name: minValue |
RoundOff
This keyword is used to round off the integer value up to given decimal place which is provided by the user in its input argument.
NOTE: This keyword does not require any object. It takes integer value (with decimal point) and digit value (up to which decimal place it is to be round off) as input argument.
Input Arguments:
Object Input Arguments |
Required? |
Object |
No |
Data Input Arguments |
Required? |
Description |
Value |
Yes |
Provide value as input data argument. NOTE: Value should be provided in Decimal |
Digit |
Yes |
Provide digit as input data argument |
Output:
Round Off value |
If keyword passes successfully |
< Blank > |
If there is an error |
Example:
If user provide the value i.e. “1.56985” and the digit it provide “3” then it will “Roundoff” the value up to 3 decimal place i.e. “1.56” in the output in this way he can use this keyword.
RoundOff
Value |
Provide value as data input argument
|
Digit |
Provide digit as data input argument
|
Error conditions:
Condition |
Message |
Debug Info |
Don’t provide value and digit. |
Argument Data Missing (-13200) |
One or more of the arguments have not been provided a value |
Provide value i.e. (10.35) and digit i.e. (20) |
Argument Data Invalid (-13300) |
System.ArgumentOutOfRangeException: Rounding digits must be between 0 and 15, inclusive. |
Process Keywords
GetStatusOfWindowsService
This keyword returns the status of specified Window Service. For example, you made a window service through visual studio and you want to get the status of that service. In this case, you can use this keyword. It takes Service Name as input parameter.
Input Arguments
This keyword does not require any Object Input argument.
Data Input Arguments |
Data Required |
Description |
Service Name (need not be case sensitive) |
Yes |
Specify the Window Service name |
Output
Running |
If service is running at that time |
Stopped |
If Service is stopped at that time |
False |
If wrong service name is provided |
Example
Here is how you can see all window services
If you want to get the status of a window service, here is how you will use this keyword-
-
Add GetStatusOfWindowService keyword
-
Run to get the status of your window service
Error conditions
Conditions |
Message |
Debug Info |
Invalid data |
Unsatisfied Dependencies |
The specified service does not exist as an installed service |
Blank data |
Argument Data Invalid |
GetSystemProperty
This keyword returns the value of specified environment variable (User and System). It takes variable name as input parameter. To see how you can view environment variable, please follow this link – https://www.java.com/en/download/help/path.xml
Input Arguments
This keyword does not require any Object Input argument.
Data Input Arguments |
Data Required |
Description |
Variable Name (need not be case sensitive) |
Yes |
Specify the Environment Variable name |
Output
Variable value |
If correct name is provided |
False |
If data input is not provided |
Blank |
If wrong input is provided |
Example
If you want to get the value of specified system environment, here is how you will use this keyword-
-
Add GetSystemProperty keyword
-
Run to get the status of your window service
Error conditions
Conditions |
Message |
Debug Info |
Invalid data |
||
Blank data |
Argument Data Invalid |
RunCommand
This keyword executes the given command on command prompt and provides the result. It takes command as data input argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Yes |
Yes |
Provide the command to be executed on command prompt |
Output
Write the command to be executed on command prompt |
If the keyword passes successfully |
No command provided |
If an error is there |
Example
This keyword is mostly used in situations when you want to execute a command on command prompt. The command provided in data input argument, will get executed.
Common Error conditions
Scenarios |
Error Message |
Debug Information |
No command provided |
Argument Data Missing (-13200) |
Command Argument is missing |
Runtime Keywords
ResetGenericPluginToDefault
This keyword is used after a SetGenericPlugin keyword to reset the system to use the default generic plugin. It takes no input arguments.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
No |
No |
This keyword doesn’t take any data input argument. |
Output
This keyword switches your plugin to the previous plugin with which execution started. |
If the keyword passes successfully |
False |
If an error is there |
Example
This keyword is mostly used in situations where you want to switch to the previous plugin with which execution started.
Common Error conditions
This keyword never fails.
SetGenericPlugin
This keyword sets a plugin, different from the chosen plugin at run-wizard to execute the generic keywords. It takes Plugin as data Input Arguments.
For SetGenericPlugin Keyword:
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Plugin Name |
Yes |
Specify the Plugin Name. |
Output
True |
If the keyword passes successfully |
False |
If an error is there |
Example
If you want to set a plugin “Selenium WebDriver” which is different from what is chosen at run-wizard to execute the generic keywords, you can do so by using SetGenericPlugin keyword as follows:
SetGenericPlugin
Plugin Name |
Selenium WebDriver |
Common Error conditions
Scenarios |
Error Message |
Debug Information |
If invalid data input argument is provided. |
Plugin Not Loaded (-9902100) DESCRIPTION: A plugin was not loaded at the execution site. This might happen if the plugin was used in authoring a test but was not installed on the machine where the actual execution took place. Even an installed plugin might fail if its dependencies are not properly installed. |
Plugin ‘Selenium WebDriver’ is not loaded. Please use a plugin specific keyword or a custom keyword for this plugin to load the plugin in the runtime. |
If Blank Plugin Name is passed |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
Plugin Name cannot be blank. |
Service Keywords
RestartWindowsService
This keyword is used to restart the specified Windows Service. It takes Servicename and TimeoutInSeconds as data input parameter.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Service Name |
Yes |
This keyword doesn’t take any data input argument. |
TimeOut In seconds |
Yes |
Provide the timeout in seconds. |
Output
Windows Service Name & timeout in seconds are given correctly |
If the keyword passes successfully |
Windows Service Name & timeout in seconds are given Incorrectly |
If an error is there |
Example
This keyword is mostly used in situations when you want to restart a particular Windows service.
Common Error conditions
Scenarios |
Error Message |
Debug Information |
Windows Service Name & timeout in seconds are given Incorrectly |
Unauthorised Access Exception (-18100) |
The specified service does not exist as an installed service. |
Windows Service Name & timeout in seconds are Not given | Argument Data Invalid (-13300) | Data not provided. |
StartWindowsService
This keyword starts the specified Window Service. For example, your window service is getting stopped during certain action and you want to get the that service started. In this case, you can use this keyword. This keyword takes Service Name and Timeout as input parameter.
*Note – Providing Timeout is not mandatory.
Input Arguments
This keyword does not require any Object Input.
Data Input Arguments |
Data Required |
Description |
Service Name (need not be case sensitive) |
Yes |
Specify the Window Service name |
Timeout (in seconds) |
Yes |
Specify the timeout |
Output
True |
If action is performed successfully |
False |
If Access is denied or service is already running |
Blank |
If service name is not provided |
Example
Here is how you can see all window services
If you want to start a window service, here is how you will use this keyword –
-
Add StartWindowService keyword
-
Run to get the start your window service
Error conditions
Conditions |
Message |
Debug Info |
Invalid data, Valid timeout |
Argument Data Invalid |
|
Blank data |
Argument Data Invalid |
StopWindowsService
This keyword is used to stop the specified Windows Service. It takes Servicename and Timeout in Seconds as data input parameter.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
Service Name |
Yes |
This keyword doesn’t take any data input argument. |
TimeOut In seconds |
Yes |
Provide the timeout in seconds. |
Output
Windows Service Name & timeout in seconds are given correctly |
If the keyword passes successfully |
Windows Service Name & timeout in seconds are given Incorrectly |
If an error is there |
Example
This keyword is mostly used in situations where you want to stop any particular Windows service.
Common Error conditions
Scenarios |
Error Message |
Debug Information |
Windows Service Name & timeout in seconds are given Incorrectly |
Unauthorised Access Exception (-18100) |
The specified service does not exist as an installed service. |
Windows Service Name & timeout in seconds are Not given | Argument Data Invalid (-13300) | Data not provided. |
String Function Keywords
CountOfSubString
This keyword counts the number of sub strings present in main string. You must provide main string from which you want to count substring.
Input Arguments
This keyword does not require any Object Input.
Data Input Arguments |
Data Required |
Description |
MainString |
Yes |
Specify the main string from which sub string needs to be counted |
SubString |
Yes |
Specify the sub string that needs to be counted |
IgnoreCase |
Yes |
Select the Ignore Case |
Output
Number of strings |
Returns number of strings specified from main string |
0 |
When argument have not been provided with a value |
Example
If you want to get the count of sub string from main string, here is how you will use this keyword-
-
Add CountOfSubString keyword
-
Type or Paste your Main String in MainString data
-
Type your SubString data, i.e, the sub string that you want to count from MainString
-
Select your IgnoreCase – True, if you want to count, say, alphabets irrespective of case sensitive and False, if you want to count Substrings that exactly match from Main String
Error conditions
Conditions |
Message |
Debug Info |
Blank Main String |
Argument Data Missing |
One or more of the arguments have not been provided a value |
Blank Sub String |
Argument Data Missing |
One or more of the arguments have not been provided a value |
GetCurrentTimeZone
This keyword is used to get the current timezone. It takes no input argument.
Input Arguments
Object Input Arguments |
Required? |
Description |
Object |
No |
This keyword doesn’t take any object input argument. |
Data Input Arguments |
Required? |
Description |
No |
No |
This keyword doesn’t take any data input argument. |
Output
This keyword provides current time zone of the system on which execution is going on. |
If the keyword passes successfully |
Example
This keyword is mostly used in situations where you want to know the current time zone of the local system.
Common Error conditions
This keyword never fails.
GetStringLength
This keyword is used to get the length of the string. It is mostly used in situations where you want to acquire the provided String Length.
For example, you want to get the String Length.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in text in string format |
Output
It gives the number of text which is provided in string length |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to return a True Output
String |
Automation
|
Output |
<10> |
Note: If user will provide only space or integer value then it will show the count in output.
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
One or more of the arguments have not been provided a value |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
IndexOf
This keyword is used to fetch the index of substring from the main string. It is mostly used in situations where you want to retrieve the index of substring from the main string.
For example, you want to fetch the substring index
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in text in string format |
Sub-String |
Yes |
This Keyword takes value in text present in string |
Output
It gives the value of index which is provided in sub string |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to return a True Output
String |
< automation > |
Sub-String |
< t > |
Output |
< 2 > |
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
One or more of the arguments have not been provided a value |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
|
If String Value is null but Sub-String Value is not null |
|||
If Sub-String Value is not null but String Value is not null |
IsBoolean
This keyword is used to verify whether the specified value is boolean or not. It returns true if the specified string is is Boolean. It takes String value as data input argument.
For example, you want to return true.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String. Note: Value should be in True/False text |
Output
True |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to return a Boolean Value
String |
Boolean Value |
Output |
True
|
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
String1 argument is missing |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
IsDouble
This keyword is used to verify whether the specified string value is double or not. It returns true if the specified string is double. This keyword is mostly used in situations where you want to take double output in step output.
For example, you want to take double value of particular integer string.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String Note: Value should be in integer form for True Result. |
Output
True |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to return a True Output
String |
<123456789> |
Output |
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
String1 argument is missing |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
IsInteger
This keyword is used to verify whether the specified value is Integer or not. It checks and return true if the specified string is integer. This keyword is mostly used in situations where you want to check that the specified string is integer or not.
For example, you want to return true.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String. Note: Value should be in integer form for True Result. |
Output
True |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to return a True Output
String |
<123456789> |
Output |
True
|
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
String1 argument is missing |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
LeftTrim
This keyword removes white spaces (space) before a given string. It is mostly used in situations where you want to remove spaces before string before clicking or doing any action on it.
For example, you want to trim from Left
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String |
Output
It gives the Left trimmed string |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to Split the Given String from Left Side
String |
automation
|
Output |
automation
|
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
One or more of the arguments have not been provided a value |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
RemoveDelimiter
This keyword is used to split a given string without the delimiter. It is mostly used in situations where you want to split the provided string before clicking or doing any action on it.
For example, you want to split the string.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String |
Delimiter |
Yes |
In this, Provide a special character from where you want to split. |
Output
It gives the string without the delimiter which is provided in data input argument. |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to Split the Given String from Special Character.
RemoveDeleimiter
String |
|
Delimiter |
<.> |
Output |
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
One or more of the arguments have not been provided a value |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
|
If string is Provided but no Value in Delimiter |
One or more of the arguments have not been provided a value |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
|
If Delimiter is Provided but no Value in string |
One or more of the arguments have not been provided a value |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
ReplaceSubString
This keyword replaces the old sub string from the new sub-string provided in data input argument. It is mostly used in situations where you want to replace the new sub-string from the old one.
For example, you want to replace the sub-string.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String, Old Sub-String, and New Sub-String |
Output
It gives the new string in which the new substring is added |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to return a True Output
String |
< cresconnect.crestech > |
Old Sub-String |
< crestech > |
New Sub-String |
< crestechglobal > |
Output |
< cresconnect.crestechglobal > |
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
String1 argument is missing |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
|
If String Value and New Sub-String Value is provided but Old Sub-String Value is not provided |
System.ArgumentException: String cannot be of zero length. Parameter name: oldValue at System.String.ReplaceInternal (String oldValue, String newValue) at A.cdb444caf4f5ad03e 34dc7fb638127381. c8852d929a117b2bb4b6653632 502659e (String cb4e98476b566f 4c4b25f589ece0a7 261, String c6f421d2fe50e5d 8e4ddd6b06045 9c2f1, String c59bb9c6cff9f592 311561615031fc16e) in File684:line 81 |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
RightTrim
This keyword removes white spaces (space) after a given string. It is mostly used in situations where you want to remove spaces after string before clicking or doing any action on it.
For example, you want to trim from Right.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String |
Output
It gives the right trimmed string |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to Split the Given String from Right Side
String |
Automation |
Output |
Automation |
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
One or more of the arguments have not been provided a value |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
Split
This keyword splits the specified string from given index and delimiter. It is mostly used in situations where you want to split the string.
For example, you want to split the string.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String with delimiter, delimiter and index Note: Delimiter takes a single value from where you want to split. Index takes a single value in integer. |
Output
It gives the string of provided index |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to return a True Output
String |
cresconnect.crestech |
Delimiter |
<.> |
Index |
<1> |
Output |
crestech
|
Error conditions
Condition |
Debug Information |
Message |
|
If String Value is null |
String1 argument is missing |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
StringConcat
This keyword concatenate the strings provided in data input argument. It is used in situations where you want to link-together multiple strings and create a new concatenated string.
For example, you want to concatenate the strings.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in string1, string2 etc. (as per requirement) |
Output
It gives concatenated string |
If the keyword passes successfully |
It gives Blank data |
If an error is there. |
Example
If you want to return a True Output
String1 |
cres
|
String2 |
tech
|
String3 |
global
|
Output |
crestechglobal
|
Note: User Can Add Multiple Strings as per the requirement.
SubString
This keyword extracts a substring from specified main string, starting from specified Position till Number of specified characters. It is mostly used in situations where you want to retrieve a substring from the main string.
For example, if you want to extract a substring, this is how you will use this keyword –
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
Text |
Yes |
This Keyword takes test value in string format |
Start Index |
Yes |
This Keyword takes single value in start Index. (From where you want to extract the data). |
Length |
Yes |
This Keyword takes Length in integer. (Up To where you want to extract) |
Output
It gives the text which starts from 2 index Upto length 4. |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to return a True Output
Text |
automation |
Start Index |
<2> |
Length |
<4> |
Output |
Tom
|
Error conditions
Condition |
Debug Information |
Message |
|
If All Values are Null |
One or more of the arguments have not been provided a value |
Argument Data Missing (-13200) DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
|
If Last Index & Length is more than one is selected |
Index and length must refer to a location within the string. Parameter name: length |
Argument Data Invalid (-13300)
DESCRIPTION: The data value for one or more input arguments was not what was expected. This might happen when the input is expected in a specific format or should be chosen from a predefined set of values. Check for spell errors and capsing. |
ToLower
This keyword is used to convert a string to lowercase. It is mostly used in situations where you want to convert an upper case string into lowercase before clicking or doing any action on it.
For example, you want to convert string in lowercase.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String Note: You can provide a String in Uppercase. |
Output
It gives the string in lowercase |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to convert an upper case string into lowercase, here is how you will use this keyword.
ToLower
String |
AUTOMATION |
Output |
automation |
Error conditions
Condition |
Debug Information |
Message |
If String Value is null |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value |
ToUpper
This keyword is used to convert a string to uppercase. It is mostly used in situations where you want to convert a lowercase string into uppercase before clicking or doing any action on it.
For example, you want to convert string in uppercase.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String Note: You can provide a String in Lower case |
Output
It gives the string which is in upper case |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to convert a Lowercase string into uppercase, here is how you will use this keyword
ToUpper
String |
automation
|
Output |
AUTOMATION
|
Error conditions
Condition |
Debug Information |
Message |
If String Value is null |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value |
Trim
This keyword removes the white spaces (space) before and after the string. It is mostly used in situations where you want to remove the spaces before clicking or doing any action on it.
For example, you want to remove the spaces.
Input Arguments
Object Input Arguments |
Required? |
No |
No |
Data Input Arguments |
Required? |
Description |
String |
Yes |
This Keyword takes value in String |
Output
It gives the string which is trimmed from both the ends |
If the keyword passes successfully |
False |
If an error is there. |
Example
If you want to Trim the white spaces before and after the specified string, here is how you will use this keyword.
Trim
String |
< Automation > |
Output |
< Automation > |
Error conditions
Condition |
Debug Information |
Message |
If String Value is null |
Argument Data Missing (-13200)
DESCRIPTION: A step could not be executed because one or more of the arguments have not been provided a value. Of all the arguments a keyword accepts, some arguments might be compulsory. As opposed to the non-compulsory ones, the compulsory argument must be provided some data. The data may be provided through one of many sources like statically entering, output of a previous step, a global variable etc; but it must not be left blank. |
One or more of the arguments have not been provided a value |