An instance is a customized copy of a multi-instance base flow that runs on its own schedule with its own settings. Before you create instances, you select the base flow's customizable properties, which are the fields each instance can change. This article shows you how to select customizable properties, create an instance in the Simple view, and edit instances and customizable properties later. To configure instances with JSON instead, see Override instance configurations with JSON.
Prerequisites: Before you start, you need a multi-instance base flow. See Create a multi-instance base flow.
Select customizable properties
Customizable properties are the fields instances can change in the Simple view. Fields you don't select keep the base flow's value in every instance configured with the Simple view.
- Go to Build
, and then select Flows. Open the multi-instance flow, and then select the Instances tab.
- Open the Customizable properties panel:
- If the base flow has no instances, select Create with guided setup. The empty Instances tab also offers Create with JSON, which skips customizable properties and opens the JSON view. For JSON configuration, see Override instance configurations with JSON.
- If the base flow already has instances, select Customizable properties.
- Under Flow steps, select a step.
- Select the checkbox next to each property instances can change. For example, select Connection and Relative URI on an export, or Mapping on an import.
- Repeat steps 3 and 4 for each flow step.
- Select one of the following:
- Save & create instance to save your selections and create your first instance.
- Save & close to save your selections without creating an instance.
Create an instance
Create one instance for each variant of the flow, such as one per store or customer.
- Go to Build
, and then select Flows. Open the multi-instance flow, and then select the Instances tab.
- Select Create instance. If you selected Save & create instance, skip this step.
- At the top of the panel, select New instance, and then type a name for the instance, such as the store or customer it serves. To add a description, select Description next to the name.
- Under Flow steps, select a step, and then enter values for its customizable properties. Only the steps and properties you chose as customizable appear in the Simple view.
- Repeat step 4 for each flow step you want to customize. Any property you leave unchanged uses the base flow's value.
- Select Save & close.
The new instance appears in the Instances tab, turned off. To run it, turn it on, as described in Manage multi-instance flows and instances. Instances without a name display as Unnamed followed by the instance ID.
Edit an instance
You can change an instance's overrides at any time while its base flow is turned on.
- Go to Build
, and then select Flows. Open the multi-instance flow, and then select the Instances tab.
- In the instance's row, select Instance configuration. You can also select Actions
> Edit instance.
- In the Edit instance properties panel, change the values in the Simple or JSON view.
- Select Save, and then select Close.
Change customizable properties
You can add or remove customizable properties after you create instances.
- Go to Build
, and then select Flows. Open the multi-instance flow, and then select the Instances tab.
- Select Customizable properties.
- Select or clear the checkbox next to each property.
- Select Save & close.
Adding a property makes it available to every instance. Clearing a property removes it from the Simple view of every instance, but it doesn't remove existing overrides. An instance that already overrides the property keeps that override, which you can still see and edit in the instance's JSON view.