1. Home
  2. Opkey Help
  3. 38. Marketplace

38. Marketplace

Marketplace is Opkey’s new feature which is integrated with Opkey where our developers utilize the addons through the Marketplace at our OpKey portal. 

The portal comprises four categories of addons which are categorized as “Keyword”, “Test Accelerator”, “Utilities”, “Shared Workflows”. The addons can be Sorted as “Top-Rated”, “Top Liked”, “Top Trending”, “Top Selling”, and “Latest”. Addons are also categorized according to the pricing as “Free” and “Paid” addons. 

How to use the Marketplace Portal: 

You’ll have to log in to the Opkey portal and click on Addon Launcher Tab to visit the Marketplace Portal. Else you can directly login to the marketplace portal to use its features. 

Go to the “Opkey Website” and log in to the portal.

You’ll now have to click on the “Addon Launcher” tab placed on the left ribbon. The tab will display the “Manage Addon” subsection, which will direct you to the Marketplace portal.

Else you can directly login to the Marketplace portal with your Login credentials.

The Marketplace is now accessible to only Opkey users. 

After logging in to the Marketplace portal, you’ll have to Subscribe to the addon, which you want to use. You can view the “Subscribed Addons” at Opkey Web or Opkey Surge portal on the tab of  “Addon Launcher” which helps to launch the addons. 

There are basically four types of add-ons that we are providing namely:

For now, we are supporting Keywords, Utilities, and Shared Workflow. Test Accelerator will be launched soon.

Keywords – In this type of add-on there will be keywords that will be developed to create scripts. 

Test Accelerators – The developer will upload the exported Opkey script in the category of test accelerator for others to use it. You can subscribe to the addon and use the script on their project or on their domain for their requirement. This eliminates the time taken for every user to write the script.

Utilities – These types of add-ons are built for extra functionality and they are of a miscellaneous kind.

Shared Workflow-  A workflow addon is a combination of “States and Transitions” where users can either add  By-Default States (Draft, Review, Approve and Publish)  or the Customized States that they wish to add.  By adding those States, through Transitions we depict that the particular file or artifact in Opkey is in which state. The transition helps the user know from which state to which state it can be moved. This Workflow typically represents the lifecycle of a process within an organization. The Workflow can be associated in a different manner for individual projects. Additionally, we can define separate workflows for specific modules, within the same project. To be more precise, the user can define three different workflows for an Object Repository, a Test Case, and for the Suite. Workflow 1 can be defined for an Object Repository, Workflow 2 for a Test Case, Workflow 3 for the Suite, and so on.

To use an addon, you’ll have to subscribe to the particular Addon from the available categories.

The image below shows the list of add-ons to choose from:

To subscribe to that particular addon, you’ll have to click on the respective icon and click on the “Subscribe” button. You can have a look at the versions and subscribe to your requirement. If you subscribe to the old version, you’ll get to view the button “Upgrade to Latest Version”, which will redirect to the Addons Version list page, from where you can subscribe to any version according to your need.


The subscribed addons can now be seen on the “Addon Launcher”.

The “View All Addons” section displays all the subscribed addons.

Workflow Addon

The Workflow addon is now available in the Marketplace, which provides the user with the amazing opportunity to subscribe and use its functionality. A workflow add-on is a set of States and Transitions, that depicts a file or an artifact’s state in the Workflow. The Workflow can be associated in a different manner for individual projects. The two types of workflow present in the Workflow Addon are:

Default Workflow-  In this kind of workflow, we provide by default four states – Draft, Review, Approved, and Published. Users can subscribe to the default workflow, and use its states. While creating a new Artifact, the by default state remains as Draft which later can be changed. The workflow is non-editable. Users are not allowed to change any rules in the Default Workflow. 

The admin users can change the state of any artifact either from Draft to Review, Review to Approved, Approved to Published, and Published to any other state. Admin users possess the right to all kinds of transitions. However, the non-admin user can only change from Draft to Review, the rest of the movements are restricted for them. The Review, Approved, and Published states are the Freeze states of the Default Workflow, which doesn’t allow users to make any changes to them. If there is any need to change the state, the user will have to move to the Draft state and then apply the changes. The user can keep different workflows for different artifacts. 

The Users also have the opportunity to change the versions of the artifact while moving from one state to another. The by default version of any artifact remains 1. Whenever there is a change from Draft to Review and vice versa, one version gets updated. The version also gets updated whenever there is a change to the Published state from any state.

Custom Workflow – The Custom Workflow allows the admin user to create workflows according to their requirements, by applying rules which may not be necessarily as per the default workflow. The non-admin users are not allowed to either create or edit the custom workflows. It allows the user to apply the rules  on the selected state as well as the transitions between two states such as :

  1. Which state will be  provided with a freeze state, 
  2. On what conditions it will be moving ahead, 
  3. On moving to which state the version will be increased and much more. 

The user will click on the “Add” button on the List of Workflows section and create a new Custom Workflow. User has the liberty to now add workflows according to their requirements by selecting the option of states from the dropdown. The user also gets the option to add New State by selecting the New option. The states can be connected thereafter. 

On clicking the forward arrow present on the extreme right-hand side of the screen, the user gets the option of selecting the Color of the States. The color change can also be done for the connector as well. 

The Rules tab allows the user to set and modify the rules of the State. The section has Pre-Condition and Action tabs present for the State: 

The Preconditions can be applied as per Admin or Non-Admin Users, as per the Creation Date, and as per the Previous State. The Pre-Condition provides rights to users to move ahead with the specified actions.

The Actions tab possesses options for Freezing the Artifact, Incrementing the Version, providing the Description of the Artifact, and Notifying any change in the Artifact. The details of these tabs are listed below:

 a) The User can choose to Freeze or Unfreeze the artifact. This will allow the user to keep the artifact in Freeze Mode, not allowing any movement thereafter.

 b) The Increment Version allows increasing the version of the artifact. From the default state of the artifact, the option allows moving one step ahead in its version.

 c) The description tab provides two options “Set Description” which allows the user to set its description and “Append Description” which allows the user to modify the description. 

 d) The Notification option, notifies the Current User and also All the Users as selected. 

 e) The Block Transition rule can also be applied to transitions between two states based on the pre-condition. 



f) The details tab will let the user view all the details of the action being performed as per the specified rules. As shown in the image below, the artifacts are in Freeze mode. It cannot be changed further. The “Add Description” section displays the added description by the user. The Version section displays the incremented version. 


Was this article helpful to you? Yes No