In OpKey, Suite is a collection of Test Cases for execution. There may be one or more than one Test Cases/Gherkin files for execution. Each Test Case in a Suite should be complete in itself and independent of other Test Cases. You can add, remove, move up/down Test Cases and rearrange them as per their order of execution.

Working with Suites

After successfully login into OpKey Web, select the appropriate Project in which you want to create a Suite.

You will be navigated to the screen having as shown.

You can mark the “Don’t show me again” checkbox as checked if you do not wish to view this notification again.

Click “End Tour” to proceed with the process of creating a Suite file.

How to create a Suite File?

Method 1

After clicking on “End Tour” , you may "Click to Create New Artifact".Select Suite.

The “Suite”  text will appear highlighted

Click on the highlighted icon to create a New Suite file. A pop up window will get open as shown

The fields marked with * are mandatory. Enter the Name of the Suite  . You can also enter the Description.Click OK.

Method 2

Go to Project Workspace > Select the root Folder > Click Create New file icon  > Select Suite  .

A Suite file will be created in the root Folder of the project Workspace.

You may rename the Suite accordingly.

Method 3

Right click on root folder > select Create New > select ‘Suite  .

A Suite  file will be created in the root Folder of the project Workspace.

The Suite  window will open up as shown :


Adding Multiple Test Cases/Gherkin Files to Suite - 

To add test cases/gherkin files in your suite, go to the right pane, scroll down your project files, select and double click on desired Test Case/Gherkin file.

You can also add multiple test cases and gherkin files by selecting all the required Test Case/Gherkin files and clicking on ‘Add Available Test Cases/Gherkin Features’ icon.


Only Test Case(s) & Gherkin file(s) can be added to the Suite.



List of actions that can be performed on Suite - 

Run Now – 

Click on ‘Run Now’ button to start execution. You need to select Session Name, Choose or Create Build, Plugin used, Execution Agent and Generic Plugin to proceed execution process.

Debug Now – 

Debug now helps you execute saved test cases in Debug Mode. It has features like Play, Pause, Stop, Step Info, Step Over, Step Out, Show Call Stack, etc. to debug each step individually. The execution process will run in small popup window in the right side of your browser at the bottom.

Run on Cloud – 

To execute your Suite, click on 'Run on Cloud', a login popup window for OpKey Cloud opens. Enter your UserName & Password and click on Sign in. For more details, refer: http://opkey.com/Help/docs/opkey-help/running-execution-on-cloud/

  • Next, on Execution wizard window, enter batch name, choose or create build, select execution agent and choose generic plugin. (You can check 'Show Advanced Settings' for advanced features regarding configuration of Snapshot of steps (along with quality and step timeout), session tags and global variables. Click on 'Next' to proceed.
  • Choose required cloud OS(s) and Bowser(s) to perform execution on OpKey cloud. Click on 'Next' to proceed.
    A popup box displays the message 'Execution Started Successfully!'

Delete – 

The selected test case/gherkin file(s) can be deleted from the Suite.

  • Select a test case to delete.
  • Clicking on ‘Delete’ will prompt an alert message of delete confirmation.

Click on ‘OK’ button to confirm the deletion. An alternative way of deleting a step is to right-click on any of the available step and select Delete option as well.

Move Up Step – 

Select a test case and click on ‘Move Up Step’ to move selected test case up and this test case will be executed accordingly.

Move Down Step – 

Select a test case and click on ‘Move Down Step’ to move selected test case down and this test case will be executed accordingly.

Save – 

Once all the required changes are done, save the Suite to prevent data loss & save test case.

Refresh – 

Refreshing will reflect all made changes to the Suite.

Right clicking on the added test case allows you to perform other similar actions as shown below.

Now, you can execute your Suite on OpKey Cloud and pCloudy. It handles the test lab setup and maintenance for you and enables parallel test executions over more than 100 web browsers along with different OS combinations. Over pCloudy, you can execute your Suite (Mobile Flow) parallelly over various devices (along with different mobile OS).

Advantages of using OpKey Cloud - 

  • Maximum utilization of the available shared resources (virtual servers and other resources)
  • The flexible, scalable environment helps you to utilize and pay for the resources as per the demand
  • Low operational cost & high ROI
  • Accessible from anywhere

Considering these advantages of cloud environment, we have integrated OpKey with an advanced feature – Run on Cloud, which provides the end-user the capability to execute the created test scripts on a cloud environment remotely.

To work with OpKey Cloud, you just need to follow few simple steps as described further.


Send Execution report at Suite level:

With the help of MailTo feature, you have the privilege of sending execution report in mails to the specified people for a particular Suite. Now whenever this suite will be executed, its execution report will automatically be sent to the selected email IDs. To do so, follow the below-given steps:

  • Go to the Suite window and click on MailTo of dockable panel.
  • Click on Add button to add new email ids.
  • Once the email ids are added, email for Suite Execution Result will be sent only to the selected email ids.
  • In case you wish to delete any email id, select it and click Delete.


If the specified email ID in "MailTo" has also been added in the SMTP settings then only a single mail of Execution report will be sent to the specified email ID.


Executing a Suite : 

You can execute a Suite in different ways:

By using Run Now, Debug Now button & on OpKey Cloud & pCloudy cloud platform.

(A) Executing Suite on OpKey Cloud - 


Go to your Suite > Click on Run on Cloud

When you click on ‘Run on Cloud’, a login popup window for OpKey Cloud opens. Enter your UserName & Password and click on Sign in.


Next, on Execution wizard window, enter batch name, choose or create build, select execution agent and choose generic plugin. (You can check ‘Show Advanced Settings’ for advanced features regarding configuration of Snapshot of steps (along with quality and step timeout), session tags and global variables. Click on Next to proceed.

Choose required cloud OS(s) and Bowser(s) to perform execution on OpKey cloud. Click on 'Next'  to proceed.

Review Purchase Order along with account credit details and selected browser version & OS. Click on Finish.

A popup box displays the message ‘Execution Started Successfully!

Go to the Execution Result > Your Build Name > Batch Name

Once execution has completed, you can expand the execution result and analyze it.

(For more details about Execution Result, refer: http://opkey.com/Help/docs/opkey-help/execution-result/execution-result/)


(B) Executing Suite on pCloudy - 

Go to your Suite > Click on Run on pCloudy

noteBefore executing your Suite, make sure that it contains 'Mobile Flows' only i.e. Test Case & Gherkin files must be Mobile Flows. Otherwise, Suite will gets failed during execution.

To execute your mobile flow Suite over OpKey web, click on 'Run on pCloudy'. A new window opens which asks you to enter your pCloudy credentials (along with API Access Key).

After successful login over pCloudy, you come to the pCloudy execution wizard where you need select 'Plugin' for execution.

You can check 'Show Advanced Settings' option which helps you configure Snapshot of steps (along with quality and step timeout), session tags and global variables. Fill all fields and click on 'Next' to proceed.

In next step, you need to select particular device(s) from the given list of devices. Device list contains a number of android and iOS devices.

In this step, you can review your selected device and mobile OS version. Click on 'Complete' to proceed.

When you click on 'Complete', your execution gets starts. Just after completing the execution process, you can analyze your execution result on Execution dashboard.

Working with Java Exporter



Java Exporter is an advanced feature which allows you to export OpKey Suites from OpKey Web and save it in a Keyword Driven Java Format. The OpKey Suite to be exported should have mobile flows (Test Cases). Once a Suite has been exported, extract compressed folder you can import those files as a Java Project in Eclipse and can be executed from Eclipse itself.

An exported OpKey Suite as Java project can be customized by the user as per requirement and used for executing various mobile test. Thus, it eliminates the need of creating a particular Test Case for each Test Script as there are basic reusable Java codes which can be customized and reused, as per mobile test scenarios.

Steps to import Java code of Suite:

  • Open your Suite in OpKey Web
  • Click on Java Export button

Your Suite (in Java Project format) has been exported in a compressed folder with named as OpKeyExport. You can view it.

Extract the OpKeyExport compressed folder. Now you can view the OpKeyExport folder and its content.

There are few folders and files in the OpKeyExport folder. You can have a look at them.

Let us import these Java Project files in the Eclipse to view the codes.

Follow the below given steps to import the Java Project file to Eclipse.

Click on the File menu and then click Import.

By default, Existing Projects into Workspace is selected. Click on Next to proceed.

Browse and select Root Directory of your OpKeyExport folder. Click on OK.

Check OpKeyExportedProject and click OK.

Here, you can view your exported project files.

Project files are not updated. Right click on the root folder, navigate to Maven and then click Update Project (Alt+F5).

Here, you can view the Java codes of your exported project files. You can use these codes, customize it and use it to execute your Mobile Test script.

Scheduling a Suite

Quick Start Screencast:



While working with Suite, OpKey users can now schedule test execution of that particular Suite. Thus, you don't need to be present during the test execution. There, a new button named as "Schedule this Suite" has been added to the button's list.

When you click on this button, Schedule Suite popup window appears.

Here, you need to fill required fields. You can edit Session name & select desired Build from the dropdown list.

You can select a particular date & time (forthcoming) along with Time Zone for Suite execution.

Further, you need to select online Execution Agent & corresponding Generic Plugin.

You can click on "Show Advanced Settings" option and apply advanced execution settings.

Click on OK to apply Advanced Execution Settings.

You must ensure that OpKey Hub and Execution Agent are online at the scheduled date and time of Suite.

Click on Schedule to schedule the Suite execution.

Once, you have scheduled Suite for test execution, you can go to the Scheduled Session window (showing under the Tools menu) and view list of scheduled sessions.

You can switch to the Executing/Finished Sessions & view ongoing and executed build sessions.

Once, Suite execution has finished, go to the execution session and analyze test result.