Documentation

1.6 Tab overview on UI

In this article, you will learn about the different pipeline tabs. These tabs enable you to manage the pipeline details and configure its settings. There are six (6) pipeline tabs, each of these have different usage and functionality. The pipeline tabs include the following:

Properties

Properties tab contains the basic pipeline information. In this tab, you can view and update the pipeline details, archive and unarchive pipelines.

In this tab, you can:

          1. Update the pipeline description (Displayed in pop-up)
          2. Export Pipelines
          3. Set other general settings

Export Pipelines

To Export Pipeline click on Export button. Exported pipeline will be downloaded on your computer in *.json format

Archiving Pipelines

When a pipeline is archived, it will no longer be available for viewing and editing. To archive pipeline click the Archive button.

After clicking the Archive button, the archived pipeline will no longer appear in the active pipelines list.

Design

The Design tab enables you to create pipeline designs and processes. In addition, this where you can select agents, set up triggers, and choose plugins for your pipeline designs.

1. By default, when opening a pipeline, you will be directed to the pipeline’s Design tab.

Adding Plugins to your Pipeline

The Plugin section enables you to add installed plugins to your pipeline designs. These plugins are managed using the Manage menu’s Plugin feature, for more information, see the Managing Plugins article.

To access the Plugins option, follow the steps below:

1. Open the project and pipeline that you want to update. By default, when opening a pipeline, you will be directed to the pipeline’s Design tab.

2. In the Design sub-menu, click the Plugins icon.

3. After clicking the icon, the Plugins Bar will expand. Select a plugin and Drag and Drop it into the Designer panel.

4. Proceed setting up your pipeline and save it before executing.

It is important to note that as soon as the plugin appears in the Designer pane, it will be called a Process. To know more about pipeline development, see the First Pipeline Development article.

What is a Trigger

A trigger is an initial input that starts off the pipeline execution. It is an event listener such as a webhook catcher. Whenever the event throws a webhook, the trigger catches it and executes the pipeline.

To access the Triggers option, follow the steps below:

1. Open the project and pipeline that you want to update. By default, when opening a pipeline, you will be directed to the pipeline’s Design tab.

2. In the Design sub-menu, click the Triggers icon.

To know more about how to add agents, see the Triggers section of the Executing a Kaholo Pipeline article.

Code

The code layer enables you to add dynamic capabilities to your pipelines. For more information, see the Hello Code Tutorial’s Adding New Action and Code section.

Code should be written in Javascript

1. Open the project and pipeline that you want to update. Click on Code tab.

2. In order to connect the code layer to the design, you need to check the code option in the designer and type the METHOD-NAME().

3. To implement the method on the code environment, click the Code tab to access the code environment. Implement the method in the code layer:

function METHOD-NAME() {The implementation…}

4. In this tab, you can enter the pipeline’s codes.

5. After entering the codes, click Save to save the changes.

Execution Results

The Execution Results screen makes it easy to understand what happened during a pipeline execution and quickly troubleshoot failures.

Executions

You can see a summary of each execution and an overview of the execution’s status. You can download all logs and results of a particular execution by clicking on the download icon in the Execution Results Summary.

The Executions column provides general execution details of your pipeline:

    • Start and Finish time
    • Execution ID
    • Revision ID
    • The way your pipeline was triggered – started manually by a user, scheduled, or via webhook
    • Configuration: The name of the configuration that was used for the execution
    • Agent: The name of the agent that was used for the execution

Revisions

The Revision tab shows all revisions of the pipeline. Every time the Pipeline is saved, a new revision will be created. Revisions lets you do the following:

    • View any design changes
    • View the code in a standard difference mode
    • View process details the way it was previously configured
    • Create a new branch by hovering over the selected Revision and clicking the Save As icon.
    • Rollback to a previous Revision by hovering over the selected Revision and clicking the Revert As icon.

Page Contents