Exporting Objects

You can export pipelines, fragments, jobs, and topologies from Control Hub. You can export a single object, a set of selected objects of the same type, or all objects of the same type that you have access to.

Control Hub saves the exported objects to your default downloads directory.

Exporting Pipelines

You can export the latest version of a published pipeline from the Pipelines view. Or you can export an earlier version of a published pipeline from Pipeline Designer.

When you export a pipeline that uses pipeline fragments, Control Hub also exports the pipeline fragment versions included in the pipeline.

When you export a single pipeline, Control Hub creates a ZIP file that contains a JSON file for the selected pipeline. The name of the ZIP file is based on the name of the pipeline, as follows: <pipeline name>.zip.

When you export multiple pipelines, Control Hub creates a ZIP file named pipelines.zip that contains a JSON file for each selected pipeline.

When you export pipelines that use connections or export pipelines with dependent fragments that use connections, the ZIP file includes an additional JSON file that contains the metadata for each connection.

Note: By default when you export pipelines, Control Hub removes plain text credentials configured directly in the pipeline. StreamSets recommends removing plain text credentials during the export. However, if needed, you can choose to export with plain text credentials. Exporting with plain text credentials retains only the credentials configured directly in the pipeline. It does not retain credentials configured in connections used by the pipeline.
  1. In the Navigation panel, click Pipeline Repository > Pipelines.
  2. Export pipelines in one of the following ways:
    • To export the latest version of a single pipeline or multiple pipelines, select pipelines from the list, and then click the Export icon: .
    • To export an earlier version of a single pipeline, open the pipeline in Pipeline Designer and select the version number at the top of the pipeline canvas. Click the Export icon: .
    • To export the latest version of all pipelines that you have access to, click the More icon () at the top of the Pipelines view, and then click Export All Published Pipelines.

    To export pipelines with plain text credentials using any of these methods, click the More icon () visible from each location and then select the Export with Plain Text Credentials option.

Exporting Fragments

You can export the latest version of a published pipeline fragment from the Pipeline Fragments view. Or you can export an earlier version of a published fragment from Pipeline Designer.

When you export a single fragment, Control Hub creates a ZIP file that contains a JSON file for the selected fragment. The name of the ZIP file is based on the name of the fragment, as follows: <fragment name>.zip.

When you export multiple fragments, Control Hub creates a ZIP file named fragments.zip that contains a JSON file for each selected pipeline.

When you export fragments that use connections, the ZIP file includes an additional JSON file that contains the metadata for each connection.
Note: By default when you export pipeline fragments, Control Hub removes plain text credentials configured directly in the fragment. StreamSets recommends removing plain text credentials during the export. However, if needed, you can choose to export with plain text credentials. Exporting with plain text credentials retains only the credentials configured directly in the fragment. It does not retain credentials configured in connections used by the fragment.
  1. In the Navigation panel, click Pipeline Repository > Pipeline Fragments.
  2. Export fragments in one of the following ways:
    • To export the latest version of a single fragment or multiple fragments, select fragments from the list, and then click the Export icon: .
    • To export an earlier version of a single fragment, open the fragment in Pipeline Designer and select the version number at the top of the pipeline canvas. Click the Export icon: .
    • To export the latest version of all fragments that you have access to, click the More icon () at the top of the Pipeline Fragments view, and then click Export All Published Pipeline Fragments.

    To export fragments with plain text credentials using any of these methods, click the More icon () visible from each location and then select the Export with Plain Text Credentials option.

Exporting Jobs

You can export active or inactive jobs and job templates. You cannot export a job instance created from a job template.

When you export a single job or multiple jobs, Control Hub creates a ZIP file named jobs.zip that contains job files. Job files are JSON files that contain the exported job or job template, the dependent pipeline, and any fragments used in the pipeline.

When you export jobs with dependent pipelines or fragments that use connections, the ZIP file includes an additional JSON file that contains the metadata for each connection.

  1. In the Navigation panel, click Jobs.
  2. Export jobs in one of the following ways:
    • To export a single job or multiple jobs, select jobs from the list, and then click the Export icon: .
    • To export all jobs that you have access to, click the More icon () at the top of the Jobs view, and then click Export All Jobs.

Exporting Topologies

You can export the latest version of a published topology from the Topologies view. Or you can export an earlier version of a published topology from the topology canvas.

When you export a single published topology or multiple published topologies, Control Hub creates a ZIP file named topologies.zip that contains topology files. Topology files are JSON files that contain the exported topology and the dependent jobs, pipelines, and pipeline fragments.

When you export topologies with dependent pipelines or fragments that use connections, the ZIP file includes an additional JSON file that contains the metadata for each connection.

  1. In the Navigation panel, click Topologies.
  2. Export topologies in one of the following ways:
    • To export the latest version of a single topology or multiple topologies, select topologies from the list and then click the Export icon: .
    • To export an earlier version of a single topology, open the topology in the topology canvas and select the version number at the top of the canvas. Click the More icon () and then click Export Topology.
    • To export the latest version of all topologies that you have access to, click the More icon () at the top of the Topologies view, and then click Export All Jobs.