Importing Objects

You can import pipelines, fragments, jobs, and topologies that were exported from Control Hub.

Importing Pipelines

From the Pipelines view, you can import pipelines from individual pipeline files or from an archive ZIP file. Pipeline files are JSON files exported from Control Hub.

When you import a single pipeline, you can rename the pipeline during the import. When you import a set of pipelines, Control Hub imports the existing pipeline names.

When pipelines include fragments, importing pipelines also imports any fragments used in the pipelines with the existing fragment names.

If necessary, you can rename objects after the import.

  1. In the Navigation panel, click Build > Pipelines.
  2. Click the Import icon: .
  3. Configure the following information in the Upload File section:
    Upload File Property Description
    Browse File Select the ZIP or JSON file to import.
    Import File Type Type of import file, automatically chosen based on the file you select:
    • Archive File - Imports one or more pipelines from a ZIP file. Must also be used to import pipelines that use connections.
    • Pipeline JSON - Imports an individual pipeline from a JSON file.
    Name Name of the imported pipeline.

    Available when importing an individual pipeline from a JSON file.
    Commit Message Commit message for the imported pipeline versions.
  4. Click Import.
  5. If Control Hub displays a message that an imported pipeline already exists in the target organization, click one of the following buttons:
    • Cancel - Cancels importing the pipeline.
    • Import as new pipeline - Imports the pipeline as a new pipeline with the same name, but with a different pipeline ID.
  6. If the pipeline uses connections, select how to replace each connection.

    Control Hub lists the connection type and name for each found connection. Optionally expand a connection name to view where the connection is used in the pipeline.

    For each connection, choose one of the following options:

    • Use Existing Connection - Imports the pipeline so that it continues to use the existing connection. Available only when the connection exists in the target organization.
    • Create a Placeholder Connection - Automatically creates a new placeholder connection of the same connection type, updates the pipeline to use the placeholder connection, and then imports the pipeline. After the import, you must edit the new placeholder connection to define the required properties.
    • Remove Connection - Imports the pipeline without the connection. After the import, you must edit the pipeline to define the connection.

    For more detailed information about each option, see Replace Connections on Import.

  7. Click Continue.
  8. Click Close.

    The Pipelines view lists the imported pipelines.

Importing a Pipeline Version from the Canvas

When a published pipeline is open in the pipeline canvas, you can import a new version of that pipeline from an individual pipeline file. A pipeline file is a JSON file exported from Control Hub.

  1. Open a published pipeline in the canvas.
  2. In the top toolbar, click More > Import.
  3. Enter a commit message for the imported pipeline version.
  4. Click File, and then select the JSON file to import.
  5. Click Import.

Importing Fragments

You can import fragments from individual fragment files or from an archive ZIP file. Fragment files are JSON files exported from Control Hub.

When you import a single fragment, you can rename the fragment during the import. When you import a set of fragments, Control Hub uses the existing fragment names. If necessary, you can rename fragments after the import.

  1. In the Navigation panel, click Build > Fragments.
  2. Click the Import icon: .
  3. Configure the following information in the Upload File section:
    Upload File Property Description
    Browse File Select the ZIP or JSON file to import.
    Import File Type Type of import file, automatically chosen based on the file you select:
    • Archive File - Imports one or more fragments from a ZIP file. Must also be used to import fragments that use connections.
    • Pipeline JSON - Imports an individual fragment from a JSON file.
    Name Name of the imported fragment.

    Available when importing an individual fragment from a JSON file.
    Commit Message Commit message for the imported fragment versions.
  4. Click Import.
  5. If Control Hub displays a message that an imported fragment already exists in the target organization, click one of the following buttons:
    • Cancel - Cancels importing the fragment.
    • Import as new - Imports the fragment as a new fragment with the same name, but with a different ID.
  6. If the fragment uses connections, select how to replace each connection.

    Control Hub lists the connection type and name for each found connection. Optionally expand a connection name to view where the connection is used in the fragment.

    For each connection, choose one of the following options:

    • Use Existing Connection - Imports the fragment so that it continues to use the existing connection. Available only when the connection exists in the target organization.
    • Create a Placeholder Connection - Automatically creates a new placeholder connection of the same connection type, updates the fragment to use the placeholder connection, and then imports the fragment. After the import, you must edit the new placeholder connection to define the required properties.
    • Remove Connection - Imports the fragment without the connection. After the import, you must edit the fragment to define the connection.

    For more detailed information about each option, see Replace Connections on Import.

  7. Click Continue.
  8. Click Close.

    The Pipeline Fragments view lists the imported fragments.

Importing Jobs

You import jobs and job templates from an archive ZIP file containing job files. Job files are JSON files that contain the job or job template and the dependent pipeline and fragments exported from Control Hub.

Important: To import jobs with dependent pipelines or fragments that use connections, the connections must already exist in the target organization.

When you import a job or job template, Control Hub imports the existing names for the job, the dependent pipeline, and any fragments used by the pipeline. If necessary, you can rename objects after the import.

  1. In the Navigation panel, click Run > Job Instances.
  2. Click the Import icon: .
  3. Select the properties to import with the jobs.
    For the initial import of a job, you'll most likely want to select all properties.
    When you select the Pipeline property, the import includes all pipelines and any fragments used in the pipelines.
    Note: If you clear the Pipeline property for the initial import of a job, Control Hub still imports the dependent pipeline and any fragments used in the pipeline. Jobs must include a pipeline.

    For subsequent imports of a job that already exists in the target organization, you'll want to clear the properties that you have modified in the target organization. Any selections that you make overwrite the configured job properties in the target organization.

  4. Select the ZIP file containing the job files to import.
  5. Click Import.
  6. Click Close.

    The Job Instances view lists the imported jobs.

Importing Topologies

You import topologies from an archive ZIP file containing topology files. Topology files are JSON files that contain the topology and the dependent jobs, pipelines, and fragments exported from Control Hub.

Important: To import topologies with dependent pipelines or fragments that use connections, the connections must already exist in the target organization.

When you import a topology, Control Hub imports the existing topology name and the existing names for all dependent jobs, pipelines, and fragments. If necessary, you can rename the objects after the import.

  1. In the Navigation panel, click Monitor > Topologies.
  2. Click the Import icon: .
  3. Select the properties to import with the dependent jobs.
    For the initial import of jobs, you'll most likely want to select all properties.
    Note: When you import a topology, Control Hub always imports the pipeline versions used by the dependent jobs and any fragments used in those pipeline versions.

    For subsequent imports of jobs that already exist in the target organization, you'll want to clear the properties that you have modified in the target organization. Any selections that you make overwrite the configured job properties in the target organization.

  4. Select the ZIP file containing the topology files to import.
  5. Click Import.
  6. Click Close.

    The Topologies view lists the imported topologies.