Initialising a process flow manually with a payload
Introduction
The initialise flow (advanced) option can be used if you want to run a process flow immediately with a given payload in a single operation - it's particularly useful if you are sending data into Patchworks via the Patchworks API or a webhook and need to test a process flow with specific data.
Before initialising a process flow manually, make sure that you won't be duplicating data, or causing duplication next time the process flow runs according to trigger settings.
Need to know
The maximum number of characters for a single payload is 100k. Anything larger than this may cause the process flow to fail.
Your subscription tier determines the number of process flow runs that can be started per minute - please see Core subscription tiers for information.
When working with
draftprocess flows, you cannot edit shapes while the flow is being run manually.
The steps
To initialise a process flow manually with a payload, follow the steps below.
Using the initialise flow (advanced) option
Access the first process flow that you want to run, so it's displayed on the canvas. If necessary, use the versions panel in process flow settings to switch to the required flow version.
Select the initialise flow (advanced)
Select the initialise flow (advanced) option from the actions bar - for example:
The initialise flow (advanced) page is displayed:
Here, the left panel can be used to pass in a specific payload, and the right panel shows whether flow and/or environment values are present.
Apply payload
Paste your required payload into the payload panel - for example:
Review flow variables (if applicable)
If flow variables are present in the current flow version, a flow variables section is displayed -click the associated arrow to display any flow variables defined for the current version - for example:
If required, you can use the associated toggle option to override the current variable value - for example:
Review virtual environment variables (if applicable)
If a virtual environment variables section is displayed, it means that at least one virtual environment is deployed for your company profile. Click in the virtual environment field and select the environment that the current flow should run against - for example:
Any replacement environment variables configured for the selected virtual environment are listed below - for example:
If required, you can use the associated toggle option to override the current variable value - for example:
Run the process flow
Click the initialise flow button at the bottom of this page:
Check the logs and generated payloads to ensure that results are as expected. When you're satisfied that the process flow is running correctly, you can deploy it to the virtual environment.
Related pages
Last updated