Menu

qTest Pulse 9.1 Quick Start Guide

Overview

qTest Pulse 9.1 is a workflow engine for products in the qTest Platform and is currently optimized to integrate BDD workflows for qTest Scenario-BDD for Jira. It works behind the scenes to integrate Jira software with Jenkins, Slack, and many different plugins to increase productivity within your development process. 

Pulse 9.1 uses AWS Lambda to execute rules, which is reliable and very scalable.

Prerequisites

Establish Pulse Access

Your qTest Site Administrator must create a new Admin User profile with only 'Pulse Access' selected. This allows an end user to be assigned the Admin User Profile and have the ability to access and use Pulse without gaining additional administrative privileges.

HINT: The default Administrators profile will also have 'Pulse Access' permission. One user can be assigned multiple Admin User Profiles.
pulse_access_user_profiles.png

Once the new 'Admin Profile' is active, you need to assign this profile to users on the Licenses - Users tab.  In the example below, two users will both receive access to qTest Pulse although they have different Admin profiles. This is because both Admin profiles have the Pulse Access user permission.

  • AJ Ford - 'Administrators'
  • Ali Huffstetler - 'Pulse Access User'

Login

Once your username has Pulse access, you can log in to qTest Pulse from the  9-box icon. Pulse opens in a separate browser window from your Manager instance.

Upgrade from Pulse 9.0 to Pulse 9.1

There are a few action items that you need to do before you can use Pulse 9.1. These are only required if you previously used Pulse 9.0.

If you used our standard workflow, you will need to export the new 9.1 Pulse Rules from GitHub.

If you have customized your rules, there are a few fundamental changes to how your actions work. Since Pulse 9.1 uses AWS Lambda, the event.handler function must be used. Please look at the updated GitHub rules to see an example of how this works.

Update the following Constants:

Understand Pulse Rules

To properly integrate workflows, you need to establish and set up your Pulse 'Rules'. These consist of Triggers and Actions. Triggers and Actions are basic conditional statements, an example of which is shown below:

  • If this trigger occurs, then I want Pulse to perform this action.

Pulse Rules are a combination of the following:

  • Triggers=webhooks
  • Actions=program code 
  • Constants=static values used in the Actions

You will need to create the components above before you can begin creating your Pulse Rules. 

Triggers (webhook)

The Pulse Trigger is a unique webhook produced by the application that will not only be used to create your Pulse Rule but will also be entered into the separate application tool for complete integration.
Example: You want to create a Pulse Rule so that you receive a message from Slack when X, Y, or Z happens. You will create your Trigger, named 'SlackEvent', and the webhook URL that is produced by Pulse (in the Trigger section) will also be entered into your Slack application.

To create a Trigger:

  1. From the Pulse homepage, select the project where you want to create a Trigger.
  2. In the Trigger section, select the Create button.
  3. Enter a Trigger name in the "Create Trigger" dialog. Select Ok to save.
  4. Pulse will automatically generate a webhook.
    Note: The Webhook URL will auto-populate with a unique value. If you are using an SSL configuration, the webhook produced will include https. 
  5. You can view/delete the webhook by selecting the pulse_action_icon.png icon and both action options will appear.
    Note: You cannot edit a Trigger.
    create_trigger.png

So far, you have created the Trigger (webhook) that you will enter into the external application tool. Now, you need to enter the Pulse Action.

Actions (program code)

The Pulse Action is the program code that you want to execute as part of a Pulse Rule.
Example: If you want to pass a payload to the action, you could send a message to any other tool with an available API using Javascript.

We have sample program code 'Actions' available, so you can begin setting up your Pulse application. These are available in the QAS public GitHub repository. There is also an Import/Export option available that will allow you to move your Pulse Rules v9.1 from one project to another.

Note: You will not be able to import Pulse Rules v9.0 into Pulse Rules v9.1. 

To Create an Action:

  1. In the Actions section, select Create to add a new Action. The 'New Action' dialog opens.
  2. Name the Action. Be descriptive as to what the action is accomplishing.
    Note: The name cannot be edited once created.
  3. Optional: provide a Description.
  4. In the Program Code section, either enter the sample program code provided in the QAS Git repository or create your own actions.
    Note: For the most up to date sample program code, view the QASymphony/PulseRules v9.1 repository.
  5. The Available Constants section is 'display only' and populates values you have predefined in the "Constants" section. 
  6. Select Save, and the Action will display in the "Actions" section of the screen.
  7. The Emit Event-Trigger Execution Chain provides details for the Trigger if you want to invoke another Trigger from your action code. Make sure the value in the t.name= matches the name of the Trigger you want to use with the action. This will be a manual edit for the end user. 
  8. The Catch code block will output any errors received when the action is executed to assist you with debugging. 

edit_action_v2.png

Execution Information

Once an Action has been executed, you can view general Execution information along with detailed Execution Logs. 

  1. Select the pulse_action_icon.png action icon to the right of the action for which you want to view the execution log. 
  2. Select View Logs.
  3. The 'Executions' dialog opens and displays general Execution information. 
  4. Select the Id hyperlink for more detailed information such as the Payload, Standard Output, Standard Error, and the Response.
    execution_log_gif.gif

 

Note: For the most up to date sample program code, view the QASymphony/PulseRules v9.1 repository.

Constants

The "Constants" section is where you can create a list of Constants (name and value pairs) that are stored per project. These are accessible in your action code using the always available constants JSON object.

  1. In the Constants section, select Create to add a new Constant. The "Create Constant" dialog opens.
  2. Name the Constant, and select OK. Do not use spaces if the Constant name is more than one word. You can use only alphanumeric characters (or "$" or "_"), and the name may not start with a digit.
    Important: If you misspell the name, you will have to delete the Constant as there is no edit function.
  3. The newly created Constant name will display at the bottom of the list.
  4. In the red text field, enter the Constant value.
    create_constant_1.png
  5. The Constants entered here will be exported when you select the Export icon on the "Pulse Rules" page. These will export the name, but you will need to enter new values when exporting into a new project. You can read this article for more information on Pulse Constants that are used in the sample Pulse Rules.
  6. You can hide/unhide a Constant value, by selecting the pulse_action_icon.png action icon.
    • Hide: The value will display as asterisks.
    • Unhide: Once a value is hidden, you can unhide the value, but unhide will delete the value and you will need to enter a new one.

Read the Pulse Constants article for information on where you can locate the values needed for Pulse 9.1. Some of the constant values have changed for this release. 

Pulse Rules

  1. Login to your qTest Manager application.
  2. Select the Pulse application from the 9-box icon 9_box.png .
  3. Select the appropriate Project in the project drop-down where you want to establish new Pulse Rules. The projects listed here are the same projects you will find in qTest Manager.
  4. The page will load and display the My Rules tab by default for the selected project.

Create a new Pulse Rule

  1. In the Rules section, select Create.
  2. Name the Rule and enter a Tag (optional.)
    Note: An example Use Case for Tags is associating version numbers with a set of Rules.
  3. Select the Active checkbox to activate your Pulse Rule. 
  4. Any Triggers you have created will display in the Trigger column. Drag the appropriate Trigger to the Rule column.
  5. Any Actions you have created will display in the Actions column. Drag the appropriate Action to the Perform column.
    Note: You can only have one Trigger (webhook) per Rule, but you can assign multiple Actions to the one Trigger selected.
  6. Once finished, select the Create button at the bottom of the dialog.
    create_new_rule.png

Test and Execute a Pulse Rule

  1. Locate the Pulse rule you would like to test in the 'Rules' section of the Pulse homepage. 
  2. Select the 'play button' icon in the Action column.
  3. The Run dialog opens, and select Execute.
  4. The Pulse Rule will kickoff in real-time and return a Response.
  5. You can view the response for Action(s) associated with the Pulse Rule.
  6. Select Close
    test_rule_response.png

Edit a Pulse Rule

  1. From the Pulse homepage, select the project with the Pulse Rules you want to edit.
  2. In the Rules section, select the Rule Name hyperlink.
  3. The "Edit Rule" dialog opens, and you can drag/drop the Triggers or Actions you want to edit.
  4. To inactivate the Rule, select the Active checkbox to remove the check.
  5. Once finished, select Save at the bottom of the dialog. 
    edit_pulse_rule.png

Import/Export Pulse Rules

You have the ability to import and export Pulse Rules from one project to another. You can also export all of the Sample Pulse Rules provided by QASymphony that are located in the QASymphony/PulseRules v9.1 repository in GitHub. You will then need to import these Rules into your own Pulse application/project.
Note: For the most up to date sample program code, view the QASymphony/PulseRules v9.1 repository.

  • Import: creates a unique Event webhook for the new project.
  • Export: includes constants' names, but you will need to enter your own values into the new project. New values will need to be entered each time you export rules from one project to another. Export is a .json file.

Access Sample Pulse Rules in GitHub

  1. Login to your GitHub account and type 'PulseRules' in the GitHub search bar.
  2. Select the QASymphony/PulseRules v9.1 repository that displays.
    git_v9.1.png
  3. The sample rules are available from the Code tab.
    git_code_tab_v9.1.png

  4. Before you begin, read the 'README.md' file first. This is located in the Code tab as well. These instructions will assist you in using the supplied Pulse Rules Actions.
  5. You can view the Pulse Rules category of this User Guide for sample Rules/Actions. These are the same Rules/Actions you will find in the GitHub repository.

Sample Pulse Rules

Below are direct links to the sample Pulse Rules Actions (program code.)



Powered by Zendesk