List of Keywords - Excel Keywords

To learn how to use Excel keywords in Opkey, you can read Using Excel Keywords - New UI and Excel Keywords - Opkey Classic. Now, let's go through the first list of keywords and their utility.

1. Excel_VerifyColumnCount

This keyword verifies the number of Columns corresponding to the specified Row Number of an Excel file.

Note: The Excel_Open Keyword is always used before this keyword.

Example

ExcelReference	abcd
SheetName	Colors
Row	1
Expected Value	3

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file that is used with the Excel_Open keyword.
SheetName	Specify the Name of the Sheet whose number of Columns has to be Verified
Row	Specify the Row Number which will be used to Verify the Column count.
Expected Value	Specify the Expected count of columns corresponding to the specified Row Number of an Excel file

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If blank data Input Arguments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from a static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (ExcelReference;

SheetName; Row) is/are blank.

If the keyword is launched without using Excel Open the keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/ application-specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration files, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference is not opened.

2. Excel_VerifyRowCount

This keyword verifies the number of rows corresponding to the specified Column Number of an Excel file.

Note: The Excel_Open Keyword is always used before this keyword.

Example

ExcelReference	abcd
SheetName	Colors
Column	3
Expected Value	1

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file that is used with Excel_Open keyword.
SheetName	Specify the Name of the Sheet whose number of Columns has to be Verified
Column	Specify the Column Number which will be used to Verify the Column count.
Expected Value	Specify the Expected count of columns corresponding to the specified Row Number of an Excel file

Output Data

Condition	Output value
If the keyword passes successfully	True
if there is an error	False

Error conditions

Scenarios

Error Message

Debug Information

If blank data Input Arguments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from a static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (ExcelReference;

SheetName; Column) is/are blank.

If the keyword is launched without using Excel Open the keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

System or application settings are impeding the operation. Identify and correct misconfigurations in involved applications, adjusting settings, editing configuration files, or turning knobs based on the specific issue encountered.

Excel Reference is not opened.

3. Excel_ClearCellValue

This keyword clears the value of a cell in an Excel file based on the data input arguments provided.

Note: Excel_Open Keyword is always used before this keyword

Example

ExcelReference	abcd
SheetName	Colors
StartingRow	300
Starting Column	30
Ending Row	330
Ending Column	30

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file that is used with the ExcelOpen keyword.
SheetName	Specify the Name of the Sheet whose Cell Value has to be cleared
StartingRow	Specify the Starting Row from where the values/data have to be deleted.
StartingColumn	Specify the Starting Column from where the values/data have to be deleted.
EndingRow	Specify the Ending Row till where the values/data have to be deleted.
EndingColumn	Specify the Ending Column till where the values/data have to be deleted.

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If the keyword is executed without closing the Excel file on the system.

Conflicting Configuration (-14400)

DESCRIPTION:

System or application settings are impeding the operation. Identify and correct misconfigurations in involved applications, adjusting settings, editing configuration files, or turning knobs based on the specific issue encountered.

Close the Excel File to modify the data on the file.

If the keyword is launched without using Excel Open the keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

System or application settings are impeding the operation. Identify and correct misconfigurations in involved applications, adjusting settings, editing configuration files, or turning knobs based on the specific issue encountered.

Excel Reference is not opened.

4. Excel_ClearColumn

This keyword clears column (s) of the Excel file based on the data input argument provided.

Note: Excel_Open Keyword is always used before this keyword.

Test Object

Test Object Required	Description
None	Not Required

Input Data

Data Input Arguments	Description
Excel Reference	Specify the Reference Name of the Excel file that is used with Excel_Open keyword.
SheetName	Specify the Name of the Sheet whose Column Values have to be cleared
Starting Column Number	Specify the Starting Column from where the values/data have to be cleared.
Number of Columns	Specify the Number of Columns whose value has to be cleared

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If blank data Input Arguments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

Argument(s) : (SheetName;

StartingColumn

Number;

NumberOf

Columns) is/are blank.

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

System or application settings are impeding the operation. Identify and correct misconfigurations in involved applications, adjusting settings, editing configuration files, or turning knobs based on the specific issue encountered.

Excel Reference

is not opened.

6. Excel_ClearRows

This keyword clears Row(s) of Excel file based on the data input argument provided.

Note: The Excel_Open Keyword is always used before this keyword.

Example:-

Excel_ClearRows

ExcelReference	abcd
SheetName	Colors
Starting Row Number	4
Number of Rows	2

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file that is used with the Excel_Open keyword.
SheetName	Specify the Name of the Sheet whose Column Values have to be cleared
Starting Row Number	Specify the Starting Row from where the values/data have to be cleared.
Number of Rows	Specify the Number of Rows whose value has to be cleared.

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If blank data Input Arguments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (SheetName;Starting

RowNumber;Number

OfRows) is/are blank.

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application-specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, and turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference is not opened.

7. Excel_Close

This keyword helps close the currently opened Excel reference File. It takes Excel Reference as Data Input Arguments.

Note: Excel_Open Keyword is always used prior to this keyword.

Example

ExcelReference

abcd

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file which is used with ExcelOpen keyword.

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If the data Input Arguments are not provided

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) Excel Reference is/are blank.

If the keyword is launched without using Excel Open keyword.

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 casing.

Specified Excel Reference is not opened or already closed

8. Excel_CloseAll

This keyword closes all the opened Excel File.

Note: Excel_Open Keyword is always used prior to this keyword.

Example

Suppose you want to close all the opened Excel files saved on your system then you can use Excel_CloseAll keyword.

Test Object

Test Object Required	Description
None	Not Required

Input Data

Data Input Required?	Description
No	This keyword does not require any Data Input Argument.

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

There are no error conditions for this keyword.

9. Excel_CompareCellValue

This Keyword compares the values of two specified cells within the same Excel file or two different Excel files based on the Data Input Arguments provided.

Note: Excel_Open Keyword is always used before this keyword.

Example:-

Excel_CompareCellValue

Excel Reference1	abcd
SheetName1	Colors
Row1	1
Column1	1
Excel Reference2	abcd
SheetName2	Colors
Row2	1
Column2	2

Test Object

Test Object Required	Description
None	Not Required

Input Data

Data Input Arguments	Description
ExcelReference1	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName1	Specify the Name of the Sheet whose Cell Value has to be compared.
Row1	Specify the Row Number of the Excel Sheet whose Cell Value has to be compared.
Column1	Specify the Column Number of the Excel Sheet whose Cell value have to be compared
Excel Reference2	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName2	Specify the Name of the Sheet whose Cell Value has to be compared.
Row2	Specify the other Row Number of the Excel Sheet whose Cell Value has to be compared.
Column2	Specify the other Column Number of the Excel Sheet whose Cell value have to be compared

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If provided values are not matched.

Verification Failed (-16100)

DESCRIPTION:

The value which is required, was not found on the currently active page or view.

1st Cell < Green >

2nd Cell < Black >

If Blank Data Input Argunments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (ExcelReference1;

SheetName1

;Row1;Column1;Excel

Reference2;

SheetName2;Row2;

Column2) is/are blank.

10. Excel_CompareColumns

This Keyword compares the values of two specified Columns within the same Excel file or two different Excel files based on the Data Input Arguments provided.

Note: Excel_Open Keyword is always used before this keyword.

Example:-

Excel_CompareColumns

Excel Reference1	abcd
SheetName1	Colors
Column1	1
Excel Reference2	abcd
SheetName2	Colors
Column2	2
Delimiter

Note:

The value of the delimiter is Semicolon(;) by default.

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
Object	This keyword does not require any object Input Argument.
Data Input Arguments	Description
ExcelReference1	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName1	Specify the Name of the Sheet whose Column Value has to be compared.
Column1	Specify the Column Number of the Excel Sheet whose Value has to be compared.
ExcelReference2	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName2	Specify the Name of the Sheet whose Column Values has to be compared.
Column2	Specify the other Column Number of the Excel Sheet whose Column Value has to be compared.
Delimiter	Specify the text/symbol/special characters by which the Column text has to be separated.

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If the two row values are not matched.

Verification Failed (-16100)

DESCRIPTION:

The value which is required, was not found on the currently active page or view.

1st Column:

Green ;Blue>

2nd Column:

If Blank Data Input Argunments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (ExcelReference1;Sheet

Name1;

Column1;Excel

Reference2;Sheet

Name2;

Column2) is/are blank.

11. Excel_CompareRows

This Keyword compares the values of two specified Rows within the same excel file or two different Excel files based on the Data Input Arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword.

Example :-

Excel_CompareRows

Excel Reference1	abcd
SheetName1	Colors
Row1	1
Excel Reference2	abcd
SheetName2	Colors
Row2	1
Delimiter

Note:

The value of the delimiter is Semicolon(;) by default.

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
ExcelReference1	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName1	Specify the Name of the Sheet whose Row Value has to be compared.
Row1	Specify the Row Number of the Excel Sheet whose Row Values has to be compared.
ExcelReference2	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName2	Specify the Name of the Sheet whose Row Values has to be compared.
Row2	Specify the other Row Number of the Excel Sheet whose Row Value has to be compared.
Delimiter	Specify the text/symbol/special characters by which the Row text has to be separated.

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If the two row values are not matched.

Verification Failed (-16100)

DESCRIPTION:

The value which is required, was not found on the currently active page or view.

1st Row :< Green ;Green ;Blue >

2nd Row :< Yellow ;White;Brown >

If Blank Data Input Argunments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (ExcelReference1;

SheetName1;Row1;

Column1;Excel

Reference2

;SheetName2;Row2

;Column2) is/are blank.

12. Excel_CompareSheet

This keyword is used to compare two Excel sheets with in single excel file or two different excel file based on data input arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword.

Example

Excel Reference1	abcd
SheetName1	Colors
Excel Reference2	Mysheet
SheetName2	Stars
Delimiter

Test Object

Test Object Required	Description
None	Not Required

Input Data

Data Data Required	Description
ExcelReference1	Specify the Reference Name of the Excel file that is used with the Excel_Open keyword.
SheetName1	Specify the Name of the Sheet which has to be compared.
ExcelReference2	Specify the Reference Name of the Excel file that is used with the Excel_Open keyword.
SheetName2	Specify the Name of the other Sheet which has to be compared
Delimiter	Specify the text/symbol/special characters by which the text of the two sheets are separated.

Output Data

Condition	Output value
If the keyword passes successfully	True
if there is an error	False

Error conditions

Scenarios

Error Message

Debug Information

If the two row values are not matched.

Verification Failed (-16100)

DESCRIPTION:

The value which is required, was not found on the currently active page or view.

1st Excel :< Green ;Green ;BlueYellow ;Yellow ;BrownOrange ;Orange ;Lime Orange ;Orange ;Lime Royal Blue;Royal Blue; Light Brown >

2nd Excel :< ab;787fd;grfhv;768 >

If Blank Data Input Argunments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (ExcelReference1;

SheetName1;

ExcelReference2;

SheetName2) is/are blank.

13. Excel_CopyAndPasteCellValue

This keyword is used to copy and paste particular cell value (s) within single excel sheet or within two different excel sheet or within 2 different excel sheets of 2 different excel files based on the Data Input Arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword. The Excel File must be closed before using this Keyword.

Example :-

Excel_CopyAndPasteCellValue

Excel Reference1	abcd
SheetName1	Colors
Row1	1
Column1	1
Excel Reference2	abcd
SheetName2	Colors
Row2	1
Column2	2

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
ExcelReference1	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName1	Specify the Name of the Sheet whose Cell Value has to be Copied.
Row1	Specify the Row Number of the Excel Sheet whose Cell Value has to be Copied.
Column1	Specify the Column Number of the Excel Sheet whose Cell value have to be Copied
Excel Reference2	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName2	Specify the Name of the Sheet in which the Cell Value of the copied cell has to be Pasted.
Row2	Specify the other Row Number of the Excel Sheet where the Cell Value of the copied cell has to be Pasted.
Column2	Specify the other Column Number of the Excel Sheet where the Cell Value of the copied cell has to be Pasted.

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference

< abcd >

is not opened.

If Blank Data Input Argunments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (ExcelReference1;

SheetName1;

Row1;

column1;

ExcelReference2;

SheetName2;

Row2;

Column2) is/are blank.

14. Excel_CreateFile

This keyword creates a new Excel file, it supports only .xlsx and xls format file. It takes File path and Sheet name (optional) as data input arguments.

Note: Specify the Excel Path of the file with .xlsx or xls Extension

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
ExcelPath	Specify the location on which the Excel path has to be created.
SheetName	Specify the Name of the Sheet existing in the Excel file.

Output Data

Condition	Output value
If the keyword passes successfully	True
if there is an error	False

Error conditions

Scenarios

Error Message

Debug Information

If blank data Input Arguments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

Argument(s) : ExcelPath; is/are blank.

15. Excel_DeleteRow

This keyword is used to delete row(s) from the particular Excel sheet based on the data input arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword.

Example :-

Excel_DeleteRow

ExcelReference	abcd
SheetName	Colors
Row	5

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName	Specify the Name of the Sheet whose row has to be deleted.
Row	Specify the Row Number which has to be deleted.

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If blank data Input Arguments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (ExcelReference;

SheetName;Row) is/are blank.

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference is not opened.

16. Excel_DuplicateSheet

This keyword is used to create a duplicate copy of an Excel sheet within an Excel File based on the data input arguments provided.

Note: Excel_Open Keyword is always used prior

to this keyword.The Excel File must be closed before using this Keyword.

Example

Suppose you want to Create a Duplicate Sheet of an Excel Sheet within an Excel File saved on your system then here is how you will use Excel_DuplicateSheet keyword:

Excel_DuplicateSheet

Excel Reference	abcd
Source Sheet	Colors
After Target Point	1
New Sheet Name	Sheet2

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
Excel Reference1	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
Source Sheet	Specify the Name of the Sheet whose Duplicate has to be created
After Target Point	Specify the Index(after which sheet) of the new duplicate Sheet.
New Sheet Name	Specify the Name of the New Sheet

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference < abcd > is not opened.

If Blank Data Input Argunments 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.

Argument(s) : (ExcelReference;

SourceSheet;

AfterTargetPoint;

NewSheetName) is/are blank.

17. Excel_GetCellValue

This keyword will fetch the value from a specified cell of an Excel File based on the Data Input Arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword.

Example

Excel_GetcellValue

Excel Reference	abcd
SheetName	Colors
Row	1
Column	1

Test Object

Test Object Required	Description
None	Not Required

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName	Specify the Name of the Sheet
Row	Specify the Row Number of the cell whose value has to be fetched.
Column	Specify the Column Number of the cell whose value has to be fetched.

Output Data

Condition	Output value
If the keyword passes successfully	Returns the Value of the Specified cell
If the keyword fails	False

Error conditions

Scenarios

Error Message

Debug Information

If the data Input Arguments are not 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.

Argument(s) : (Column) is/are blank.

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference < abcd > is not opened.

18. Excel_GetColumnCount

This Keyword Returns the number of columns in the specified Excel file. This keyword is used in a situation where user wants the Column Count of an Excel file with the help of Row Number.

Note: Excel_Open Keyword is always used prior to this keyword.

Example

Excel_GetColumnCount

ExcelReference	abcd
SheetName	Colors
Row	4

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName	Specify the Name of the Sheet which will be used to get the column count.
Row	Specify the Row Number which will be used to get the column count..

Output Data

Condition	Output value
If the keyword passes successfully	Count of the number of Columns
If the keyword fails	0

Error conditions

Scenarios

Error Message

Debug Information

If blank 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.

Argument(s) : (ExcelReference;

SheetName;Row;) is/are blank.

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference is not opened.

19. Excel_GetColumnValue

This keyword will fetch the value from a specified Column of an Excel File based on the Data Input Arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword.

Example

Excel_GetColumnValue

ExcelReference	abcd
SheetName	Colors
Column	1
Delimiter	#

Note:

The value of the delimiter is Semicolon(;) by default.

Output

Green#Yellow#Orange#Violet#Royal Blue

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description

Excel Reference	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName	Specify the Name of the Sheet from where the value of a specified column has to be fetched.
Column	Specify the Column Number of the Excel Sheet whose values have to be fetched
Delimiter	Specify the text/symbol/special characters by which the Column text has to be separated.

Output Data

Condition	Output Value
If the keyword passes successfully	Column Values separated by Delimeter
If the keyword fails	False

Error conditions

Scenarios

Error Message

Debug Information

If blank 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.

Argument(s) : (ExcelReference;

SheetName;Column) is/are blank..

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference is not opened.

20. Excel_GetRowCount

This Keyword Returns the number of Rows in the specified Excel file. This keyword is used in a situation where user wants Row Count of an Excel file with the help of Column Number.

Note: Excel_Open Keyword is always used prior to this keyword.

Example

Excel_GetRowCount

ExcelReference	abcd
SheetName	Colors
Column	1

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description
Excel Reference	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName	Specify the Name of the Sheet which will be used to get the row count.
Column	Specify the Column Number which will be used to get the row count.

Output Data

Condition

Output Value

If the keyword passes successfully

Count of the

number of Rows

If the keyword fails

0 Error conditions

Scenarios

Error Message

Debug Information

If blank 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.

Argument(s) : (ExcelReference;

SheetName;Row;) is/are blank.

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference

< abcd >

is not opened.

21. Excel_GetRowValue

This keyword will fetch the value from a specified Row of an Excel File based on the Data Input Arguments provided.

Note: ExcelOpen Keyword is always used prior to this keyword.

Example

Excel_GetRowValue

ExcelReference	abcd
SheetName	Colors
Row	2
Delimiter	#

Note:

The value of the delimiter is Semicolon(;) by default.

Output

Yellow#White#Brown

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file which is used with ExcelOpen keyword.
SheetName	Specify the Name of the Sheet from where the value of a specified Row has to be fetched.
Row	Specify the Row Number of the Excel Sheet whose values have to be fetched
Delimiter	Specify the text/symbol/special characters by which the Row text has to be separated.

Output Data

Condition

Output Value

If the keyword passes successfully

Row

Values separated by Delimeter

If there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If blank 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.

Argument(s) : (ExcelReference;

SheetName;Row) is/are blank..

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference is not opened.

22. Excel_InsertBlankRows

This keyword is used to insert the blank row (s) in the Excel sheet of a particular Excel file based on the data input arguments provided.

Note: ExcelOpen Keyword is always used prior to this keyword. The Excel File must be closed before using this Keyword.

Example

Excel_InsertBlankRows

This keyword will insert blank rows as follows:

ExcelReference	abcd
SheetName	Colors
Number of Rows	2
Starting Row	2

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file which is used with Excel Open keyword.
SheetName	Specify the Name of the Sheet where the Blank rows are to be inserted
NumberofRows	Specify the Number of blank Rows which will be inserted in the Excel Sheet
StartingRow	Specify the starting Row Number of an Excel Sheet after which the blank rows are to be inserted.

Output Data

Condition	Output Value
If the keyword passes successfully	True
If there is an error	False

Error conditions

Scenarios

Error Message

Debug Information

If blank 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.

Argument(s) : (ExcelReference;

SheetName;

NumberOfRows;

StartingRow) is/are blank.

If the keyword is used without closing the Excel File on the system.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Close the Excel

file abcd in order to modify the data of the file.

23. Excel_Open

This keyword opens an Excel File. It takes ExcelFile and ExcelReference (which can be referenced for other Excel keywords) as Data Input Arguments.

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description
ExcelFile	Specify the Location of the Excel File
ExcelReference	Specify any Reference Name of the Excel file which can be used as a reference for other Excel keywords.

Output Data

Condition	Output Value
If the keyword passes successfully	True
If there is an error	False

Error conditions

Scenarios

Error Message

Debug Information

If 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.

Argument(s) Excel File; Excel Reference is/are blank.

If Excel File is provided but Excel Reference is 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.

Argument(s) Excel Reference is/are blank.

24. Excel_RenameSheet

This keyword is used to rename a particular Excel sheet within the Excel file based on the data input arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword.

Example

Excel_RenameSheet

ExcelReference	abcd
Old SheetName	Colors
New SheetName	My colors

Tes object and Input Data

Test Object Required?	Description
No	This keyword does not require any object Input Argument.
Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file that is used with the Excel_Open keyword.
Old SheetName	Specify the Current Name of the Sheet which has to be renamed
New SheetName	Specify the New Name of the Sheet

Output Data

Condition	Output Value
If the keyword passes successfully	True
If there is an error	False

Error conditions

Scenarios

Error Message

Debug Information

If blank 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.

Argument(s) : (OldSheetName;

NewSheetName) is/are blank.

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference < abcd > is not opened.

25. Excel_SetBackGroundColor

This keyword is used to set the background color of a particular cell in an Excel file based on the data input arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword. The Excel file must be closed before using this Keyword.

Example

Excel_SetCellBackgroundColor

ExcelReference	abcd
SheetName	Colors
Row	1
Column	1
Background Color	Blue

This keyword will set the Color of the specified cell as Blue(w.r.t the figure)

Note:

You can provide any of the following listed colors as the Background Color [Data Input Argument].

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file that is used with the Excel_Open keyword.
SheetName	Specify the Name of the Sheet
Row	Specify the Row Number of the cell for which you want to set the background color
Column	Specify the Column Number of the cell for which you want to set the background color
Background Color	Specify the Color of the cell background

Output Data

Condition	Output Value
If the keyword passes successfully	True
If the keyword fails	False

Error conditions

Scenarios

Error Message

Debug Information

If the keyword is executed without closing the Excel file on the system.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Close the Excel File < abcd > to modify the data on the file.

If the data Input Arguments are not 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.

Argument(s) : (ExcelReference;

SheetName;

Row;Column;

BackgroundColor) is/are blank.

26. Excel_SetCellTextColor

This keyword is used to set the Text Color of a particular cell in an Excel file based on the data input arguments provided.

Note: Excel_Open Keyword is always used before this keyword. The Excel file must be closed before using this Keyword.

Example

Excel_SetCellTextColor

ExcelReference	abcd
SheetName	Colors
Row	1
Column	1
Text Color	Blue

This keyword will set the Text Color of the specified cell as Blue(w.r.t the figure)

Note:

You can provide any of the following listed colors as the Text Color [Data Input Argument].

Test Object

Object Input Required	Description
No	Object Input data is not required

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file that is used with the Excel_Open keyword.
SheetName	Specify the Name of the Sheet
Row	Specify the Row Number of the cell for which you want to set the text color
Column	Specify the Column Number of the cell for which you want to set the text color
Text Color	Specify the Text Color of the cell

Output Data

Condition	Output Value
If the keyword passes successfully	True
If the keyword fails	False

Error conditions

Scenarios

Error Message

Debug Information

If the keyword is executed without closing the Excel file on the system.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Close the Excel File < abcd > to modify the data on the file.

If the data Input Arguments are not 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.

Argument(s) : (ExcelReference;

SheetName;

Row;Column;

TextColor) is/are blank.

27. Excel_SetRowValue

This keyword is used to set the Value of a specified Row in an Excel sheet of an Excel file based on the data input arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword. The Excel file must be closed before using this keyword.

Example

Excel_SetRowValue

ExcelReference	abcd
SheetName	Colors
Row	6
Value	Green#Yellow#Orange
Delimiter	#

Note:

The value of the delimiter is Semicolon(;) by default.

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description
Excel Reference	Specify the Reference Name of the Excel file which is used with Excel_Open keyword.
SheetName	Specify the Name of the Sheet where the value of a specified Row has to be Set.
Row	Specify the Row Number of the Excel Sheet whose values have to be set.
Value	Specify the Values of the row separated by a Delimiter
Delimiter	Specify the text/symbol/special characters by which the Row text has to be separated.

Output Data

Condition	Output Value
If the keyword passes successfully	True
If the keyword fails	False

Error conditions

Scenarios

Error Message

Debug Information

If blank 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.

Argument(s) : (ExcelReference;

SheetName;Row;Value) is/are blank.

If the keyword is used without closing the Excel File on the system.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Close the Excel file abcd in order to modify the data of the file.

28. Excel_SetColumnValue

This keyword is used to set the Value of a specified Column in an Excel sheet of an Excel file based on the data input arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword. The Excel file must be closed before using this Keywword.

Example

Excel_SetColumnValue

ExcelReference	abcd
SheetName	Colors
Column	4
Value	Green#Yellow#Orange#Violet
Delimiter	#

Note:

The value of the delimiter is Semicolon(;) by default.

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file which is used with ExcelOpen keyword.
SheetName	Specify the Name of the Sheet where the value of a specified Column has to be Set.
Column	Specify the Column Number of the Excel Sheet whose values have to set.
Value	Specify the Values of the Column separated by a Delimiter
Delimiter	Specify the text/symbol/special characters by which the Column text has to be separated.

Output Data

Condition	Output Value
If the keyword passes successfully	True
If the keyword fails	False

Error conditions

Scenarios

Error Message

Debug Information

If blank 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.

Argument(s) : (ExcelReference;

SheetName;

Column;Value) is/are blank.

If the keyword is used without closing the Excel File on the system.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Close the Excel file abcd in order to modify the data of the file.

29. Excel_UtilityPressKeys

This Keyword press keys to the native application window. It takes keys as Data input argument.

Example

Keys

{ENTER}

Note: The key Name is always provided within { } brackets.

Test Object

Object Input Required	Description
No	Object Input data is not required

Input Data

Input Data Required	Description
Keys	Specify the Key Name which has to be pressed.

Output Data

Condition	Output Value
If the keyword passes successfully	True
If the keyword fails	False

Error conditions

Scenarios

Error Message

Debug Information

If the data Input Arguments are not 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.

Argument(s) : (Keys) is/are blank.

30. Excel_SetCellValue

This keyword is used to set a Cell value in Excel file based on the data input arguments provided.

Note: Excel_Open Keyword is always used prior to this keyword. The Excel file must be closed before using this Keyword.

Example

Excel_SetCellValue

ExcelReference	abcd
SheetName	Colors
Text	Pink
Row	4
Column	1

Test Object

Object Input Required	Description
No	Object Input data is not required.

Input Data

Input Data Required	Description
ExcelReference	Specify the Reference Name of the Excel file which is used with Excel-Open keyword.
SheetName	Specify the Name of the Sheet whose cell value has to be set.
Text	Specify the Text/Value to be set.l
Row	Specify the Row Number whose Cell value has to be set
Column	Specify the Column Number whose Cell value has to be set

Output Data

Condition	Output Value
If the keyword passes successfully	True
If the keyword fails	False

Error conditions

Scenarios

Error Message

Debug Information

If blank 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.

Argument(s) : (ExcelReference;

SheetName;Text;

Row;Column) is/are blank.

If the keyword is launched without using Excel Open keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Some system/application specific settings are preventing this operation. Watch for the applications involved in the current operation. Some of these applications have been wrongly configured. You need to tweak some settings, edit some configuration file, turn a few knobs. The nature and scope of the adjustment will depend on the exact problem faced.

Excel Reference is not opened.

To learn how you can use these keywords in test scenarios, you can visit https://university.opkeylms.com and enroll in our Opkey series course.

List of Keywords - Excel Keywords

To learn how to use Excel keywords in Opkey, you can read Using Excel Keywords - New UI and Excel Keywords - Opkey Classic. Now, let's go through the first list of keywords and their utility.

1. Excel_VerifyColumnCount

This keyword verifies the number of Columns corresponding to the specified Row Number of an Excel file.

Note: The Excel_Open Keyword is always used before this keyword.

ExcelReference

abcd

SheetName

Colors

Row

1

Expected Value

3

Input Data

Input Data Required

Description

ExcelReference

Specify the Reference Name of the Excel file that is used with the Excel_Open keyword.

SheetName

Specify the Name of the Sheet whose number of Columns has to be Verified

Row

Specify the Row Number which will be used to Verify the Column count.

Expected Value

Specify the Expected count of columns corresponding to the specified Row Number of an Excel file

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions

Scenarios

Error Message

Debug Information

If blank data Input Arguments are provided.

Argument Data Missing (-13200)

DESCRIPTION:

A step can't proceed without values for mandatory arguments. Unlike optional ones, compulsory arguments must be filled with data, which can come from a static entry, a previous step's output, or a global variable. Leaving them empty is not allowed.

Argument(s) : (ExcelReference;

SheetName; Row) is/are blank.

If the keyword is launched without using Excel Open the keyword.

Conflicting Configuration (-14400)

DESCRIPTION:

Excel Reference is not opened.

2. Excel_VerifyRowCount

This keyword verifies the number of rows corresponding to the specified Column Number of an Excel file.

Note: The Excel_Open Keyword is always used before this keyword.

ExcelReference

abcd

SheetName

Colors

Column

3

Expected Value

1

Test Object

Test Object Required

Description

None

Not Required

Input Data

Input Data Required

Description

ExcelReference

Specify the Reference Name of the Excel file that is used with Excel_Open keyword.

SheetName

Specify the Name of the Sheet whose number of Columns has to be Verified

Column

Specify the Column Number which will be used to Verify the Column count.

Expected Value

Specify the Expected count of columns corresponding to the specified Row Number of an Excel file

Output Data

Condition

Output value

If the keyword passes successfully

True

if there is an error

False

Error conditions