Articles in this section

Manage multi-instance flows and instances

After you create instances, you manage them from the Instances tab of the base flow. From there, you can run and schedule instances, turn instances and the base flow on or off, review each instance's errors, and delete instances. This article covers each of these tasks and the rules that control them.

Prerequisites: You must have Manage permissions on the integration to change a multi-instance flow or its instances.

Open the Instances tab

The Instances tab lists every instance of a base flow with its status and controls.

  1. Go to Build build-icon.png, and then select Flows.
  2. Open the multi-instance flow. Multi-instance flows display a Multi-instance label next to the flow name.
  3. Select the Instances tab.

The tab shows the following for each instance:

  • Name/Description — The instance name. Select it to open a view-only flow builder for the instance, with its own Run history tab.
  • Errors — The instance's error status. Select it to review the instance's errors.
  • Last updated — When the instance configuration was last saved.
  • Last run — When the instance last ran.
  • Instance configuration — Opens the instance's overrides for editing.
  • Schedule — Opens the instance's schedule.
  • Run — Runs the instance now. Available only while the instance is on.
  • Off/On — Turns the instance on or off.
  • Actions — Opens Edit instance, View audit log, and Delete Instance.

The base flow also has a Connections tab, which lists the connections the flow uses, and an Audit log tab, which records changes to the flow. The base flow has no Run history tab, because only instances run.

The Instances tab of a multi-instance flow, showing four instances with their Errors, Last updated, Schedule, Run, Off/On, and Actions columns.

Run an instance

You can run an instance on demand or on a schedule. Each instance has its own schedule, independent of other instances. You can't run or schedule the base flow itself.

  • To run an instance now, select Run in the instance's row. The instance must be on.
  • To schedule an instance, select Schedule in the instance's row, and then set the schedule. For details, see Schedule a flow.

Turn instances and the base flow on or off

Each instance has its own on/off state, and the base flow has an on/off state that overrides all of its instances. Turning off a flow or instance stops future scheduled runs but doesn't stop a run already in progress.

  • To turn an instance on or off, select the Off/On toggle in the instance's row.
  • To turn the base flow on, select Enabled in the flow header. To turn it off, select Test mode.

Caution: Turning off the base flow stops every instance.

The base flow's state determines whether instances run:

Base flow Instance setting Result
On On The instance runs on its schedule and can be run manually.
On Off The instance doesn't run.
Off On or off The instance doesn't run, and you can't change any instance.

When you turn the base flow back on, every instance that was on before you turned off the base flow turns back on.

Review errors for an instance

Each instance tracks its own errors. The Errors column in the Instances tab shows each instance's error status.

  1. In the Instances tab, find the instance.
  2. Select its entry in the Errors column.
  3. Review, retry, or resolve the errors. For details, see Troubleshoot errors: root cause analysis and diagnostic tools.

Delete an instance

Deleting an instance removes it from the base flow. You must delete every instance before you can delete the base flow or convert it back to a standard flow.

  1. In the Instances tab, find the instance.
  2. Turn off the instance. Delete Instance isn't available while the instance is on.
  3. Select Actions elipses-button.png in the instance's row, and then select Delete Instance.
  4. In the Confirm delete dialog, select Delete.

The deleted instance moves to the Recycle bin, where you can restore it until it's purged. A restored instance keeps its overrides and returns turned off.

Delete a base flow

You can delete a base flow only after you delete all of its instances.

  1. Delete every instance of the base flow.
  2. Turn off the base flow. Delete flow isn't available while the flow is on.
  3. In the flow builder, select Actions elipses-button.png > Delete flow.
  4. In the Confirm delete dialog, select Delete. If the base flow still has instances, an Unable to delete flow dialog lists them, and the flow isn't deleted.