1. Home
  2. OpKey Help
  3. 3. Getting started with OpKey
  4. 3.3 OpKey Modules

3.3 OpKey Modules

OpKey contains following modules which make it a complete solution for all test automation needs. Every module deals with a specific test scenario.

Test Case

Test Case is a collection of test steps which contain a Keyword, a Control Flow Construct or a Function Library. Further, a Keyword can take either no input or can take object, data, or both as inputs. Each test step also returns an output which can be used as input for other test step as well. Test Case module is integrated with recording feature which helps while recording actions performed on a web application and create a complete test case easily and quickly.

Object Repository

Object Repository is a collection of objects fetched from a web application. OpKey fetches objects from the dynamically changing application by identifying them with their expected values and properties. Object Repository allows you to add objects in different ways: Add to OR and Highlight OR. In addition, you can perform all necessary operations, such as Add, Edit, Copy, Refresh, Delete and Search object repository. Objects in Object Repository defined by the end user can be arranged in a modular structure. Before executing the application, you should ensure that Object Repository contains all the objects to be used by your test scenario.

Global Data Repository

Test data plays an important role in a test automation. There may be different test scenarios which need to be parameterized for successful testing of the application. In such scenarios, OpKey provides a user friendly data storage and management feature known as Global Data Repository. Global Data Repository module provides flexibility to the user to add and manage data by providing features to add rows/columns, move rows or cells, copy/paste the data and save it as well. The Global Data Repository contains a spreadsheet which is divided into number of rows and columns. This Global Data Repository can be used while parameterizing the test and user can add data in the corresponding rows and columns. Data in the global data repository can be used during subsequent iterations.

Local Data Repository

Local Data Repository is a type of spreadsheet which contains data that can be used for test iterations in OpKey Web. While working with Test Case(s) in OpKey Web, now you can use your data from the Local data Repository for iterating the Test Case. You can either create Local Data Repository file or import data from an Excel sheet (.xlsx files only) as per your convenience. You can switch to the Local Data Repository mode to provide data driving values from your Local Data Repository. The Data Repository consists of a spreadsheet which is divided into number of Datasets and Datasets into rows and columns. While working with Test Case in OpKey Web, you can provide data driving value either from Global Data Repository or from Local Data Repository. By default, Global Data Repository mode is selected which allows you to provide data from your Global Data Repository file. You can switch to the Local Data Repository mode to provide test iteration values from your Local Data Repository.

Function Library

Function Library is the collection of functions which can be used across different Test Cases. These functions are user-actions performed over web application which can be repetitive. This module is modular, scalable and robust in nature i.e. a function made in this module can be further used along with different Test Cases in the form of test steps. These functions are easily modifiable and reusable which make this module robust.

Test Suite

A Suite in OpKey is a collection of Test Cases and a Suite can contain one or more than one Test Cases for execution. You can add, remove, move up/down Test Cases to define their order of execution. Suite module also has ‘Run on Cloud’ feature with the help of which you can remotely execute the suite in the cloud environment. Before adding test cases in Suite, you should ensure that each Test Case in a Suite is complete in itself and independent of other Test Cases.

Gherkin (BDD

Gherkin Feature describe behaviors in a single notation which is directly accessible to SMEs, testers and developers; so as to improve communication among them. By using Gherkin feature, business analysts can easily describe client’s requirements or scenarios in terms of user stories and it’s usually in the ‘Given’, ”When’ and ‘Then’ format. Gherkin feature is a Behavior-Driven Development (BDD), an agile software development practice. It enhances the paradigm of Test Driven Development (TDD) and acceptance tests, and encourages the collaboration between developers, quality assurance, SMEs, and stakeholders. Behavior-driven Development primarily focuses on getting a clear understanding of desired application behavior through discussion with stakeholders using a ubiquitous language, which is lucid and easy to comprehend.

Service Repository

As name suggest, a service repository is a collection of web services. A Web service is a method/medium of communications between two electronic devices over the internet. Web services are used primarily as a “way for businesses to communicate with each other and with clients; Web services allow organizations to communicate data without intimate knowledge of each other’s IT systems behind the firewall”. Web services do not provide a GUI to the user but they share business logic, data and processes through a programmatic interface across a network. There are basically two web services: SOAP and REST. SOAP stands for Simple Object Access Protocol and REST stands for Representational State Transfer. OpKey supports both of them.

Coded Function Library

The Coded Function Library is an advanced feature of OpKey Web. Coded Function Library editor provides you a platform where you can write your own function code of tasks to be performed in test automation. Once, they are written in Java, you can compile Java codes and debug easily. You can execute your Coded Function Library directly or map them with Test Case and execute them. In addition, Coded Function Library works as an One Stop Solution for creating Custom Keywords in OpKey as you can write your Custom Keyword specific code in Java, compile it to fix code errors, associate required libraries, import pre-built libraries and execute it. Furthermore, this code can directly be called and used in a Test Case or a Function Library and get Executed.


Model Based Testing (MBT) feature is a graphical view of test design representation which can be considered as a framework containing all the possible test scenarios. It allows users (like Business Analysts) to create a model-based test design. This model reflects the system behavior from a testing perspective and includes all scenarios, constraints, and dependencies that are relevant to testing. Being a graphical view of representation of Test Designs, MBT is easy to understand, use and maintain. Model Based Test Design shows a complete Test Structure in which test script, test data and test cases works as backbone of the structure. The purpose of designing of the model based test is representing a complex test scenario in graphical view which is easy to understand for test users.


Sparkin feature includes core concepts of classic Gherkin along with a user friendly, flexible interface which enables user to create requirements/scenarios quickly than the Gherkin editor. Sparkin enables you to create requirements/scenarios quickly while adding prebuilt clauses (Given, When & Then) & create Function libraries corresponding to those statements and execute Sparkin to analyze execution result. Users need not to follow any syntax as it offers prebuilt clauses as Given, When, & Then. Further, you need to map those statements with Function Libraries. You can use data from Global Data Repository and associate with statements.

Was this article helpful to you? Yes No