# List Pipeline

The ***List Pipelines*** option opens the available Pipeline List for the logged-in user. All the saved pipelines by a user get listed on this page. The ***Details*** tab on the right side of the page displays the basic details of the selected pipeline.

{% hint style="success" %}
The ***Push to VCS*** and ***Pull Pipeline from GIT*** features are present on the  ***List Pipeline*** page and as well as on the ***Pipeline Editor*** page.
{% endhint %}

### Pushing a Pipeline into VCS

* Navigate to the ***Pipeline List*** page.
* Select a data pipeline from the displayed list.
* Click the ***Push Pipeline*** icon for the selected data pipeline.                                &#x20;

![Pushing a Pipeline to VCS](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FAkswdf3CJxr4dONVS4bD%2Fimage.png?alt=media\&token=67762e00-9ea0-4dd8-938f-2c64d6b4475f)

* The ***Push into Version Controlling System*** dialog box appears.
* Provide a ***Commit Message*** (required) for the data pipeline version.
* Select a ***Push Type*** out of the below-given choices to push the pipeline:&#x20;
  1. ***Version Control:*** For versioning of the pipeline in the same environment.
  2. ***GIT Export*** (Migration): This is for pipeline migration. The pushed pipeline can be migrated to the destination environment from the migration window in Admin Module.
* Click the ***Ok*** option.

&#x20;     ![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2Fu0AsJm6ybL2IlK82gPpG%2Fimage.png?alt=media\&token=9f539020-c3e4-4319-9c35-307be855cc9b)

* A notification message appears to confirm the completion of the action.                                           &#x20;

![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FqFCXeFBWsTMGNwQko86V%2Fimage.png?alt=media\&token=3e02a11b-9aad-4bed-b031-faa156432b66)

{% hint style="success" %}
*Check out the below-given illustrations on how to attempt **Version Control** and **Pipeline Migration**.*
{% endhint %}

***Version Control:***

![Push For Pipeline Versioning.](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FFdbqomdfotuylaBd9PqN%2FPushVCS.gif?alt=media\&token=fe3b6bab-ca29-4749-8e11-fb41c31afb53)

***Pipeline Migration:***

![Push For Migration](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FLUGpKGhTKAVBWjQnWAGu%2FMigration_push.gif?alt=media\&token=f706cdfc-65c5-4954-90b5-0930d72309c4)

{% hint style="info" %} <mark style="color:green;">Please Note:</mark>

* *The* *pipeline pushed to the VCS using the Version Control option, can be pulled directly from the **Pull Pipeline from GIT*** <img src="https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FTuKAKjbxBJT7EzdaBRJ0%2Fimage.png?alt=media&#x26;token=9a4ee1ce-da05-4a74-b50a-a560b606eb7d" alt="" data-size="line"> *icon.*
* *The user also gets an option to **Push the pipeline to GIT**. **This action will be considered as Pipeline Migration.***
  {% endhint %}

### Pulling a Pipeline from GIT

This feature is for pulling the previously moved versions of a pipeline that are committed by the user. This can help a user significantly to recover the lost pipelines or avoid unwanted modifications made to the pipeline.

{% hint style="success" %}
*Check out the walk-through on how to pull a pipeline version from the GIT.*
{% endhint %}

![Pulling a pipeline version committed earlier ](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2Fkla8Phbldn1w69tewnOb%2FPull_from_vcs.gif?alt=media\&token=fa3c63bb-9c4f-4acb-a66e-299fd1e0a4f0)

* Navigate to the ***Pipeline List*** page.
* Select a data pipeline from the displayed list.
* Click the ***Pull from GIT*** icon for the selected data pipeline.      &#x20;

![Pulling a Pipeline version from the GIT](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FoJZmlXSEDK2crBzkBRc6%2Fimage.png?alt=media\&token=58f185da-3207-4ebb-bb8a-eac0c408af1c)

* The ***Pull from GIT*** dialog box appears.
* Select the data pipeline version by marking the given checkbox.
* Click the ***Ok*** option.

&#x20;    ![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2Fnb0hCYvLU3DQt9YQ7wU4%2Fimage.png?alt=media\&token=9efd37a1-af16-493d-a5de-4093bc7b7287)

* A confirmation message appears to assure the users that the concerned pipeline workflow has been imported.    &#x20;

![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FpbS9K96LhUgmOaeKhfop%2Fimage.png?alt=media\&token=bed9a058-f6bf-4dac-a0c8-3ca57fa53532)

* Another confirmation message appears to assure the user that the concerned pipeline workflow has been pulled.   &#x20;

![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FPnJrJvPXFnAX6PZXw6gh%2Fimage.png?alt=media\&token=3d6ceabe-672f-4ca1-a9e4-3af1b97bcfac)

{% hint style="info" %}
*<mark style="color:green;">Please Note:</mark> The pipeline that you pull will be changed to the selected version. Please make sure to manage the versions of the pipeline properly.*
{% endhint %}

### View Pipeline

Clicking on the ***View*** icon will direct the user to the pipeline workflow editor page.

* Navigate to the ***Pipeline List*** page.
* Select a Pipeline from the list.
* Click the ***View*** icon.

![View icon for a Pipeline](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FekoIDdenkUBl6KJ9JvbD%2Fimage.png?alt=media\&token=da61a20b-0450-4140-a983-a5f4ac52c3b3)

* The ***Pipeline Editor*** page opens for that pipeline.      &#x20;

![Pipeline Editor page for the selected Pipeline](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FShEhtQwV1Zc6Z9L7tgbA%2Fimage.png?alt=media\&token=b3067f4d-7483-41ac-b9c3-277cd42d0f9c)

{% hint style="info" %}
*<mark style="color:green;">Please Note</mark>:*

*a. The user can open the Pipeline Editor for the selected pipeline from the list by clicking the **View** icon or the **Pipeline Workflow Editor** icon on the Pipeline List page.*

*b. The user can search for a specific pipeline by using the **Search bar** on the Pipeline List. By typing a common name all the existing pipelines having that word will list. E.g., By typing the **Sam** all the existing pipelines with the words that contain '**Sam' like sample** in it get listed in the following image:*

<img src="https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FHrEL2mj0gqxYK8S2OTJY%2Fimage.png?alt=media&#x26;token=a56e841b-76dc-4c20-b462-061a53215124" alt="" data-size="original">
{% endhint %}

### Monitor Pipeline

Clicking on the monitor pipeline icon will direct the user to the pipeline monitoring page.

* Navigate to the ***Pipeline List*** page.
* Select a Pipeline from the list.
* Click the ***Monitor*** icon.&#x20;

![Monitor icon provided on the Pipeline List page](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FgDRRkBJjcc9G5IirSuuU%2Fimage.png?alt=media\&token=16e49f3a-c21a-4fd2-a3c7-2804be599e15)

* The user gets redirected to the Pipeline Monitoring page of the selected Pipeline.
* The Monitor tab opens by default.
* The user can click the ***Data Metrics*** tab if wants to see depiction of the component specific data metrics.    &#x20;

![Monitor tab for a Data Pipeline](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FpmLgUN3YVuHnwHSxz74X%2Fimage.png?alt=media\&token=84f2fb79-33b0-499d-8f35-1f67bfe49a38)

{% hint style="info" %}
*<mark style="color:green;">Please Note:</mark> Check out the* [*<mark style="color:blue;">**Monitoring Pipeline**</mark>*](https://docs.bdb.ai/bdb-documentation/data-pipeline/getting-started/monitoring-pipeline) *page for the more details on this topic.*
{% endhint %}

### Test Pipeline

This feature has been introduced to test the components used in a Pipeline workflow without deploying the actual flow. The components can be tested individually, and we can verify if their behavior in terms of data consumption, processing, and data production is as expected or not.

* Navigate to the ***Pipeline List*** page.
* Select a Pipeline from the list.
* Click on the ***Test Pipeline*** icon.

&#x20;    &#x20;

![Test Pipeline ](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FFzMBu1V3qzCXSYvFPEtW%2Fimage.png?alt=media\&token=18666aac-52e3-4fa2-a916-695538a91c5e)

* The ***Pipeline Testing*** page opens displaying the component-based details (E.g., the following image displays the Logs details for the SQL component).&#x20;
* The page offers the following options to test a component.
  * **Run Test Case**
  * **Stop Test Case**
  * **Create Test Case**
* The page also displays the ***Test Case***, ***Reports***, ***Logs,*** and ***Advance Logs*** for the selected component.
* It displays the ***Run All Test Cases*** option at the bottom of the left side panel to run all the test cases for the selected pipeline.

![The Pipeline Testing page for the selected Pipeline](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FQ0YwfRSvsr6aTLUKsCWw%2Fimage.png?alt=media\&token=49590e4b-5c7f-4c7d-bc54-be46342971ef)

{% hint style="info" %}
*<mark style="color:green;">Please Note:</mark>*&#x20;

* *Click the **Refresh** icon to refresh the test data.*
* *Check out the* [*<mark style="color:blue;">**Testing Components**</mark>*](https://docs.bdb.ai/bdb-documentation/data-pipeline/getting-started/testing-suite) *page for more details on this topic.*
  {% endhint %}

### Sharing a Pipeline

The user can share a pipeline with one or multiple users and user Groups using the ***Share Pipeline*** option.

* Click the ***List Pipelines*** icon to open the Pipeline List.
* Select a Pipeline from the pipeline list.
* Click on the ***Share Pipeline*** icon.&#x20;

![Accessing the Share icon from the List Pipeline page](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FixfmX44XqAmtH9vPKpX8%2Fimage.png?alt=media\&token=28a05c12-1945-4b97-825f-6791294871d0)

* The ***Share Pipeline*** window opens.
* Select an option out of the given choices: ***User*** (default tab) and ***User Group*** or ***Exclude User*** (the **Exclude User** option can be chosen, if the pipeline is already shared with a user/user group and you wish to exclude them from the privilege).
* Select a user or user(s) from the displayed list of users (In case of the User Group(s) tab, it displays the names of the User Groups. &#x20;
* Click the arrow to move the selected User(s)/ User Group(s).

&#x20;     ![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FXah5w53FoCgWwVjxsyU7%2Fimage.png?alt=media\&token=aa1c1233-c7f3-407f-ab75-3aa08a19234d)

* The selected user(s)/user group(s) get moved to the box given on the right (In case of the ***Exclude User*** option the selected user/ the user moved to the right-side box looses the access of the shared pipeline).
* Click the ***Save*** option.&#x20;

&#x20;      ![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2F29X0g6e9yZ9WxjMV4OYk%2Fimage.png?alt=media\&token=1af9992b-e67a-4368-a7b4-ec07f34f4555)

* Privilege for the selected pipeline gets updated and the same gets communicated through a message.     &#x20;

![Confirmation message after a Pipeline gets shared.](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FC2WeRLi7Ie2Erygqejal%2Fimage.png?alt=media\&token=ec283296-e021-4efa-a621-9c4ac53c1291)

* By completing the steps mentioned above, the concerned pipeline gets successfully shared with the selected user/user group or the selected users can also be excluded from their privileges for the concerned pipeline.

{% hint style="info" %}
*<mark style="color:green;">Please Note:</mark>* *A non-admin user can **Edit/Modify** and **View** a pipeline but cannot **Share** it or **Delete** a shared pipeline.*
{% endhint %}

### Activate/Deactivate Pipeline

The user can activate/deactivate the pipeline by clicking on the Activate/ Deactivate icon.

* Click the ***List Pipelines*** icon to open the Pipeline list.
* Select a Pipeline from the pipeline list.
* Click on the ***Activate Pipeline*** icon.    &#x20;

![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FmVp46uWHcdQGf6hRnID8%2Fimage.png?alt=media\&token=54e67a78-56cd-4773-95a6-67afc2b9f1cb)

* The ***Confirmation*** dialog box opens to get the confirmation for the action.
* Click the ***YES*** option.

&#x20;      ![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FKx9cYgPPAhyxYMeGjSnx%2Fimage.png?alt=media\&token=05b39c5f-45a2-4a45-a080-86114054609e)

* A confirmation message appears.
* The pipeline gets activated. The ***Activate Pipeline*** icon turns into Deactivate Pipeline.
* the same gets communicated through the ***Status*** icon color.    &#x20;

![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2F5AJA4jT6wTUmVoyeFXzh%2Fimage.png?alt=media\&token=f87ba4cb-9851-47d3-882e-2cfe65eb624a)

* Click the ***Deactivate Pipeline*** icon. &#x20;

![Accessing the Deactivate icon](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FLEaeIn5UxEpJ7BiK7RZm%2Fimage.png?alt=media\&token=5da044e0-bafc-42eb-82df-2f864639dce5)

* The ***Confirmation*** dialog box opens to get the confirmation for the action.
* Click the ***YES*** option.

&#x20;   ![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FTc602EyXYlMBTG4izIqS%2Fimage.png?alt=media\&token=268df33f-ba1f-44a9-95b5-393459ab36c5)

* A confirmation message appears.
* The pipeline gets deactivated. The same gets communicated through the color of the ***Status*** icon. &#x20;

![](https://972575688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRYq1HgffNfbnIMWPu1D5%2Fuploads%2FV5A1vmPBsgmgtIV2B6o9%2Fimage.png?alt=media\&token=d6c5a2c8-af01-4de6-81d2-6032a6300c17)

&#x20;
