Note: This article contains legacy information for Scenario versions earlier than 2.1.0. For updated information on Scenario version 2.1.0 and beyond, please refer to this article.
After installing the qTest Scenario plugin, you must configure the Scenario settings on a per project basis to use Scenario in that project. The configuration will allow you to link your Jira project, Scenario, and your Git repository. The first time you use qTest Scenario, you will be prompted to enter your Git username and password and select your preferences.
IMPORTANT: To configure qTest Scenario in a Jira project and use Scenario inside of Jira, the Git Repository Administrator will need to turn on your Git repository for the Jira project and assign the user(s) his or her credentials in the Git repository. The user(s) must be a collaborator on that Git project, and the administrator must grant them push access. Currently, Scenario integrates with Bitbucket and GitHub.
How to Configure Scenario
- Open your Jira application.
- Select the Jira Project for which you would like use Scenario.
- Navigate to the Settings tab for the Jira project.
- Select the qTest Scenario add-on located at the bottom of the Jira Project Settings column (you will need to use the scroll bar within the column, not the window.)
- The Project Settings window loads.
Note: The webhook displayed here, is your 'Scenario' webhook that you will use to connect to your Git Repository.
- Select the Project Settings tab, to configure your qTest Manager projects inside of Scenario. This will need to be configured if you are using the free OR paid version of Scenario.
- Select the Configure your Project button.
- The Configure Your Project Settings wizard opens and you will need to enter the following:
- Git Repository URL
- Git Provider: choose the appropriate server environment
- Feature File Folder: provide the directory path for the highest level feature file directory.
- Git Username
- Git Password
Important: If you are using SSO, your Git Password will be your Git API Token instead of your personal Git Password. For more information, please refer to this article.
- Select Next, and choose your Default Branch to commit your code. This is the repository code branch where your features files will be entered.
- Select Next, and choose your Editor Issue Type. The issue type selected here will be the default for the Scenario gherkin editor.
- Select Next, and you will receive a message validating your setup is complete. Save.
- Now your Scenario application is configured with your Jira application.
Enable Enterprise Features
- Select the Enable Enterprise Features button if you are using a private repository and the paid version of Scenario.
- Enter the following:
- qTest Domain
- qTest Username
- qTest Password
- Select Ready.
- Your Enterprise Features are now enabled for qTest Scenario, and you will have an Enterprise Settings tab within your Scenario plugin.
- The following fields will display:
- qTest Domain: enter your qTest Pulse URL
- Scenario Account Id: this is your organization's unique Scenario Account Id, you will input this as a Pulse Constant.
- Scenario Project Id: this is unique for each Jira project configured with Scenario. You will input this as a Pulse Constant.
- Actions: used to configure Scenario with the Trigger Jenkins Pulse Rule. To add a new Action, do the following:
- Select the New Action button.
- Ensure the Active checkbox is selected.
- Name the Action.
- Input the Webhook Endpoint which is the Pulse Event webhook associated with the Pulse Rule you are configuring with Scenario.