22.11 Working with ALM Octane

Opkey Integration Set Up in Octane

ALM Octane – ALM Octane is now integrated with Opkey which will allow the user to map the Test Cases, update the result of automated test scripts in Opkey’s ALM Octane.

How To add custom menu items under “More” for Manual Test and Test Suite.

   1. Login to ALM Octane as a Share Space Admin.

    2. Select Settings>Management>External Actions Editor.

 3. Paste below provided JSON code on the external action editor. The editor allows you to write or paste ready-made JSON code that represents the custom buttons you are adding to ALM Octane.



   “name”: “CreateModify”,

   “title”: “Create/Modify Opkey Test Case”,

   “entity_type”: [



   “views”: [




   “icon”: “automated-task”,

“url”: “https://<—YOUR-Opkey-URL—>/Login/External?entity_ids={entity_ids}&entity_type={entity_type}&shared_space={shared_space}&workspace={workspace}&user_login={user_login}&email={user_email}&action=defect-details&actiontype=Map&dialog_id={dialog_id}&Opkey_custom_field={entity.Opkey_testcaseid_udf}”,

   “single_entity”: true,

   “events”: true,

   “workspaces”: [





   “name”: “TestData”,

   “title”: “Set Data in Opkey Test Case”,

   “entity_type”: [



   “views”: [




   “icon”: “storage”,

   “url”: “https://<—YOUR-Opkey-URL—>/Login/External?entity_ids={entity_ids}&entity_type={entity_type}&shared_space={shared_space}&workspace={workspace}&user_login={user_login}&email={user_email}&action=defect-details&actiontype=Set&dialog_id={dialog_id}&Opkey_custom_field={entity.Opkey_testcaseid_udf}”,

   “single_entity”: true,

   “events”: true,

   “workspaces”: [





   “name”: “TestExecution”,

   “title”: “Run Opkey Test Case”,

   “entity_type”: [



   “views”: [




   “icon”: “run”,

   “url”: “https://<—YOUR-Opkey-URL—>/Login/External?entity_ids={entity_ids}&entity_type={entity_type}&shared_space={shared_space}&workspace={workspace}&user_login={user_login}&email={user_email}&action=defect-details&actiontype=Execution&dialog_id={dialog_id}&Opkey_custom_field={entity.Opkey_testcaseid_udf}”,

   “single_entity”: true,

   “events”: true,

   “workspaces”: [





   “name”: “TestSuiteExecution”,

   “title”: “Run Opkey Job”,

   “entity_type”: [



   “views”: [




   “icon”: “run”,

   “url”: “https://<—YOUR-Opkey-URL—>/Login/External?entity_ids={entity_ids}&entity_type={entity_type}&shared_space={shared_space}&workspace={workspace}&dialog_id={dialog_id}&user_login={user_login}&email={user_email}&action=defect-details&actiontype=SuiteExecution&Opkey_custom_field={entity.Opkey_testcaseid_udf}”,

   “single_entity”: true,

   “events”: false,

   “workspaces”: [





    4. Click “Update”. Now the required custom actions are updated in manual test and test suite on mentioned workspace.

Note: The workspace ID can be viewed from the URL, which will be a 4 digit number.

How to Create Custom Fields for Manual Test Entity

1. Go to the Settings tab in ALM Octane portal, and click on the Spaces or the workspace where you want to create user defined fields.

2. Select the Workspace on which you want to add custom fields.

3. Click on the Entities tab.

In the Entities list on the left side of the pane, select Manual Test for which you want to create your field.

5. Click on the “Fields” tab and

Creating Manual Test Entity          

     Add custom field 1 (Opkey Status):

  1. Click to add a user-defined field.
  1. Enter the following on the Pop-Up Window
  • Name: Opkeystatus_udf
  • Label: Opkey Status
  • Type: String field
  • Add to form: Select “System defined for Edit” checkbox

           3.  Click “Add” button.

Add custom field 2 (Opkey Automation Mapping):

             1. Click to add a user-defined field.

  • Enter the following:
  •   Name: Opkeymapping_udf
  •   Label: Opkey Automation Mapping
  •  Type: String field
  •  Add to form: Select “System defined for Edit” checkbox

        3.   Click “Add” button.

Add custom field 3 (Opkey Test Case ID):

  1. Click + to add a user-defined field.

Enter the following:


 Name: Opkey_testcaseid_udf

 Label: Opkey Test Case ID

 Type: String field

 Add to form: <Not required>

 Click “Add” button.

How to add Release Value

To add Release, click on the root node of the Workspace.

Click on the Release tab and go to “+” sign to add Release.

Fill the details on the pop-up window and click on add button.

A new Release will be created on the root node.

How to Set Rules for Custom Field

1. In Settings > Click on Spaces, select a Workspace.

2.  Click Entities and select the “Manual Test” for which you want to create a rule.

3. Click “Rules” tab.

Creating Rule for MANUAL TEST

Rule 1: To set default value of custom field “Opkey Status” = Manual while creating a new manual test.

3. Click + to add a business rule.

4. Enter the following in Action tab:

  •          Action: Select “Set field value” from drop-down.
  •        Timing: Select “When creating an entity” radio button.
  •        Field: Select “Opkey Status” from drop-down.
  •        Select “Set Value” radio button and provide value = Manual

5.    Click “OK” button.

Creating Rules for MANUAL RUN

Rule 1: To set default value of field “Release” Manual while creating a new manual run.

  • Action: Set field value
  • Timing: When creating an entity
  • Field: Release
  • Select “Set Value” radio button and value = R2 (any value which is available)

Click Ok

Creating Rules for SUITE RUN

Rule 1: To set default value of field “Release”Manual while creating a new suite run.

  •  Action: Set field value
  • Timing: When creating an entity
  • Field: Release
  • Select “Set Value” radio button and Value = R2 (any value which is available)

   Click Ok

Generating API from ALM Octane

To generate new API Access from ALM Octane, you need to Go to the Settings, and click on the Spaces.

Go to the Main Workspace and click on the API Access tab.

A new page opens up where you need to click on + Add API.

Fill the details in the Add API pop-up window.

Fill the details of NameRole and Workspace. Click on the Add button.

It will generate new API IDs. Copy them and paste it, which you need to provide to configure Opkey Test Cases with.

Mapping of Test Cases with Octane

To map Opkey Test Cases with ALM, you’ll have to go to the Admin panel of Opkey Web and click on Projects on the Admin Panel.

Select the project and click on the External Tool Integration icon. You’ll now view a pop-up window to configure the ALM Octane tool with Opkey.

You’ll have to fill in the details in the below window by selecting the dropdown of Client Authentication Keys in Authentication Type.

Click on the Authenticate button and enter the Space and Workspace details. Save the Details.

With the above steps, ALM Tool gets configured with Opkey.

You can now map your Opkey Test Cases by login into Opkey and right clicking on the specific Test Case.

On clicking the tab, a window will appear which allows to enter the details of the Manual Test created to be mapped with Opkey.

On clicking the Search Icon, it will display the list of Manual Test Cases to be mapped with

Opkey. You’ll have to select the Test Case to be mapped with Opkey and click on Apply Map  

Changes button towards the end of the window.

You can also Remove All Mapping by clicking on the button present in the right hand corner of

the window to remove any mapping of the ALM Manual Test cases.

How To map the Opkey Test Step with the ALM Octane Manual Test

  1. You’ll have to login to ALM Octane and go to the workspace.

    2. Open any Test Case by clicking on the Map Existing Test Case through Octane.

Select the “Map Octane Steps” button available in the toolbar to open the step mapping window.

A new step mapping window will open up where you’ll have to select the Manual Test whose steps need to be updated.

On the right hand side, click on the Opkey Steps and select the steps as per requirement that needs to be updated and mapped with Octane Steps.

Click on the Save button.

Post execution the status will directly get updated on the ALM Octane “Runs” section.

The Status of the Execution of the Test Case can be viewed in detail in the Run tab.

The attachments are also attached to the steps updated, along with the updation of steps in ALM Octane.

How to Create Opkey Test Cases from ALM Octane

  1. You’ll have to login to the ALM Octane.

  2. Click on the three Hyphen’s present on the left hand corner of the main page and click on the Team Backlog section.

3. Under the “Tests” tab, click on the Manual Test to create a new manual test.

4. Create a new Manual Test by clicking on the “+” sign.

 5. A new window will open. Fill in the details of Name. And click on Add button.

 6. A new Manual Test will be created.

 7. Click on More Tab to view the option of Create or Modify Test Case.

 8. Post entering in the external action editor, you’ll get to view the option of Create or Modify the Opkey Test Case.

9. On clicking this option, a new window will open up of Opkey. It has two options of either Creating a New Test Case or Mapping the Existing Test Case.

10. On clicking the Create New Test Case, a window opens up.

11.The Creating the Test Case option will allow you to Create and then Map the Test Cases of Opkey Surge in ALM Octane. You’ll be able to create the Test Cases by adding steps in the Opkey Window, which can then be mapped.

12. On clicking the Add Step icon, user can view the Function Libraries to be added as steps to the Test Case.

13.The Step level mapping can be done too while mapping the Opkey Surge Test Cases. You’ll have to select the “Map Octane Steps” icon next to the Save Icon in the External ALM Octane.

14.The Steps can be modified on the pop-up window that will be displayed as shown in the image below.

The modifications of steps can then be saved.

The added steps can then be viewed in ALM Octane.

To Map The Existing Test Case

The External Opkey window will display the option of Mapping the test case with the Manual Test Case in ALM Octane.

You’ll have to click on the Map the Existing Test Case.

In the next window, you’ll have to select the Test Case to be mapped with the Test Case in ALM.

The Existing Test Cases in Opkey gets mapped to the Manual Test in Octane.

How to Set Data in Opkey Test Cases

To set data in Opkey Surge Test Cases, you’ll have to click on the Set Data in Opkey Test

Cases in ALM Octane.

1. On clicking the option, it will open up a window to Set the Data in Opkey Surge.

2. The option to Edit Test Data allows you to Set the data by clicking on the Static Data and Local Data Repository tab.

3. By-default, Static Data Mode is already set on the test case. Users can add the Static Data into the  Static Data panel present on the right hand side as shown in the image below.

Click on the Save button. The Execution will now run with the provided data.

4.  To set the Data through LDR Mode, you’ll have to switch the toggle to the LDR Mode on the window and click on the Edit Test Data button. Please refer to the image below to proceed accordingly.

5.On clicking the Edit Test Data button, a pop-up window is displayed which will allow you to Set Data in Opkey Test Cases using Local Data Repository.


6.You’ll now view a window where you can add a local data repository and edit it.

7.Click on LDR edit button available below the Data tab to open editing through LDR.

On clicking the button, you can now view a new window with multiple options for editing with the Local Data Repository.

You can Import the Data as well as Export the data, with the buttons on the Left Hand corner.

You also get the option to Add the Data Set and Delete the Data Set.

The Up and Down Arrows allows you to Move the Data Up or Down as required.

You can also Rename the Data Set.

You also get the option to provide Input Parameters for each associated step. For Encrypted fields you will have to first Decrypt the Data and then it can be modified.

With all the available options to Edit The Data Set through LDR mode, you can Save them with the Save Button.

How to Execute the Opkey Test Cases

The Run Opkey Test Cases tab allows you to Run the Opkey Test Cases by opening the Execution Wizard in Opkey.

1.It will open the window of Execution Wizard and run the Test Cases in Opkey Surge.

2. The Executions are triggered from ALM Octane which gets executed in Opkey.

3. Post the completion of the Run, the results are updated in ALM Octane and the Reports get attached in the attachment section.

4. You’ll have to click on your created Manual Test and select the Run tab. The Created Manual Test will be displayed below.

5. Click now on the created Manual Test, which will open up a new window of the Status of the Execution. The Run tab displays the Status of the Execution of the created Manual Test along with the attachment of the Report.

You can also add another details of Automation in ALM Octane under the More Icon.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article