1. Home
  2. OpKey Help
  3. 24. Commonly Used Features

24. Commonly Used Features

24.1 SMTP Settings

SMTP Settings is an advanced feature of OpKey which enables you to send your execution result to someone by applying SMTP Settings. To apply SMTP Settings, click SMTP Settings under Tools menu.

SMTP Settings page opens. Fill all required fields and then save it. You can send a Test Mail to the added email id.


24.2 SMTP Settings in Execution Wizard

In case, you have not configured SMTP Settings from Tools menu then you can apply SMTP Settings also from Execution Wizard. Make sure that you have checked Show Advanced Settings option to show Advanced Execution Settings page having SMTP Settings.

Execution Wizard Advanced Settings

Check Show Advanced Settings checkbox and click Next.

Execution Wizard SMTP Settings

Click on SMTP Settings

24.3 Share/Unshare OR

In OpKey Web, Multilingual websites can be tested by using SetOR keyword for which the OR needs to be shared. To share an OR file, right click on OR file in Project Workspace and click Share option.

Share Unshare OR

24.4 Adding Comment keyword

Now, the user can add comments between the Test Steps in Test Case/Function Library file. It is helpful in categorizing Test Steps as per requirement. There will be no effect on the execution of the added comments.


24.5 Open in New Tab in Execution Dashboard

Execution Result Dashboard is the main page of Execution Result which shows a graphical representation of test executions having a different status. This page contains a Test Execution Analytics section which shows completed Test execution sessions (Passed, Failed, InComplete, NotExecuted, & Total). You can view mapped artifacts associated with the selected session.

Right click on the desired session and click Open in New Tab.

Test Execution Analytics

24.6 Open in New Tab in Project Workspace

Open in New Tab feature allows you to open selected folder/artifact in a new tab. Select desired folder/artifact, right on it and select Open in New Tab option.

The desired folder/artifact will get open in a new tab.

Project Workspace Artifact

24.7 Open in New Tab in Project Workspace Dashboard

Project Workspace Dashboard is the Home Page which shows a graphical representation of Project Workspace and Test Executions. This page contains Recently used artifacts in folder: Project Workspace section which includes recently used artifacts of Project Workspace. You can right click on the desired artifact and click Open in New Tab.

Recently Used artifacts

24.8 Attachment

This feature allows you to upload the documents within OpKey. These documents could be of any type like excel, word, image, pdf, etc. but it should not be an executable file. You can use your uploaded document in your Test Script as per your requirement. The uploaded file(s) get saved under the DB, if the File Store Management under the agent utility is chosen as Store in Database otherwise it get stored under the Shared File Storage.

Click on ‘Attachment‘ > Browse & select your file to be uploaded

Tools > Attachments > Attachment Manager > Here you can Add the file you want to use as attachment

Attachment 2

The added file(s) can be deleted, updated, exported or searched by using corresponding buttons on Attachment Manager window.

There are 11 keywords which have been changed/added because of this feature. They are as follows: 

  1. CopyFile
  2. GetCellValueFromExcel
  3. GetFileExtension
  4. GetFileName
  5. GetFileNameWithoutExtension
  6. GetFileSize
  7. GetValueFromCSV
  8. ReadTextFile
  9. CheckFileExist
  10. SearchTextInFile
  11. GetFilePath

Data input parameters has been changed in the above keywords. A new Data Type File has been added. A new tab of Data Input Arguments has been added with the name of Attachment.

New data type can be seen in below mentioned components:

  • While creating Global Variables.
  • While adding an input parameter under Function Library.
  • While creating a custom keyword.


Files with size upto 4 MB can be uploaded in DB. For uploading files more than 4 MB size, user will have to change the “File Store Management” to store in Shared File Storage under the Admin utility.

A Practical Scenario:

In this practical scenario, let us get file name of an attached image file by using GetFileName keyword.

First of all, upload that required image file on the storage location as described above:

Go to Tools Menu > Attachment > Upload your file.

Let us create a Test Case file by adding a Test step having GetFileName keyword. Go to the right pane for providing Data Input Argument and provide path of your file from Attachment tab as shown below:

Attachment 3

Execute this Test Case by clicking on Run Now button:

Attachment 4

Fill all the required fields in Local Execution Wizard:

Attachment 05

Once your execution process gets completed, you can see the execution result and analyse it.


In the result, in Output column you get file name of attached image file by using ‘GetFileName‘ keyword. In the same way you can use the other keywords related to file attachment feature.

24.9 Export AuditTrails of Artifact

Now, OpKey Web users will be able to export AuditTrails of the artifact to the Excel file. To do so, navigate to the dockable panel of the artifact, click on AuditTrails and then click on Export Audit Trails. A new window of Export to Excel opens from where you can provide Report Name, select a Date Range of maximum 90 days and click on Export. You can view your exported Audit Trails Excel file.

24.10 Reset Object button in Function Library & Test Case

Now, OpKey user can remove the mapping of the associated object from the test step. To do so, you just need to select the desired test step having associated object and click on the remove mapping button under the Object Repository tab.

24.11 Export & Import Artifacts

One of the most awaited feature of this OpKey Web release is export and import artifacts. Now, OpKey users can export existing artifacts and import external artifacts to the OpKey. By using this feature, you can share desired artifact(s) to someone on OpKey Web. This feature is very useful while sharing artifacts among the locally hosted OpKey Web environments. In such cases, you just need to export the desired artifacts from locally hosted OpKey Web system, store in USB, place it to the locally hosted OpKey Web system and import the artifacts. Apart from that, our existing artifact sync feature allows you to sync artifacts from an OpKey Web production environment to another respective environment.

  • Right click on the selected artifact and click on Export.

 Here, you can have a look at your exported artifact.

This exported artifact is portable and you can import it at any other OpKey Web environment.

Let us see how to import this artifact.

Go to the Project Workspace tab on OpKey Web & click on Import Artifact button.

A new window opens which asks you to to browse and select the artifact to be imported.

Here, you can view the Artifact Import details.

Navigate to your Project Workspace & view the imported.

24.12 Using Copy, Paste & Replica features

OpKey allows its users to use copy, paste & make replica of the required artifact in OpKey. You can copy child & parent node but you can paste or make replica of copied parent/child node only within a parent node.

In case of making duplicate (Copy & Paste) artifacts, when you copy a test case file which is mapped with any other artifact (FL, OR, DR etc.) file then you are able to paste that test case file at desired location and it will remain mapped with the earlier mapped artifact file.

Let us see how to use these features.

  • Right click on desired artifact & click on Copy option.

  • If you want to make duplicate artifact of the copied artifact then right click on the desired folder and click on Paste option.

  • Here, you can view that the copied artifact has been pasted here under the desired folder but it will remain mapped with the earlier mapped artifact file.

  • If you want to make replica of an artifact then right click on the desired artifact and click on Copy option.

Note: When you make replica of copied test case which is mapped with any other artifact (like OR, DR, FL etc.) file then all the associated artifacts are also copied and pasted at desired location in the auto-created folder named as Dependent_Artifacts. Thus, this replica test case will be independent test case file and there will be no relation between this test case file and the earlier mapped artifacts.

  • Right click on the desired folder & choose Replica option.

  • Replica window opens from where you can add tags also. There is an notification message with checkbox that “Folder containing Gherkin/Sparkin file will not be replicated with any data. Only blank Gherkin/Sparkin file will be created at the destination end.” You can uncheck this checkbox, if required.
  • Click on Apply to make replica of the copied file.

  • Making Replica process is going on.

  • Replica file been created successfully. It also displays the no. of artifacts created with consumed time period.

  • Here, you can view that the replica has been created successfully along with a Dependent_Artifacts folder as shown below.

Was this article helpful to you? Yes No