Exporting and importing flows

You can export and import flows. You might export flows to create backups to share flows with others, or to import flows into another project.

Exporting a flow

You can export a flow that is partially or completely configured. When you export a flow, the IBM watsonx platform creates a .zip file and saves it to the default download directory on your workstation. The file name is based on the flow name, as follows: flow_<flow id>.zip. The .zip file contains a .json file that describes the flow.

Use the following information to export a flow:
Optionally duplicate the flow and remove unnecessary details
All information that is defined in a flow is exported. When a flow includes information that should not be shared, such as credentials or table names, duplicate the original flow. Then, remove those details from the duplicate.
Also remove connections from stages. Flows with connections cannot be exported at this time.
Tip: To ensure that all sensitive details are removed from a stage, you can replace it with a new stage. Then, you can configure the properties that you want to share.
Export the flow
To export a flow, or an updated duplicate of a flow, click the Export icon Export icon in the flow canvas.
The IBM watsonx platform saves the flow .zip file to the default download directory on your workstation. Do not alter the file.

For example, you want to share one of your flows as a template. The flow reads from Kafka, performs data processing, and then writes to Snowflake. To ensure that the team does not access your Kafka and Snowflake data, you duplicate your flow. Then, you replace the Kafka and Snowflake stages with new stages to ensure that connections and sensitive details are not included in the export.

Importing a flow

About this task

You can import a flow to use a StreamSets flow that was previously exported.

You import a flow by using a flow .zip file that was created by exporting a StreamSets flow. A flow .zip file contains a .json file that describes the flow. The .zip file name is based on the flow name, as follows: flow_<flow id>.zip.

You cannot import a StreamSets flow when a flow of the same name exists in the project.
Tip: Rename the existing flow before you import a flow with the same name.

Procedure

  1. From within a project, on the Assets page, click New asset > Create a real-time streaming data flow.
  2. On the Create a StreamSets flow page, click Local file.
  3. Select the flow .zip file that you want to import, and then click Create.
    The canvas displays the imported flow.
  4. Review the flow details and update it as needed.
    For example, you might want to specify the connections to use, update property configurations, or add or remove processing from the flow.
    Before you run the flow, configure the environment to run the flow.