The process flow canvas is where you build and test your process flows in a smart, visual way. This is where you define if, when, what, and how data is synced.
The process flow canvas has four main elements - a title, an actions bar, a shapes area, and a (hidden unless activated) options panel:
The process flow title bar shows the name of the process flow, 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.
Options in the actions bar are summarised below:
The main 'shapes 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!
We're adding new shapes all the time! For information about working with shapes, please see our Process flow shapes section.
When you access process flow settings or to 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:
| Option | Summart |
|---|---|
Process flow settings
Use this option to access settings for this process flow - these are used to manage settings for this process flow as a whole. 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).
Use this option to run the process flow immediately. For more information please see Running a process flow manually.
Use this option to provide a payload to be passed in before the process flow initialises. This is particularly useful if you want to test how a flow will run with expected data from a Patchworks API request.
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 however, 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.
As a process flow runs, you can view progress in real time; you can also check logs and view payloads at any stage.
