About Pipelines

The The "Pipelines" page icon is represented by several connected jobs. Pipelines page of a project selected from the The "Projects" module icon is a folder. Projects module library gives you access to this project’s pipeline library.

What is a pipeline?

A pipeline is an end-to-end process encompassing multiple jobs that are connected and executed within projects. A pipeline can include advanced orchestration logic, such as conditions or parallel job executions.

Pipelines are listed with few basic information, such as the name (a), status (b), and the last executed instance (c). You can also run (d) or delete (e) the pipeline from the pipeline library.

A clock Clock icon to view information about the next job run. icon (f) is displayed for scheduled pipelines: hover over the icon to view information about the next pipeline run.
Focused image of listed pipelines.

Click a pipeline to access its:

Overview Page

The The "Overview" page icon is a square divided into several other squares. Overview page provides general information about your pipeline.

By default, the page opens when you click a pipeline in the project’s pipeline library.

The first part of the page (1) provides general information about the pipeline, such as the name and description, and other pipeline settings.

The second part of the page (2) provides information about the pipeline instance such as the last status, the start and end date of the last instance and its duration, whether the pipeline variables were editable at runtime, the version used, and the pipeline creator.
In addition, you can see the progress of a running pipeline in real time. When a pipeline is running, you can select a job to see its overview. When a job has finished running, you can view its execution logs, and the summary table of used and modified variables (3), if the setting for modifying variables at pipeline execution was enabled.

Screenshot of the "Overview" page of a pipeline.

Use the buttons to adjust the view to suit your need. You can display the pipeline in full screen (a), zoom in and out (b), reframe it (c), and realign (d) the graph.

Instances Page

The The "Instances" page icon is three overlapping squares. Instances page provides information about your pipeline instances and allows you to keep track of all executed instances.

What is an instance?

An instance is a single run of a job or pipeline in a project. The execution information are saved on your platform.

Whenever you run a pipeline, a new instance of that pipeline is created. All instances are saved and remain accessible: they are listed on the right side of the page (1). You can view the information of an instance by selecting it in the list.

Screenshot of the "Instances" page of a pipeline.

By default, the page opens on the last executed instance of the selected pipeline.

The first part of the page (2) provides general information about the instance of the pipeline, such as the instance number (specified by #001 in the title), its execution status, the version of the pipeline used, the start and end times and duration, and whether the pipeline variables were editable at runtime.

The second part of the page (3) allows you to see the progress of the pipeline orchestration for the selected instance.
In addition, you can see the progress of a running pipeline in real time. When a pipeline is running, you can select a job to see its overview. When a job has finished running, you can also view its execution logs, and the summary table of used and modified variables (4), if the setting for modifying variables at pipeline execution was enabled.

Screenshot of a selected job from a pipeline instance to access this job overview and logs
Use the buttons to adjust the view to suit your need. You can display the pipeline in full screen (a), zoom in and out (b), reframe it (c), and realign (d) the graph.

To edit the pipeline, click The "Upgrade pipeline" icon is an arrow pointing up. Upgrade pipeline (5). It allows you to modify the name and description, the settings, add and delete jobs and conditions. Upgrading your pipeline creates a new version of it.

Versions Page

The The "Versions" page icon is a folder with an arrow pointing up. Versions page provides information about the current version of the pipeline, but also keeps track of its previous versions.

What is a version?

A version is a single iteration of a job, pipeline, or app. Each new update is stored as a version, enabling you to roll back to previous iterations and keep track of successive changes.

Whenever you upgrade a pipeline (1), a new version of that pipeline is created and automatically defined as the Current Badge for the "Current" status version.
All versions are saved and remain accessible: they are listed on the right side of the page (2). You can view the information of a version by selecting it in the list.
You can switch back and forth between versions as required by selecting a version from the list and clicking Rollback to this version (3). This action of rolling back to another version of the pipeline will make the selected version the new Current Badge for the "Current" status version.

You can also define a version as major to highlight the most stable version of a pipeline.
Select a version from the list and click Set as major version (4) to label the version as Major version. Sparks will appear in front of the major version. Similarly, click Unset as a major version to remove the label from a version.
Screenshot of the "Versions" page of a pipeline.

By default, the page opens on the version of the pipeline in use, tagged with the Current Badge for the "Current" status badge.

The first part of the page (5) provides general information about the version, such as the version number, the release note, and the creation date and creator.

The second part of the page (6) displays the pipeline version orchestration.

Use the buttons to adjust the view to suit your need. You can display the pipeline in full screen (a), zoom in and out (b), reframe it (c), and realign (d) the graph.

Environment Variables Page

This The "Environment variables" module icon is a rectangle with the "VAR" written in it. Environment Variables page gives you access to the pipeline’s environment variables.

What is an environment variable?

An environment variable is a dynamic value that can be referenced in jobs, limiting the need to modify job execution code every time the value of the variable changes.

Environment variables are listed with some basic information, such as name, description, and application level, indicated by the Pipeline badge envvar pipeline label.

At the pipeline level, the Icon for environment variables Environment Variables page gives you access to the environment variables defined for the selected pipeline but also to the project and global environment variables. However, you can only create and edit environment variables for the pipeline.

You can create up to 200 environment variables per pipeline. Once you reach this limit, the create button becomes unavailable, preventing you from creating new environment variables.

To view the information of an environment variable, click it. A panel opens with the information that you can also edit.
You can define your environment variable as a password. Select the option is password if your value is a password and must be hidden.
When viewing the details of a global or project environment variable in a pipeline, you can choose to override it for that pipeline only by clicking Override in this pipeline. The global or project environment variable will still exist at the platform or project level and will still be applied, except in this pipeline. For more information, see Overriding Environment Variables.

To access this page click The "Projects" module icon is a folder. ProjectsThe "Projects" module icon is a folder. > All Projects > My Project > The "Pipelines" page icon is represented by several connected jobs. Pipelines > My Pipeline > Icon for environment variables Environment Variables.

Environment variables can be created at the platform, project, and pipeline level, allowing you to have values dedicated to a specific scope without impacting other projects or pipelines. Therefore, you will find two other Environment Variables pages.

  • At the platform level: At this level, the The "Environment variables" module icon is a rectangle with the "VAR" written in it. Environment Variables page allows you to access, create, and edit only the global environment variables, that is, environment variables defined for all projects on the platform.
    For more information, see the Environment Variables page of a platform.

  • Within a project: At this level, the The "Environment variables" module icon is a rectangle with the "VAR" written in it. Environment Variables page gives you access to the environment variables defined for the selected project but also to the global environment variables. However, you can only create and edit environment variables for the project.
    For more information, see the Environment Variables page of a project.