Working with run configurations in automation suites

If you want to run builds for a Jenkins project from an automation suite in Helix ALM, configure a run configuration for the suite. The run configuration specifies the Jenkins configuration, project, and the default parameter values to use when running the build.

If you do not use Jenkins or will only run builds from within Jenkins, you do not need configure a run configuration for the suite.

See Running Jenkins automation suites from Helix ALM for information.

1. Make sure that the Helix ALM project has a Jenkins configuration for the instance to connect to from the suite. See Adding Jenkins configurations.

2. Click Automation Suites in the left navigation area.

The Automation Suites list opens.

3. Select the suite, click Actions, and choose Edit. You can also click the suite name or number.

The suite page opens with the Details tab selected. You can only edit information on the Details tab, not the Summary or Builds tabs.

Note:  Click an area to expand or collapse it. Click the Expand All button to expand all areas or the Collapse All button to collapse expanded areas at the top of the page.

4. Go to the Run Configuration area.

If the suite already has a run configuration, it is displayed. If the Helix ALM project does not have a Jenkins configuration, 'No integrations with automated testing products have been configured' is displayed. See Adding Jenkins configurations for information about adding configurations.

1.Click Add Run Configuration.

  • If the project only contains one configuration, it is automatically displayed as the Jenkins configuration.
  • If the project contains more than one Jenkins configuration, the Select Automated Testing Configuration dialog box opens. Select a configuration to use and click Add. You return to the Add Automation Suite dialog box and the selected Jenkins configuration is displayed.
  • If the project does not contain any configurations, you need to add one. See Adding Jenkins configurations.

Note:  To remove the configuration from the automation suite, click Remove Run Configuration. You are prompted to confirm the removal. There is no undo available. Click Remove.

2. Click Select Project to select the Jenkins project to use when running the automation suite.

The Select Jenkins Project dialog box opens. The following Jenkins types are supported and displayed: Freestyle projects, Pipeline, Multi-configuration projects, Folders.

Note:  The Enter Jenkins Credentials dialog box may open if your Jenkins credentials are required to connect to the Jenkins instance. See Entering Jenkins credentials when working with automation suites.

3. Browse for and select the Jenkins project to build when you run the automation suite.

You can search for a project or folder by name, or paste the URL to a Jenkins project in the search field. The Jenkins URL must be in the same Jenkins instance as the Jenkins configuration selected for the automation suite.

To open a folder, select it and click Open Folder or click the folder name. Click Go To Parent Folder to navigate back up the folder structure one level. Click to refresh the list.

4. Click Select Project.

You return to the Add Automation Suite dialog box and the selected project is displayed. Click the project link to open the Jenkins project. Click Change Project to select a different project.

5. If the Jenkins project uses an authentication token to trigger builds remotely, enter the Project authentication token. To change the token saved in the run configuration, click Change token.

6. If the Jenkins project has parameters, review them in the Default Parameter Values area. You may need to click Load Default Parameter Values to load the parameter information.

You can change the Jenkins project used when running the suite.

1.Click Change Project next to the Jenkins project field.

The Select Jenkins Project dialog box opens.

Note:  The Enter Jenkins Credentials dialog box may open if your Jenkins credentials are required to connect to the Jenkins instance. See Entering Jenkins credentials when working with automation suites.

2. Browse for and select the Jenkins project that contains the automated tests to run for the automation suite.

You can search for a project or folder by name, or paste the URL to a Jenkins project in the search field. The Jenkins URL must be in the same Jenkins instance as the Jenkins configuration selected for the automation suite.

To open a folder, select it and click Open Folder or click the folder name. Click Go To Parent Folder to navigate back up the folder structure one level. Click to refresh the list.

3. Click Select Project.

You return to the automation suite. The selected project is displayed. Click the project link to open the Jenkins project.

If the selected Jenkins project has parameters configured, they are displayed in the Default Parameter Values area. These parameters are used when running the automation suite from Helix ALM in Jenkins. The parameter name, default value and description are displayed. If there are multiple parameters with the same name in the Jenkins project, only the last one is displayed.

All parameter types are supported except File parameters. The method to enter or select parameter values may be different than in Jenkins.

Note:  If the default parameter if changed to a different type or if the overridden value in Helix ALM is no longer valid, and you are editing the suite, the Default Parameters Changed dialog box opens. A list of the changed parameters is displayed. Any default value overrides for the changed parameters are no longer valid. Click Close to close the dialog box.

You can override a default parameter value and use a different value when the automation suite runs.

1.Click Override next to the parameter.

2. Enter or select the parameter value to use.

3. If you want to go back to using the default parameter, click Use default.

If you no longer want to use a run configuration for the automation suite, you can remove it.

1.Click Remove Run Configuration.

You are prompted to confirm the removal. There is no undo available.

2. Click Remove.

The run configuration is removed. You cannot run the suite in Jenkins unless you add a run configuration to it again.