The process flow canvas (new)

This is preview documentation. The new canvas will be available following our next scheduled release.

Introduction

The process flow canvas has five main elements: title bar, actions bar, layout options, build area, and a flow navigator (minimap). For example:

Once you start adding shapes to a flow, you'll also encounter the settings drawer. For example:

The following sections summarise these areas.

Process flow title bar

The process flow title bar shows the process flow name, as specified when it was created. The number above the title is the process flow id , and the number below is the version number. To change this title, use the settings option from the actions bar.

The copy link with current company id icon to the right of the title can be used to copy a link to this process flow, which includes the id for your company profile:

This is useful if:

• You manage multiple Patchworks profiles. Sharing this link with other team members (who have sufficient permissions) allows them to access the process flow directly - seamlessly switching to the relevant company profile.

• You need to raise a support query regarding a process flow. Including this link in your support ticket means that a member of our Support team can access the flow more efficiently, seamlessly switching to the relevant company profile.

Process flow actions

Options in the actions bar are summarised below:

Option	Summary
	Process flow settings Use this option to access general settings for this process flow. For more information, please see Process flow settings.
	Return to trigger If you're working on a longer process flow, use this option to quickly jump back to the start (i.e. back to the trigger shape).
	Initialise flow now Use this option to run the process flow manually (rather than waiting for a trigger to be invoked). For more information, please see Running a process flow manually.
	Initialise flow (advanced) Use this option to run the process flow manually with a given payload. This is particularly useful for testing - for example, if you want to test how a flow will run with expected data from a Patchworks API request. If the virtual environments feature is enabled for your company profile, you can also use this option to test a process flow against a given virtual environment.
	Stop the current run If a process flow is running, you can use this option to stop the current run. Stopping a run in this way triggers the flow to stop at its next step. If an API call or script has already been triggered, the process flow will stop after these have completed. With this in mind, it's important to check any target connections to clarify what (if any) updates have been made after a process flow has been stopped.
	Logs & payloads Toggles the details panel off/on. As the process flow runs, you can view progress in real time; you can also check logs and view payloads at any stage.
	Toggle new canvas If you're currently working with the classic canvas, use this option to switch to the new canvas. You can switch back at any time. Note that if you switch from the new canvas back to classic, any disconnected shapes are NOT displayed in classic flow.

Layout options

Layout options are summarised below:

Option	Summary
	Snap to grid Toggle this option on for precise shape placement (shapes align with the grid as they are added).
	Auto layout Arranges all shapes into a 'clean', readable layout, automatically.
	Layout direction Toggle between vertical (top-to-bottom) and horizontal (left-to-right) layouts.
	Fit to viewport Zoom out to see all steps in the flow.

Build area

The main 'build area' is where you build your process flow. Start by clicking the + sign associated with the trigger shape, then choose the required shape for your next step, and start building!

For more information about techniques for working with the canvas as you build a flow, please see Canvas interactions and General canvas features.

We're adding new shapes all the time! For information about working with shapes, please see our Process flow shapes section.

Flow navigator (minimap)

A minimap is always displayed in the bottom, right-hand corner of the canvas. This is a small, zoomed-out thumbnail of your entire flow. It's particularly useful for quick navigation when working with longer, more complex process flows. For example:

A highlighted box within the minimap shows exactly where your current viewport is positioned relative to the full flow. Drag this box up/down/left/right to jump to different parts of the flow, without having to scroll or pan across the main canvas.

Settings drawer

When you access process flow settings or configure a shape in your flow, available settings are displayed in a panel on the right-hand side. For example, when we choose to access settings for a trigger shape, available trigger options are displayed: