Articles in this section

Create multi-instance flows and instances

Kathyana Queeman
Updated

You can use multi-instance flows to create one base flow from which you can generate unique, custom instances. An instance is simply a flow that retrieves its configuration details from the multi-instance base flow, but can still be individually configured. You can either convert an existing flow into a multi-instance base flow or create a new multi-instance base flow from scratch. After creating the base flow, you can select your customizable properties and create your instances.

You can also override your instance configurations using JSON.

Important

This feature is only available in Professional and Enterprise editions.

 

Create or convert a base flow

You can either create a new multi-instance base flow or convert an existing flow. Regardless of how you create the flow, it must be stored in an integration. A base flow cannot be a standalone flow.

Warning

Your standard flow's run history and other details will be deleted if you convert it to a multi-instance base flow.

Create a base flow

To create a new base flow:

  1. Open any integration.

  2. Click + Create → Multi-instance flow.

    create.png

  3. Build your new flow.

After you create the flow, you must select the properties you'd like to customize. Then, you can create an instance.

Convert an existing flow

To convert an existing flow to a multi-instance base flow:

  1. Open any flow in an integration.

  2. On the top, right side of Flow builder, click Action (...) → Convert to multi-instance flow.

    convert.png

  3. Confirm that you'd like to convert the flow.

    convert_confirm.png

After you create the flow, you must select the properties you'd like to customize. Then, you can create an instance.

Choose your customizable properties

Before you create an instance, you must select the properties you want to customize. Only the properties you select here will be customizable when you configure an instance.

To select your customizable properties:

  1. Click Create with guided setup.

    create_with_guided_setup_no_instances.png

    The customizable properties panel will open automatically.

  2. For each flow step, select the properties you want to customize. For example, you can select the export's connection, HTTP method, and Relative URI, and the import's mappings.

    Cusotmizable_properties_with_flow_steps.png

    Customizable export properties

    custom_prop_import_mapping.png

    Customizable import properties

  3. Click Save and create instance to continue creating your first instance.

    Cusotmizable_properties_with_flow_steps.png

    – OR –

    Click Save and close to only add your customizable properties.

Configure an instance

Next, create an instance and configure its customizable properties. You can toggle between Simple and JSON views to configure your flow by overriding your JSON properties.

Note

Only the properties you selected as customizable are configurable.

  1. If you started a guided setup, click Save and create instance to continue.

    Cusotmizable_properties_with_flow_steps.png

    – OR –

    If you didn't complete the guided setup, click Create instance.

    no_instances.png

  2. Configure your instance's customizable properties.

    Note

    Only the properties you selected as customizable are configurable.

    create_instance_with_properties.png

    Customizable export properties

    import_mapping_instance.png

    Customizable import properties

  3. Click Save and close to publish your first instance.