Create and configure pipelines

Pipelines represent the flow of your CI server jobs and steps. Use pipelines to get a clear, multi-level, analytic view of your pipeline runs and their status. This helps monitor quality and progress, quickly identifying and fixing issues as they occur.

In this topic:

Add a pipeline

Once connected to a CI server, you can create a pipeline. Using the specified root job, a pipeline is built that represents the job flow starting from that root job.

The result of a pipeline run is determined by the result of its root job. Therefore, for the pipeline run result to reflect the results of other jobs in the flow, make sure that on your CI server, the results of those jobs are aggregated up to the root job.

To learn more about pipelines before creating them, see Pipelines.

To add a pipeline:

1. Prerequisites: 

   • Make sure the Application Automation Tools plugin is installed on the CI server.

     For details, see Install and configure the plugin on your CI server.

   • Make sure at least one CI server exists in the Settings area. For details, see Add CI/CD servers on ALM Octane.

2. Go to the Pipelines module and open the Pipelines tab.

3. Click + to add a pipeline.

4. Select a CI server. The list displays the servers created on the CI Servers settings page of the current workspace. For Azure DevOps integrations, see Run Azure DevOps pipelines.

5. Select the root job from which you want to start the pipeline. The list displays the jobs defined on the CI server you selected. If the communication with the server fails, the list is not available.

6. Enter a name for the pipeline and, optionally, assign the pipeline to a program and/or a release. If you select a release, you can also select a milestone.

   • The program, release, and milestone are automatically assigned to all test runs collected from this pipeline. If you change the program, release, or milestone, a new set of automated runs is created to represent all the tests running in the pipeline. This lets you view test results in the context of program, release, and milestone, and track their quality over time using the Dashboard widgets.

   • For details on programs, see Working with programs in pipelines.

   • Before selecting the release and milestone, we recommend you read the section Best practice: Link a pipeline to release and milestone.

   Tip: If you assign the pipeline to the Default Release, the pipeline is always associated with whichever release is currently set as the default release.

7. Specify the pipeline's type. Select one or more types from the list: Build, Test, Integration, Deploy, Security.

   • Most types are optional. This definition helps you remember the lifecycle stages that this pipeline handles.
   • You must select Security if you want this pipeline's runs to show security vulnerabilities discovered by Fortify or SonarQube.

8. Set up notifications (optional). You can send emails to relevant users when builds or automated test runs fail.

   • Notify committers upon run failure. Notify people whose commits were included in a pipeline run that failed.
   • Notify test owners if their tests fail. Notify people who are owners of failed automated tests.

   You can edit these options later in the pipeline's Details tab.

   For more details, see Track commits associated with a pipeline run.

9. Set custom purge policy. A global runs purge policy is set at the space level. To set a special policy for the pipeline, select Override space purging policy. If applicable, select the desired policy type and set a value.

The information is retrieved from the CI server and the pipeline is created. Click the pencil next to pipeline's name or release to edit it.

After the pipeline runs, you can see a comprehensive overview of the run results. For details, see Run pipelines.

Back to top

Best practice: Link a pipeline to release and milestone

When creating a pipeline, you have the option of linking the pipeline to a release and milestone. When you link a pipeline to a release/milestone or modify the release/milestone value, all the future runs reported in the context of the pipeline are assigned to the selected release.

The following are recommendations for different scenarios:

Scenario	Recommendation
Continuous integration pipeline: Trunk/master-based development (no branching) Release/milestone branching	In this case, there is no reason to link to release and milestone. If you create a new branch for each release, it is recommended that you link the pipeline to a release. In addition, if you need to track the quality of your milestone, link the pipeline to the milestone as well.
Feature/story branching	The CI on these branches would typically not be injected into ALM Octane and should not have a release/milestone.
Automated regression cycle	When your release and milestone represent a release and cycle, it is recommended that you link the pipeline to both release and milestone to track results easily.

Consequences of changing a release or milestone

When you change the Release or Milestone fields for a pipeline, you should be aware of the following significant consequences:

1. A new set of automated runs is created to represent all the tests running in the pipeline.

2. Failure analysis features are based on the history of a single automated run. As a result, when a new automated run is created the accuracy of the failure analysis insights is reduced until relevant history on the new run is built up.

Back to top

Use parameter sets

If your CI server job is parameterized, you can define different sets of parameter values that can be used when running the pipeline job. Each pipeline can have multiple sets of parameter values.

For example, suppose that you sometimes run a job on one deployed environment, and other times on another. You can create one data set (Set 1) using the default URL and port, and another (Set 2) with a different URL and port. You can then run the pipeline a few times using different settings.

To configure parameters in a pipeline:

1. When creating a pipeline, if its job is parameterized, a table appears showing the parameters configured in the CI server, with their default values.

   Note: In GitLab, by default only project-level variables are shown. To also see group or instance variables, modify the gitlab.variables.pipeline.usage property as described in GitLab service.

2. In the column headings, add columns to define additional sets of parameter values.

3. You can rename each column heading as needed.

4. You can edit parameter values in each set of parameters as needed.

   Values are limited to 4000 characters, and each set name must be unique.

5. To clone a column, delete it, or reset to its default values, select the relevant menu item in the upper right corner of the column.

6. Click Save.

   When you run the pipeline, a dialog appears enabling you to choose which parameter values to use in the run. For details, see Trigger a pipeline run (Optional).

7. If you change the job's parameters on the CI server, click Sync with CI on the pipeline's Details pane to get the latest parameters defined on the CI server.

Back to top

Customize your pipeline display

If you have a large number of pipelines defined, it may be helpful to show less information using filters.

In the Pipelines module, open the Pipelines tab and use the toolbar above the list of pipelines.

What do you want to do?	How to do it
Filter the list of pipelines to display only the ones you want to work with	Click the Filter pipelines button and select the pipelines to display. If you select a release or milestone in the upper section, the lower section shows you its pipelines. Select the pipelines you want to display. If a filter is active, an orange dot appear next to the filter icon.
Select to display less information about each pipeline in the list	Click to show more or less information about pipelines in the list itself.

Your selection is retained for future sessions.

Back to top

Explore a pipeline's graphical representation

When you create a pipeline, a graphical representation of the pipeline steps is created, starting from the root job of the pipeline.

If you are working with Jenkins, Bamboo, or GoCD, you can see the flow of the steps, including which steps run in sequence and which steps run as parts of other steps.

In the Pipelines tab, click on a pipeline. Click the horizontal ellipsis and click View in the dropdown. The Pipeline PL pages opens. Select the Topology tab.

Jenkins example

Here are visual clues for understanding and working with the display as you explore the pipeline in the Topology tab.

Visual clue	Description
	The pipeline's ID and name.
	Click to view the pipeline in a Flat view or Tree view. Tree view. Displays the hierarchy and flow of the pipeline. Flat view. Displays the pipeline steps side by side without describing the hierarchy or flow. This view is useful for gaining an overview of complex pipelines. In this view, you can also filter pipeline steps. For details, see Filter pipeline steps .
	A step in the pipeline. Click the step's name to open the job on the CI server.
	For a pipeline that displays hierarchy, click to expand and collapse the steps that run as part of their parent step. (inner jobs)
	Steps on the same side of a dotted line run in parallel to each other. (parallel jobs) Steps on the right side of a dotted line run after the steps on its left side end. (sequential jobs)
	Steps that run as part of the pipeline. In a pipeline that displays hierarchy, the steps after this arrow run only after the calling step and its children end. (sequential jobs)
	Click to label the step type as Compile, Package, Deploy, Security, or Test.
	Click to configure step information, which is added to the pipeline step as a tag. You can use tags later, for example, for filtering test run results. You can specify: Test-related information: Framework, test type, testing tool, and test level. The environment tags indicating on which environments the step runs (browser, operating system, database, and so on). You can also define conditional environment tags that are set according to build parameter values when the step runs. A way to link to build reports created by your build. A way to link to test run reports created by your build. For details, see Define test and test run information.
	Redraws the topology based on the current pipeline steps defined on your CI server. This is useful, for example, if you changed the pipeline flow on the CI server a few times and the pipeline structure includes steps that no longer belong in the flow. When redrawing, an attempt is made to maintain the pipeline step configuration. However, for steps that moved significantly, the configuration may be lost.

Back to top

Label pipeline steps by job type

Enhance the pipeline's usability by labeling steps. This makes it easier to understand the purpose of the steps and provides contextual information for test run results.

To label pipeline steps:

1. In the Pipelines tab, click on a pipeline. Click the horizontal ellipsis and choose View in the dropdown. The Pipeline PL pages opens. Select the Topology tab.

2. Click the label at the top right of a step, and select a job type for the step. The label helps you understand the pipeline flow. In the flat pipeline view, you can also filter the pipeline to show only steps with specific labels.

   Job types include: Compile, Package, Deploy, Test, and Security.

   

When the pipeline runs, the labels are added to the resulting builds. When analyzing pipeline run results in the Builds tab, the labels help you understand the context of the builds.

Back to top

Ignore or hide results of specific steps

Your pipeline may include steps or tests whose results you do not want to track. You can ignore such steps or hide their results from the quality analysis.

In a pipeline's Topology tab, click the Configuration button on the bottom right of the step. Then select one of the following options:

In the pipeline's Topology tab, the pipeline step reflects the selected option. For example:

Back to top

Define test and test run information

For pipeline steps that run tests, add environment tags and testing information for the step.

• Test Fields and Testing Environments. This adds tags to your pipeline step. When this pipeline step runs tests, its tags are added to the tests, test runs, and builds. You can then filter builds and test run results according to these tags, and enhance your product and release quality analysis.

  Example: This Jenkins step, QA-Functional-Chrome, is labeled as a Test and has the following tags configured:

  • Test fields: Framework = TestNG, Test type = End to End, Test level = Integration Testing, Testing tool: Selenium.

  • Testing Environment: WinServer2012 (OS), MSSQL (DB), QA (AUT Env), Chrome (Browser).

  

• Build Report and Test Run Report. If your build creates reports, you can add a link to the report in the relevant automated test runs. This report can be stored on your CI server or elsewhere, and may help analyze test run failures.

  Configure a URL or URL template for report links in your pipeline step. A link is added to the test runs that are created as part of this pipeline step and to the build that is the result of this step.

To configure a pipeline step:

1. In the Pipelines tab, click on a pipeline. Click the horizontal ellipsis and choose View in the dropdown. The Pipeline PL pages opens. Select the Topology tab.

2. Display the pipeline steps in Flat view and click the Configuration button in the bottom right of a step.

3. In the Test Fields tab, add information about the type of tests the step runs, and the tools and framework it uses to run them.

   Select from the predefined values:

   Field	Possible values
   Framework	Select from the list. Example: JUnit, TestNG, UFT One.
   Test type	One of: Acceptance, End to End, Regression, Sanity, Security, Performance.
   Testing tool	Select from the list. Example: Manual Runner, Selenium, UFT One, UFT Developer, LoadRunner Cloud, LoadRunner.
   Test level	Select from the list. Example: Integration Test, System Test, Unit Test.

   You can add values to the Framework and Testing tool lists. To do this, add tags to the pipeline step using the API, or the Jenkins plugin UI.

   The following fields are automatically set for test runs discovered on Jenkins pipelines:

   Field	Set for test results from
   Testing tool	UFT One LoadRunner LoadRunner Cloud LoadRunner Enterprise
   Framework	UFT One
   Test type	LoadRunner Enterprise

   If you manually added tags to the pipeline step that runs these test, your tags override the automatic ones.

4. In the Testing Environment tab, you choose environment tags for the pipeline step, such as an operating system, browser, and database.

   Environment tags are grouped by category with a default list of environment tags. Admins and leaders can also define new environments tags, based on the project developing model. For details, see Environment tags.

   Do one of the following:

   Goal	Action
   Use an existing environment tag	Expand the Environment tags field and select the relevant environment tags. Start typing in the box to search for a specific value.
   Add a custom environment tag	Expand the Environment tags field, and type the name for the new environment tag. Select the new name and then click on it. The Add Environment Tag box opens. Either select an existing category or add a new category by doing the following: Type in a name for the new category. Double-click on the new value. Example:   Add a Lab Machine category with tags for each machine you use for nightly runs. Add environment tags for specific browser versions or development branches.
   Create conditions for setting environment tags during the build run, based on build parameter values	In the table, add a row for each environment tag you want to assign dynamically. In each row, specify: Parameter name + value ==> Environment tag Select the build parameter name from the list of build parameters available for this step. Note: If you use the Matrix plugin on Jenkins, the pipeline displays child steps, generated during the build run. Each one represents a set of build parameter values. Conditional environment tags are applied to parent steps. These are applied to the generated child steps. You cannot modify a child's configuration.

5. Build Reports. In the Report Customization tab's Build Report URL field, enter a URL or a URL template to use for creating a link to reports generated for your builds.

   If you include {job_name} and {build_number} placeholders in the template, the actual job name and build number are used in the URL when creating the link.

   For example: 
   

   http://myServer:myPort/jenkins/job/{JobName}/{BuildNum}/reports/logs/jenkins-test-reports.html

   The links are added to the test runs that are created as part of this pipeline step and to the resulting build.

6. Test Run Reports. In the Report Customization tab > Test Run Report URL field, enter a URL or a URL template that can be used to create a link to reports generated for your test runs.

   Note: If you have defined an External Report URL in your CI server, that URL setting overrides the ALM Octane URL definition.

   If you include placeholders in the template such as {test_class} and {test_name}, the actual test class and name are used in the URL when creating the link.

   For example: 
   

   http://myServer:myPort/{root_job_name}/{job_name}/{build_number}/{test_component}/{test_package}/{test_class}/{test_name}/{root_job_build_number}/reports/logs/jenkins-test-reports.html

   The links are added to the test runs that are created as part of this pipeline step.

   Tip: You can select the checkbox Override test run report URL inheritance so that the current job does not inherit the URL format from its parent in the topology.

Back to top

Filter pipeline steps

Filter a pipeline by its label or job name to display only pipeline steps with a certain label and/or steps with a specific string in their name.

If you set up a filter on a specific pipeline, that filter is used again the next time you view the pipeline.

In the Pipelines tab, click on a pipeline. Click the horizontal ellipsis and choose View in the dropdown. The Pipeline PL pages opens. Select the Topology tab.

In the pipeline flat view:

• Filter by label. Select from the labels on the right to specify the type of pipeline steps you want to see.
• Filter by job name. Type in the context search box to see only steps whose name contains the specified string.

If you filter by label and by job name, the pipeline displays only steps that match both filters.

Back to top

Delete a pipeline

In the Pipelines > Pipelines page, click the vertical ellipsis on a pipeline (in the upper summary bar), and then select View.

When the pipeline's details appear, click Delete and confirm the action.

If you delete a pipeline: 

• All of the pipeline's labels and configuration information are lost.

• The pipeline runs and the automated test runs from this pipeline are deleted. The automated test entities remain.

Back to top

Special pipeline types

The following section describes how to work with particular types of pipelines.

Back to top

Next steps:

• Run pipelines
• Tags
• Quality