Manage Pipelines

This page shows how you can manage your existing pipelines on the Pipeline Manager page.

To create a new pipeline or edit one that's already configured, see Set Up and Edit Pipelines.

📘

NOTE

Only organization administrators can set up, edit, deactivate, and activate pipelines.

Access the Pipeline Manager Page

To open the Pipeline Manager page, do the following:

  1. Sign in to the TDP as a user with an Administrator role.
  2. In the left navigation menu, choose Pipelines.
  3. Choose Pipeline Manager. The Pipeline Manager page appears.

Pipeline Manager Page Information

The Pipeline Manager page shows the following information in a list view:

Column NameDescription
PIPELINE NAMEShows the name of each pipeline
PROTOCOLShows the name and version number of the protocol each pipeline uses

Note: Icons underneath each protocol show the first letter of the step(s) that are used in the protocol. Hover over the step icon to see more information about each step.
LAST CONFIG UPDATEShows the number of days since the configuration was last updated

Filter the List of Pipelines and Adjust Ordering

You can filter and adjust the ordering of pipelines by doing any of the following.

Search for Pipelines by Pipeline Name or ID

To search for pipelines by a specific name or ID, do the following:

  1. Open the Pipeline Manager page.
  2. Enter the pipeline name or ID that you want to find in the upper left search field, labeled Search Pipeline name/id. As you enter the name or ID, pipelines that match the name or ID of what you enter appear.

Search for Pipelines by Protocol Namespace, Protocol Name, or Protocol Version

To search for pipelines by a specific protocol namespace, protocol name, or protocol version, do the following:

  1. Open the Pipeline Manager page. Then, select the Filters button. A list of filters appears.
  2. Select the drop-down next to the filter that you want to apply. A list of your available filter choices appears. For example, if you choose Protocol Name, the protocols available in your TDP instance appear.
  3. Select the filter choices that you want. The protocol versions that are available depend on the protocol name that was chosen.
  4. Choose Apply Filters.

View Active and Inactive Pipelines

To filter the list of pipelines based on if their active (enabled) or inactive (disabled), select one of the following options from the top of the Pipeline Manager page:

  • All—shows both active and inactive pipelines
  • Enabled—shows active pipelines only
  • Disabled—shows inactive pipelines only

Adjust the Pipeline List Order

To reorder the list of pipelines, select the upper right ORDER BY drop-down list on the Pipeline Manager page. Then, select one of the following options based on how you want to order the list:

  • Last Update, New - Old
  • Last Update, Old - New
  • Name , A - Z
  • Name, Z - A
  • Create Date, New - Old
  • Create Date, Old - New
  • Protocol Name, A - Z
  • Protocol Name, Z - A

View More Information about a Pipeline

To see information about the steps in a pipeline protocol as well as details about the way the pipeline is set up and its workflow, you can do any of the following:

  • View step summaries by hovering over the PROTOCOL step icon.
  • View pipeline and workflow details by selecting a pipeline from the list.
  • Compare different pipeline versions by selecting a pipeline, and then choosing View Version History.

View Step Summaries

Beneath each protocol listed on the Pipeline Manager page, there are lettered icons that show the protocol's steps. The letter corresponds to the first name of the step slug. Hovering over these lettered icons shows a summary of step information that includes the following information:

  • Step Slug (a unique name for the step)
  • Description
  • Task script details, including the following:
    • Script slug
    • Script namespace
    • Script version
  • Function Slug

For definitions of these terms and more information about how each of these elements work, see Self-Service Tetra Data Pipelines.

View Pipeline and Workflow Details

To view pipeline and workflow details for a specific pipeline, do the following:

  1. Open the Pipeline Manager page. Then, select the pipeline's name. A pane appears on the right that provides details about the pipeline and its workflow.
  2. To review the pipeline's details, select the Pipeline tab in the right pane.
    -or-
    To view the workflow details, select the Workflow tab in the right pane.

Compare and Restore Different Pipeline Versions

To compare how versions of your pipeline configurations differ or restore previous pipeline versions, do the following:

  1. Open the Pipeline Manager page.
  2. Select the pipeline that you want to review. The Pipeline Actions menu appears on the right.
  3. Choose View Version History. The Pipeline Versions page appears and displays your Current Pipeline version's configuration information alongside your Selected Revision version's configuration information.
  4. In the left Version History menu, select a previous pipeline version that you want to compare to your current pipeline version.
  5. (Optional) To see the differences between each pipeline version's protocol's scripts, choose Protocol Config. A dialog appears that highlights the differences between each pipeline version's protocol.
  6. (Optional) To restore a previous version of a pipeline, choose Restore Version. The selected revision pipeline version becomes your current pipeline. To edit your current pipeline version, see Edit a Pipeline.