32.10 OpKey Release – 5.55

Note: OpKey 5.53 and 5.54 were our internal releases.

New Features

Snapshots of Failed Steps in Gherkin Report

Now, OpKey users can add snapshots of the failed steps to the exported Gherkin Report in PDF file. In this way, the exported Gherkin Report contains the failed steps along with the snapshots. In order to add failed step snapshots to the report, you need to check “Failed Step’s Snapshots” checkbox while exporting the Gherkin Report of executed Gherkin file and then export the Gherkin Report. Once the Gherkin Report is exported, you can have a look at the Failed Step along with the link (View Snapshot). When you click on the View Snapshot link to view the snapshot of the respective failed step, it opens the snapshot located on the local or cloud server. You should be aware about the snapshots located on the AWS server, as they exist there only for 7 days and get deleted automatically after that.

Comparison between the working file and its backup

OpKey users can now compare the current working file with its backup file. Thus, you can easily compare the changes done in both files and analyze them. You can easily identify the changes done in your current file. To compare the current working file with an existing backup of this file, you need to click on the Compare backup button of the corresponding backup file showing under the dockable panel in the Backup tab.

License Upgrade from OpKey Admin Panel

Here a new “License Management” page has been added to the OpKey Admin console. You can see the license-related information on this page which is divided into three sections as Component License, Platform License & Feature License. OpKey user with Admin privileges can now make a request for the license and once the license file is received then you can upgrade their licenses from the License Management of Admin console. To make a request for the license file, click on the “Request License” button & drop a mail to support@opkey.com requesting for the required license. OpKey support team will acknowledge and generate requested license keys and share with you. Once you received the license file and you can upgrade the license by clicking on the “Upgrade License” button & selecting the license file. The respective license of the OpKey will get updated as per the added license key.

Introducing new APIs for getting execution result of Test Case & Suite

There are few new APIs in the OpKey which allows OpKey users to get execution result information about the executed Suites and Test Cases without accessing OpKey directly. You can use these APIs with API Tools like Postman & SoapUI. These APIs are:

  1. Authorize
  2. GetSuiteResult
  3. GetTestCaseResult
  • The first API Authorize takes Username and Password of the OpKey Web and generates a unique Authentication Token by using the Post method. The generated Authentication Token will be further used by the next API for accessing the execution result information of executed Test Case and Suite.
  • The second API GetSuiteResult retrieves the test execution result of the executed Suite in Json format with the help of Authentication Token generated by the Authorize API using Get Method.
  • The third API GetTestCaseResult retrieves the test execution result of the executed Test Case in Json format with the help of Authentication Token generated by the Authorize API using Get Method.


While working in your local hosted OpKey web environment, if you have executed your Test Case or Suite using the OpKey APIs & the snapshots of test execution are being stored in your local shared location then the snapshots will be accessible only in your local network. In case, you are trying to access them from a different network then they would not be accessible.

While working in your OpKey web environment hosted on AWS Server, if you have executed your Test Case or Suite using the OpKey APIs & the snapshots of test execution are being stored on AWS Server then the snapshots will be accessible only for 7 days of completed test execution, as per the policy of AWS server. In case, you are trying to access them from after 7 days of completed test execution then they would not be accessible as they are removed automatically from the AWS server.

Introducing OAuth 2.0 authentication type in Service Repository

OpKey Web is now integrated with Oauth 2.0 authentication type for testing Web Services & APIs through Service Repository. Here, you need to provide Service URI of the Web Service or API and respective Jason Web Token (JWT) for authentication. If you don’t have JWT authentication token then you need to generate it. Here is a button, Get Token; when you click on the “Get Token” button, a popup window of “Get Access Token” appears where you need to enter the required details like Grant Type, Callback URL, Auth URL, Access Token URL, Client ID, etc. and then request for the Access Token. Make sure that OpKey Chrome Addon is integrated with your Chrome browser. Once you got the Access Token, enter it to the Token field and then add methods to test the OAuth 2.0 based Web Services & APIs.

Testing APIs with Certificate

There are some APIs that reject method calls having no certificate. Such APIs accept method calls only with valid certificates. Now OpKey allows you to test such APIs with a valid certificate. You can now select a certificate from your local system or upload the certificate from the Attachment Management in OpKey and then use it while testing the corresponding API through Service Repository in OpKey.

Mainframe Recorder, Plugin and Keywords

OpKey has now been integrated with the Mainframe recorder & Plugin engine. OpKey users can now use mainframe recorder and record actions performed on the Mainframe and easily create a Test Case. There are some mainframe specific keywords implemented in this OpKey release. These keywords work only with the Mainframe application. Once the Test Case is created, you can execute it using the all-new Mainframe Plugin engine.

Improved Result Architecture

Now the result architecture of OpKey has now been improved. A new dedicated result server has been installed which results in improved performance of loading the execution results data. Now the uploading time of execution logs, snapshots data has been optimized.

Build Status Dashboard

The user interface and filter functionality execution result dashboard has now been improved significantly. You can now navigate to the Build Status Dashboard page by clicking on the “Click here to see all build(s) by date” link. Build Session Dashboard allows you to refine your test execution result and export report. You can select Start Date, End Date and desired Build and see the respective executed builds details. You can check Show Sessions checkbox to enable the Session dropdown option and then view the corresponding session(s) details. You can also view currently executing/running executions by selecting Running as Status. You can download Build and Build-Session Report in PDF or Excel Format with default or custom logo.

Database Backup Utility

OpKey Users can now easily take a backup of the existing OpKey database and restore the backup of the database by using the DB Backup utility. There are two ways to use this utility: using CLI command and by using GUI based utility. Here, you need to provide some basic information about the database.

Appium Plugin Enhancements

  • Appium java-client has now been upgraded from version 3.3.0.jar to Appium-java-client version 7.0.0.jar.
  • New XHR wait has been implemented for the Appium web.
  • Get and Verify keywords have now been implemented for Appium Web.

There are few new Appium specific keywords added in OpKey. They are given below:

  • SetLocation (For Appium Android)
  • SwitchWiFi (For Appium Android)
  • RunAdbCommand (For Appium Android)
  • SwipeToObject (For Appium Native)
  • SwipeTowards (For Appium Native)
  • ByText (for browsers in the mobile device)

OpKey Mobility – Android feature enhancements

  • Now, there is a new parameter named as Accessibility ID added in the object property for android native applications.
  • Now the OpKey Mobicast feature supports new Android version 10 as well.
  • Users can now perform image-based execution (beta version) on mobile devices having the same configuration and same version.
  • There are few new keywords added in the dropdown list on the recorder page. You can add any keyword from the list and corresponding object from the object list (fetched objects) and perform an action on that object.
  • Now the object gets highlighted, on which action is being performed during test execution for native and hybrid applications.
  • Now the toast message functionality also supports devices with android version 7 & below.
  • Two new OpKey Mobility-Android specific keywords have been added in this OpKey release and they are Mobile_SetNumberPicker & Mobile_WaitForObjectDisappear.

OpKey Mobility – iOS feature enhancements

OpKey Mobility-iOS plugin functionality has now been improved. Now it launches iOS apps automatically during playback and captures screenshots. Three new OpKey Mobility-iOS plugin-specific keywords have been added in this release. They are as given below:

  1. DI_Click
  2. DI_SendtextOnMobileDevice
  3. DI_PressHomeButton

Other Enhancements

  • While executing a test in debug mode, now you can view the output of the previous test step also. You can now view the complete name of the arguments having a long name by clicking on the new View button.
  • Now the external tool integration feature has been integrated with the OpKey Accelerator. By now, it supports ALM and you can work with it using ALM specific keywords.
    Now, you can generate a detailed PDF report of your Test Case and Suite execution by applying settings to your Agent data. You need to open the XML file from the path (C:\Users\UserName\AppData\Local\CresTech\OpKey\AgentData\Configuration.xml). Open this XML file and add <CreateReportOfEachFlowAt>D:\Reports</CreateReportOfEachFlowAt> tag in which D:\Reports denotes the path location where the PDF reports get saved. In the case of executed Suite, a folder with the Suite name and session id gets created at the specified path which contains the reports for the executed test cases mapped under the Suite.
  • Now, ALM specific keywords also work with the Function Libraries but you need to check the “Update mapped test management artifact” checkbox under the advanced execution settings.
  • OpKey users can now execute test execution on the Safari browser on the Mac machine also.
  • A new PeopleSoft specific keyword (PS_TypeByTextAndEnter) has been added in this release.
  • In OpKey 5.55 release, you can no longer select multiple build and session to generate session dashboard in Accelerator. However, you can still select a single build and session to generate it.
  • OpKey Login page interface has now been improved. Now, it contains random images along with the link to view the corresponding tutorial video.
  • While compiling the written code of Coded FL, the downloaded teleporting tunnel jar now contains the encoded token. It further communicates with the OpKey server and fetch the required data and then compiles the Java code.

Note: You are recommended to download & install the latest released OpKey Agent for test execution.

Major Bug Fixes

Known Issues


No items found.