List of Keywords - System Keywords 2

To learn how to use System keywords in Opkey, you can read Using System Keywords - New UI and Using System Keywords 1 - Opkey Classic.
 

Now, let's go through the second list of various system keywords to understand their utility.

 

1. FetchRecordSetFromDatabase 

 

The primary purpose of the FetchRecordSetFromDatabase keyword is to fetch a record set from a database. This keyword is used to fetch a #:#:#:# separated recordset database. 

 

Let's understand the keyword by an example:-

Suppose there is a "users" table with columns such as "id," "name," "email," and "department," and you want to fetch all records where the department is 'IT'. 


Now to fetch the record set from the database you will need to execute the following query in your test case:-


FetchRecordSetFromDatabase Query : SELECT * FROM users WHERE department = 'IT' ;

Here ,the FetchRecordSetFromDatabase is the Opkey keyword that is used to retrieve a record set.

The Query parameter specifies the SQL query to be executed. You will enter this query in the input data field.

As a result, it will fetch all the columns (*) from the "users" table where the department is 'IT'.

The result of the query will be a set of records matching the criteria.

 

In the FetchRecordSetFromDatabase Keyword, there was no requirement to add a Test Object argument. Hence, we have mentioned it is not required.


Test Object


Test Object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data


Input Data Required

Description

Query

Specify the Database Query 

CommandTimeOut

Specify the command timeout


Output Data

Condition


Output value

If the keyword passes successfully

The query will be executed and will display the desired output

If there is an error

False


 

  

Error conditions


Conditions

Error Message 

Debug Information 

When Invalid data arguments are provided. 

Argument Data Invalid (-13300)  

DESCRIPTION:  

The data value for one or more input arguments does not match the expected format or predefined set of values. Please review for spelling errors and capitalization. 

CresTech.OpKey. 

Exceptions. 

MalformedQuery 

Exception: Unable to execute the query. Possibly syntax error or insufficient parameters. 

When no 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. 

One or more of the arguments have not been provided a value. 

  

 

2. FetchAllRecordsFromDatabase 

 

The FetchAllRecordsFromDatabase query is used in Opkey to retrieve all records from a specified database table. This keyword is used to fetch a  @:@:@:@ separated recordset database


Let's understand the keyword with an example.

 Assume that you have an "employees" table with various columns like "employee_id," "first_name," "last_name," "email," and so on.

Now you want to fetch all the records of the employee table from the database.

You will use the following query:-

FetchAllRecordsFromDatabase Query: Select*from employees;

Here the FetchAllRecordsFromDatabase keyword is used to fetch all records from the "employees" table.

The Query parameter specifies a simple SQL query to select all columns (*) from the "employees" table. You will enter this query in the input data field.

The result of this query will be, all the records from the "employees" table.



In the FetchAllRecordsFromDatabase Keyword, there was no requirement to add a Test Object argument. Hence, we have mentioned it is not required.


Test Object


Test Object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data


Input Data Required

Description

Query

Specify the Database Query 

CommandTimeOut

Specify the command timeout


Output Data

Condition


Output value

If the keyword passes successfully

The query will be executed and will display the desired output

If there is an error

False


 

  

Error conditions

 

Conditions

 

Error Message 

Debug Information 

When Invalid data arguments are provided. 

Argument Data Invalid (-13300)  

DESCRIPTION:  

The data value for one or more input arguments does not match the expected format or predefined set of values. Please review for spelling errors and capitalization. 

 

CresTech.OpKey. 

Exceptions. 

MalformedQuery 

Exception: Unable to execute the query. Possibly syntax error or insufficient parameters. 

When no 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. 

One or more of the arguments have not been provided a value. 

 

3. FetchValueFromDatabase 

 

This keyword fetches a single value from the database


Let's assume you have a table named users in your database with columns username and email.

If you want to fetch the email address of a user based on their username, you can do so by using the FetchValueFromDataBase keyword.


In this scenario, the FetchValueFromDatabase keyword can be used to execute a SELECT query - ."SELECT email FROM users WHERE username = ?;"   taking username as a parameter to fetch the corresponding email address, and returns the result.


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Object input Argument Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data


Input Data Required

Description

Query

Specify the Database Query 



Output Data

Condition


Output value

If the keyword passes successfully

The query will be executed and will display the desired output

If there is an error

False


 

  

Error conditions

 

Conditions

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 spelling errors and capsing. 

CresTech.OpKey Exceptions: MalformedQuery. Unable to execute query due to syntax error or insufficient parameters.

When no 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. 

One or more of the arguments have not been provided a value. 

 

4. FetchValueFromProcedure 

This keyword fetches a single value from a procedure. 


Let's assume you have a stored procedure named get_email_by_username that takes a username as a parameter and returns the corresponding email address.


Now to fetch the email address of a user from this procedure, you have to provide input data in the following manner.

  


Procedure Name 

get_email_by_username 

Param Name  

username

Param Value 

Sakshi


The result will be the corresponding email address.


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Object input Argument Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data


Input Data Required

Description

Procedure Name 

Specify the Procedure Name. 

Param Name
Specify the Name of the parameter 
Param Value 

Specify the Value of the parameter 



Output Data

Condition


Output value

If the keyword passes successfully

The query will be executed and will display the desired output

If there is an error

False


 

  

Error conditions

   

 

Conditions

Error Message 

Debug Information 

If no Data Input Argument is 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. 

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 does not match the expected format or predefined set of values. Please review for spelling errors and capitalization. 

Data Not Provided 

 

5. GetColumnCountOfRecordSet 

 

This keyword fetches the number of columns of a record set


Assume that you have an "employee" table and you want to know the column count of that table. You can use the keyword with input query - get_column_count_of_record_set(employee) to retrieve information about the number of columns in the employee table. 

e): 

In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Object input Argument Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data


Input Data Required

Description

Query

Specify the Database Query 



Output Data

Condition


Output value

If the keyword passes successfully

The query will be executed and will display the desired output

If there is an error

False


 

  

Error conditions

 

Conditions

Error Message 

Debug Information 

When Invalid data arguments are provided. 

Argument Data Invalid (-13300)  

DESCRIPTION:  

The data value for one or more input arguments does not match the expected format or predefined set of values. Please review for spelling errors and capitalization. 

CresTech.OpKey. 

Exceptions. 

MalformedQuery 

Exception: Unable to execute 

the query. Possibly 

syntax error or insufficient parameters. 

When no 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. 

One or more of the arguments have not been provided a value. 

 

6. GetRowCountOfRecordSet 

 

This keyword fetches the number of rows of a record set


Assume that you have an "employee" table and you want to know the row count of that table. You can use the keyword with input query - get_row_count_of_record_set(employee) to retrieve information about the number of rows in the employee table. 

 

In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Object input Argument Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data


Input Data Required

Description

Query

Specify the Database Query 

 

Output Data

Condition


Output value

If the keyword passes successfully

The query will be executed and will display the desired output

If there is an error

False


 

  

Error conditions

 

 

Conditions

Error Message 

Debug Information 

When Invalid data arguments are provided. 

Argument Data Invalid (-13300)  

DESCRIPTION:  

The data value for one or more input arguments does not match the expected format or predefined set of values. Please review for spelling errors and capitalization. 

CresTech.OpKey. 

Exceptions. 

MalformedQuery 

Exception: Unable to execute the query. Possibly syntax error or insufficient parameters. 

When no 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. 

One or more of the arguments have not been provided a value. 

 

7. UpdateDatabase 

 

This keyword executes the update database query which is run to modify the existing records in a table. It allows you to change the values of one or more columns in one or more rows based on a specified condition. 


Let's say you have a table named users with columns user_idusername, and email. You want to update the email address for a user with a specific username: 


You can use the query - UPDATE users SET email = 'joe@gmail.com' WHERE username = 'joe'; 

This query will update the email column in the users table, setting it to 'joe@gmail.com' only for the row where the username is 'joe'. 


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Test object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data


Input Data Required

Description

Query

Specify the Database Query 

 


Output Data

Condition


Output value

If the keyword passes successfully

The query will be executed and will display the desired output

If there is an error

False


 

  

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 does not match the expected format or predefined set of values. Please review for spelling errors and capitalization. 

CresTech.OpKey Exceptions: MalformedQuery. Unable to execute query due to syntax error or insufficient parameters.

When no 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. 

One or more of the arguments have not been provided a value. 

  

8. Date Time Keywords

 

(I). ConvertTimeToTimeZone 


This keyword converts the time from source to destination time zone concerning the time of our local system.  


It is employed when there's a need to convert time from a source time zone to a destination time zone, especially when the working system is configured in a different time zone. 


For Example: If you want to change the time from “India Standard Time”, to “US Eastern Standard Time”, you can use this keyword. 


You can provide the following data input arguments. 


Select the "source time", provide “SourceTimeZone” as “India Time Zone” and provide “DestinationTimeZone” as “US Eastern Standard Time”. 

 


SourceTime 

2/7/2017 12:00:00 AM 

SourceTimeZone 

India Time Zone 

DestinationTimeZone 

US Eastern Standard Time 

It will provide time according to the destination time zone in output. 


Note: Source time will be the time of your system, and to get names of time zones you can go to this link” https://technet.microsoft.com/en-us/library/cc749073(v=ws.10).aspx. 


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Test Object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data



Input Data Required

Description

SourceTime 

Specify the requirements which you want to use for conversion. 

Note: This time will be available to you as per your local system. 

SourceTimeZone 

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 

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 Data


 Condition  Output Value

If the provided time zone is of the correct format. 

Time according to destination time zone 

If provided data input arguments are blank or have an invalid format. 

False

Error Conditions


Condition 

Message 

Debug Info 

If the specified time zone is blank. 

Argument Data Missing 

Timezone argument is missing. 

If the specified time zone is invalid. 

Argument Data Invalid 

The time zone ID 'US' was not found on the local computer 

 

(II). GetTimeAtTimeZone 

 

This keyword offers the time of a specified time zone in relation to the local system time. It proves useful when obtaining the time of different time zones while your working system is configured in a 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”. 


In the given example, if you wish to retrieve the time for the US, input "US Eastern Standard Time" in the "timezone" data input argument of the "GetTimeAtTimeZone" keyword. This will provide the time for the specified time zone. 


TimeZone 

Provide the correct time zone 


Note: Source time will be the time of your system, and for getting names of time zones you can go to this link” https://technet.microsoft.com/en-us/library/cc749073(v=ws.10).aspx . 


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object



Object Input Arguments Required?

Description

No

This keyword doesn’t take any object input argument.



Input Data



Input Data Required

Description

Timezone 

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 Data


 
  Condition


  Output Value


If the provided time zone is of the correct format. 

Time of specified timezone 

If the timezone provided is blank or has an invalid format. 

False



Error Conditions


Condition 

Message 

Debug Info 

If the specified timezone is blank. 

Argument Data Missing 

Timezone argument is missing. 

If the specified timezone is invalid. 

Argument Data Invalid 

The time zone ID 'US' was not found on the local computer 

  


(III). AddDateTime 


This keyword adds a specific number of days, months, years, hours, minutes, and seconds to each date value. 


Suppose you want to add a specific number of days, months, years, hours, minutes, and seconds to your date (12/20/2023)


Here you can provide the input data in the following manner to get the desired output.

  

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

 

In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Test Object Required?

Description

No

This keyword doesn’t take any object input argument.




Input Data



Input Data Required

Description

Date Time 

Years 

Months 

Days 

Hours 

Minutes 

Seconds

Provide Date Time Format 

 Provide Years 

 Provide Months 

 Provide Days 

 Provide Hours 

 Provide Minutes 

 Provide Second 


Output Data

  

 Condition  Output Value

If the keyword passes successfully 

It should give the Date and Time of the Current Day 


Error Conditions

  

Input 

Output 

Status 

Error Message 

DateTime : 

Years :  

Months :  

Days :  

Hours :  

Minutes : 

Seconds :  

  

Fail 

Argument Data Missing 

 

(IV). ConvertDateTimeFormat 

 

This keyword converts Date Time value according to some specified format. 


Suppose you want to convert the date time format as M/d/yyyy/m/h/s, you can provide input data in the following manner to get the desired result.

  

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 


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Test Object Required?

Description

No 

This keyword doesn’t take any object input argument.




Input Data



Input Data Required

Description

DateTime and Format

Provide the Date Time 

and the desired Format 


Output Data


  

 Condition 
  Output Value

If the keyword passes successfully 

It should give the Converted date time as par Provided date time 


Error Conditions

  

  

Keyword Name 

Input 

Output 

Error Message

ConvertDateTimeFormat 

DateTime: 

FormatString: 

False 

 Argument Data Missing  


(V). DateTimeDifference 


This keyword returns the date difference in total days. 

You can use this keyword if you want to calculate the day difference between two dates.


you can provide input data in the following manner to get the desired result. 



Keyword Name 

Input 

Output 

Status 

DateTimeDifference 

FirstDate:2/16/2017 

SecondDate:2/16/2018 

DateFormat:M/dd/yyyy 


365 
Pass


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object

Test Object Required?

Description

No

This keyword doesn’t take any object input argument.



Input Data


Input Data



Input Data Required

Description

First Date 

Give Date string 

For Example:2/15/2017,2-15-2017 

Second Date 

Give Date string 

For Example:2/15/2017,2-15-2017 

 

Format 

Give Date Format 

dd/MM/yyyy, dd-MM-yyyy 

 


Output Data

  

 Condition 
  Output Value

If the keyword passes successfully 

It should give the Number of days difference. 


Error Conditions



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

2. Provide FirstDateSecondDate but don’t Provide Format 


Input 

Output 

Status 

Error Message 

FirstDate:2/16/2017 

SecondDate:2/16/2018 

DateFormat: 

365 

Pass 

Done 

3. Don’t Provide Input Argument 


Input 

Output 

Status 

Error Message 

FirstDate: 

SecondDate: 

DateFormat: 

  

Fail 

Argument Data Missing 

 

(VI). GetCurrentDateTime 

 

This keyword gets the Current Date and Time of the system. It is used in such a condition when the user wants to get the current day's Date and Time. 


Suppose you want to get the current data time, you can use this keyword in the following manner with no use of input data to get the desired result.



Keyword Name 

Input 

Output 

Status 

GetCurrentDateTime 

No 

2/15/2017 7:43:19 PM 

Pass 

 


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Test Object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data



Input Data Required?

Description

No

This keyword doesn’t take any input data argument.


Output  Data


  

 Condition 
  Output Value

If the keyword passes successfully 

It should give the Date and Time of Current Day 



(VII). GetDayOfWeek 

 

This Keyword gets the current weekday number. It uses dates to provide the weekly number. 



If the user uses this keyword on 14 of Feb, then it gives the output as 2 and if the user uses this keyword on 15 of Feb, then it gives the output as 3. You can use the keyword in the following manner:-


 

Keyword Name 

Input 

Output 

Status 

GetDayOfWeek 

No 

3 

Pass 

 

In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object



Test Object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data



Input Data Required?

Description

No

This keyword doesn’t take any input data argument.

 

Output Data

  

 Condition 
  Output Value

If the keyword passes successfully 

It should give Date Time of the current Day. 


(VIII). IsDate 

 

This Keyword verifies the given date format. It is used in such a condition where the user wants to verify provided date is in date format or not. 


The user can use this keyword in the following manner to check whether the date provided is in the date format or not.


Keyword Name 

Input 

Output 

Status 

         IsDate 

DateString: 2/15/2017 

DateFormat: MM/dd/yyyy 


  True  Pass


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object



Test Object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data



Input Data Required


Description

DateString 

Give Date string 

For example 2/15/2017,2-15-2017 


                         DateFormat 

Give Date Format 

dd/MM/yyyy, dd-MM-yyyy 


 


Output Data

  

 Condition 
  Output Value

If the keyword passes successfully 

 

True



Error Conditions


1. Provide Valid String and Invalid Format 


Input 

Output 

Status 

Error Message 

DateString:2/15/2017 

DateFormat:MM-dd-yyyy 

False 

Fail 

Argument Data Invalid 


2. Not Providing Input Argument 


Input 

Output 

Status 

Error Message 

DateString:2/15/2017 

DateFormat:MM-dd-yyyy 

False 

Fail 

Argument Data Missing 

 

(IX). SubtractDateTime 

This keyword Subtracts Date Time a specific number of daysmonthsyearshoursminutes, and seconds in a given date value. 


You can use this keyword in the following manner:-


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

 

In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object



Test Object Required?


Description

No

This keyword doesn’t take any object input argument.



Input Data



Input Data Required?

Description

Date Time 

Years 

Months 

Days 

Hours 

Minutes 

Seconds 

Provide Date Time Format 

Provide Years 

Provide Months 

Provide Days 

Provide Hours 

Provide Minutes 

Provide Second 

 

Output Data

  

 Condition 
  Output Value

If the keyword passes successfully 

 It Should give Date time after subtraction of Years, Months, Days, Hours, Minutes, Seconds 



Error Conditions



1. Don’t Provide Input Argument 


Input 

Output 

Status 

Error Message 

DateTime : 

Years :  

Months :  

Days :  

Hours :  

Minutes : 

Seconds :  

  

Fail 

Argument Data Missing 

 

9. File Handling Keywords 


(I). AppendTextToFile 


This keyword appends specified text to the given File. It is used in such a condition where the user wants to add Specific Text to a file.


 You can use this keyword in the following manner to add specific text to a file. 


Keyword Name 

Input 

Output 

Status 

AppendTextToFile 

FilePath: File path that exists 

TextToAppend: ABCD 

True 

Pass 


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object



Test Object Required?

Description

No

This keyword doesn’t take any object input argument.



Input Data



Input Data Required


Description

FilePath 

Give the Path of the File which exists on the system  


                         TextToAppend 

Give Text which you want to add to the File 

 


Output Data

  

 Condition 
  Output Value

If the keyword passes successfully 

 True



Error Conditions


1. Don’t Provide FilePath or TextToAppend 


Input 

Output 

Status 

Error Message 

FilePath: 

TextToAppend: 

False 

Fail 

Argument Data Missing 

2. Provide File path which does not exist. 


Input 

Output 

Status 

Error Message 

FilePath: 

TextToAppend: 

  

Fail 

Argument Data Invalid 

 

(II). CheckFileExists 


This keyword checks whether the file exists or not. 


 You can use this keyword in the following manner to check whether a file exists or not.


Keyword Name 

Input 

Output 

Status 

CheckFileExist  

FilePath: File path that exists 

True 

Pass 


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.



Test Object


Test Object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data



Input Data Required?

Description

FilePath 

Give the Path of the File that exists on the system. 

 

Output Data


  

 Condition 
  Output Value

If the keyword passes successfully 

 True



Error Conditions

 


1.  Provide a File path that does not exist 


Input 

Output 

Status 

Error Message 

FilePath: File path that does not exist. 

False 

Fail 

Argument Data Invalid 

 

(III). CopyFile 

This keyword copies the file from source to destination. It. It is in such a condition that the user wants to copy a file from one location to another location. 


You can use this keyword in the following manner:- 

 

Keyword Name 

Input 

Output 

Status 

        CopyFile 

SourceFilePath:‪C:UsersABCD.txt 

Destination Directory Path:C:UsersUserNameDesktop 

Destination File Name:EFGH 

Overwrite:True 


      True 
   Pass


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Test Object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data



Input Data Required?

Description

Source File Path: 

Destination Directory Path: 

Destination File Name: 

Overwrite: 

Provide File Path 

Provide a Destination File Directory where you want to copy the File 

Provide the Destination File Name(with extension or Without Extension) 

If checked so, Overwrite the Existing file if not checked then do not Overwrite Existing File 

 

Output Data

 

  

 Condition 
  Output Value

If the keyword passes successfully 


 True

 
 If there was an error 

   False


Error Conditions


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

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

 

(IV). CreateFile 


This keyword Creates 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). 


Example 


Use the "Create File" keyword to generate a file at a specified location (e.g., D: drive in a folder). Provide the path in DirectoryPath, specify the FileName, and choose whether to overwrite an existing file by toggling the checkbox. 



Object 

< No Object Input Arguments is required. > 

  

DirectoryPath 

D:Create folder 

FileName 

Books 

Overwrite 

True 

 


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object


Test Data Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data 



Input Data Required


Description

DirectoryPath 

Specify the Path where the File has to be created. 


                        FileName 

Specify the FileName from which name you want to Create the File. 

                        Overwrite 

  

Select the checkbox as True or False 

Note: If any File with the same name exists at that location then you can Overwrite the file by selecting Checkbox. 

 


Output Data

 


 Condition 
  Output Value

If the keyword passes successfully 

 True

 
 If there was an error 

   False

If provide an invalid path. 
   Blank


Error Conditions

 


Conditions 

Message 

Debug Information 

If provided an 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 provided 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 

 

(V). DeleteFile 

 

This keyword deletes a file from a specified location. Provide values in FilePath and deleteFilePermanently. If deleteFilePermanently is set to True, the file will be permanently deleted; if set to False, the file will not be temporarily deleted. 


Example 


To delete a file from a specific location, such as in the "Create folder" within the D: drive, use the "Delete File" keyword. Provide a valid path in DirectoryPath and select the checkbox in deleteFilePermanently for permanent deletion. 



Object 

< No Object Input Arguments is required.> 

FilePath 

D:Create folderbooks.txt 

deleteFilePermanently 

True 

 
 

File path can be provided as static value or through Global variable and Attachment in Input Argument. 


In this Keyword, adding a Test Object argument was not required. Hence, we have mentioned it is not required.


Test Object



Test Object Required?

Description

No

This keyword doesn’t take any object input argument.


Input Data



Input Data Required


Description

FilePath 

Specify the Path from where the File has to be deleted. 

                         DeleteFilePermanently 

Select checkbox  

* True if want to delete the file permanently  

* Deselect checkbox i.e. False if do not want to delete the file permanently. 

 


Output Data


  

 Condition 
  Output Value

If the keyword passes successfully 

 True

 
 If there was an error 

   False


Error Conditions


Conditions 

Message 

Debug Information 

If provided Invalid Path 

< Argument Data Invalid (-13300) > 

Not a Valid Path. 

If provided Null Path 

< Argument Data Missing (-13200) > 

The file Path argument is missing. 

If the file doesn’t exist 

Argument Data Invalid (-13300) 

Not a Valid Path. 



Click here to go through the third list of system keywords in Opkey.


Click Here to learn more about Opkey features.

To learn more about using these keywords in a test case, you can visit https://university.opkeylms.com and enroll in our Opkey series course.

 

  

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article