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.

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.

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.

  • 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:

    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.

  • A notification message appears to confirm the completion of the action.

Check out the below-given illustrations on how to attempt Version Control and Pipeline Migration.

Version Control:

Pipeline Migration:

Please Note:

  • The user also gets an option to Push the pipeline to GIT. This action will be considered as Pipeline Migration.

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.

Check out the walk-through on how to pull a pipeline version from the GIT.

  • 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.

  • The Pull from GIT dialog box appears.

  • Select the data pipeline version by marking the given checkbox.

  • Click the Ok option.

  • A confirmation message appears to assure the users that the concerned pipeline workflow has been imported.

  • Another confirmation message appears to assure the user that the concerned pipeline workflow has been pulled.

Please Note: The pipeline that you pull will be changed to the selected version. Please make sure to manage the versions of the pipeline properly.

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.

  • The Pipeline Editor page opens for that pipeline.

Please Note:

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:

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.

  • 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.

Please Note: Check out the Monitoring Pipeline page for the more details on this topic.

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.

  • The Pipeline Testing page opens displaying the component-based details (E.g., the following image displays the Logs details for the SQL component).

  • 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.

Please Note:

  • Click the Refresh icon to refresh the test data.

  • Check out the Testing Components page for more details on this topic.

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.

  • 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.

  • Click the arrow to move the selected User(s)/ User Group(s).

  • 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.

  • Privilege for the selected pipeline gets updated and the same gets communicated through a message.

  • 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.

Please Note: A non-admin user can Edit/Modify and View a pipeline but cannot Share it or Delete a shared pipeline.

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.

  • The Confirmation dialog box opens to get the confirmation for the action.

  • Click the YES option.

  • 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.

  • Click the Deactivate Pipeline icon.

  • The Confirmation dialog box opens to get the confirmation for the action.

  • Click the YES option.

  • A confirmation message appears.

  • The pipeline gets deactivated. The same gets communicated through the color of the Status icon.

Last updated