Introduction

The process flow name can be changed via flow settings. Any change takes immediate effect.

The steps

To rename a process flow, follow the steps below.

Step 1 Access the process flow that you want to rename.

Step 2 Click the 'cog' icon to access flow settings:

Step 3 Change the name as required and save your changes - for example:

Introduction

When a process flow is duplicated, all shapes are copied (so the structure of the flow is replicated entirely) however, some shapes must be reconfigured. Reconfiguration requirements depend on where the process flow is copied:

• As a 'typical' user managing your own company profile, you can duplicate an existing process flow to use as a starting point for a new process flow, within your company. Please see Duplicating a process flow for the current company profile.

• As a Patchworks partner/agency managing multiple company profiles, you can duplicate process flows between these profiles. In this case, there are a few variations to consider - please see Duplicating a process flow between different company profiles.

Duplicating a process flow for the current company profile

The table below summarises shape reconfiguration requirements when a process flow is duplicated within the current company profile.

Duplicating a process flow between different company profiles

When a process flow is duplicated between different company profiles, most reconfiguration requirements are consistent with those detailed above. Variations to consider when duplicating between company profiles are summarised below.

Introduction

Any process flows that you add can be found in your process flows list. From here, you can view, update or remove any existing flow.

In this section

• Accessing your process flows

• Enabling & disabling a process flow

• Renaming a process flow

• Duplicating a process flow

• Process flow labels

• Initialising a process flow manually

• Initialising a process flow manually with a payload

• Stopping a running process flow

• Removing a process flow

Introduction

Any process flows that you create are added to your manage process flows page - for example:

From here, you can add new process flows or choose to update/remove an existing one.

The steps

To access your existing process flows, follow the steps below.

Step 1 Log in to the Patchworks dashboard.

Step 2 Select process flows > process flows.

Introduction

Process flow labels are created and managed from general settings. From here you can:

Need to know

• If you update the name and/or colour of a process flow label, that change is immediately applied to any process flows where this label is already applied.

• If you delete a process flow label from general settings, that label is immediately removed from any process flows where it was already applied.

• A process flow label cannot exceed 20 characters.

Adding a new label

Labels can be created in two ways:

• when you need to add a label quickly whilst working with a process flow.

• , which is useful when you need to add/manage a batch of labels

Adding a new label from a process flow

If you're working with a process flow and want to quickly add a label that doesn't exist currently, you can create it from the settings drawer. To do this, follow the steps below:

Step 1 Select the settings option from the canvas toolbar:

Step 2 Click the create label link beneath the labels field:

Step 3 Enter a name for the label and then select a colour:

Step 4 Click the create label button:

Step 5 The label is created and can now be selected via the labels field:

Adding a new label via general settings

If you want to create a number of labels for use in your process flows, you can add them via general settings. To do this, follow the steps below:

Step 1 Select settings from the bottom of the left-hand navigation menu:

Step 2 Select the labels option:

Step 3 Click the create label button:

... a new label form is displayed:

Step 4 Enter a name for the label and select a colour:

Updating an existing label name or colour

To update the name or colour for an existing label, follow the steps below:

Step 1 Access labels from general settings.

Step 2 If required, change the label name.

Step 3 If required, select a new label colour.

Step 3 Click the save button:

Remove an existing label

To remove an existing label, follow the steps below:

Step 1 Access labels from general settings.

Step 2 Click the delete button:

Step 3 Confirm this action:

Introduction

Labels are used to tag/organise process flows in whatever way you need:

Need to know

• If you update the name and/or colour of a process flow label, that change is immediately applied to any process flows where this label is already applied.

• If you delete a process flow label from general settings, that label is immediately removed from any process flows where it was already applied.

• A process flow label cannot exceed 20 characters.

More information

Introduction

If you need to create a new process flow that's similar to one that already exists, you can duplicate the existing process flow and use this as a starting point for your new design.

The duplicate option is available from process flow settings so you can copy a specific version. When a process flow is duplicated, a copy is added to your with the same name, appended with an incremented copy number.

Need to know

• The of the duplicated flow is always set to disabled.

• The of the duplicated flow is always set to draft.

• Existing are duplicated (which means they are created automatically in the receiving company).

• All shapes are copied but some shapes require reconfiguration in the receiving company - please see our .

The steps

To duplicate a process flow, follow the steps below.

Step 1 that you want to duplicate.

Step 2 Click the 'cog' icon to access flow settings:

Step 3 Click the ellipses that's associated with the version that you want to duplicate:

Step 4 Select the duplicate flow option:

Step 5 When prompted, click the duplicate button to confirm:

Introduction

If you are managing multiple linked companies, copying process flows between them can be very useful. In this case, the duplicate process flow procedure is slightly different.

Need to know

• You can only copy a process flow to companies that you have been granted permission to access.

• All shapes are copied but some shapes require reconfiguration in the receiving company - reconfiguration requirements can be different when duplicating between companies. Please see our Shape configuration in a duplicated process flow page.

• Existing labels are duplicated (which means they are created automatically in the receiving company).

• The status of the duplicated flow is always set to disabled.

• The version of the duplicated flow is always set to draft.

The steps

Step 1 Access the process flow that you want to duplicate.

Step 2 Click the 'cog' icon to access flow settings:

Step 3 Click the ellipses that's associated with the version that you want to duplicate:

Step 4 Select the duplicate flow option:

Step 5 When prompted, choose copy to other company:

Step 6 Search for the required company profile, or browse all company profiles that you manage - for example - for example:

Step 7 Having selected a company profile, click the duplicate button to complete this operation:

The duplicated process flow is copied into the manage process flows area for the selected company profile. This may take a moment to complete and you'll see a message when the process flow is ready.

Step 8 Switch into the managed company and edit the process flow. Check all shapes to see if any reconfiguration is required. If a shape includes options that cannot be duplicated, it's displayed with a warning icon - for example:

Related information

• Managing linked company profiles

• Managing team members & users for linked company profiles

Introduction

When you build a new process flow, it is disabled by default. When you're satisfied that a flow is ready for use, you must:

• Deploy the process flow

• Enable the process flow

This page explains how to enable a process flow.

The steps

To enable/disable a process flow, follow the steps below.

Step 1 Access the process flow that you want to enable/disable.

Step 2 Click the 'cog' icon in the canvas toolbar to access general settings for this process flow:

Step 3 In the settings panel, toggle the enabled option on/off as required:

Introduction

The initialise flow with payload 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.

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.

The steps

To initialise a process flow manually with a payload, follow the steps below.

Step 1 Access the process flow that you want to run.

Step 2 Click the initialise flow with payload option from the toolbar:

Step 3 A payload window is displayed:

...so you can paste in the required payload and initialise the flow:

If required, you can also choose to pass in a flow variable value. Any existing flow variables are displayed - to make a change, toggle the variable field ON and update the value as needed:

Introduction

If you initialise a process flow manually and want to stop the run, you can use stop button from the canvas actions bar. However, there may be times where you need to stop a process flow that was triggered to run automatically. You can do this via the run logs page.

Demo

The steps

To stop a running process flow that was triggered automatically, follow the steps below.

Step 1 Log into the Patchworks dashboard.

Step 2 Select run logs from the left-hand navigation menu.

Step 3 Check the status of entries to find the running process flow that you want to stop.

Step 4 Click the stop button associated with the entry that you want to stop:

Step 5 The process flow is stopped and the status for this run is set to stopped.

Introduction

Typically, process flows will run on an automated basis, as per trigger shape settings. However, there may be times when you want to run a flow immediately - for example, if you're testing a new flow, or troubleshooting a sync issue.

When you run a process flow manually, you'll see each shape animate as it's reached, with real-time logs displayed in a side panel.

Need to know

There is a limit on the number of process flow runs that can be started per minute. This limit varies according to your subscription tier - please see Core subscription tiers for information.

The steps

To run a process flow manually, follow the steps below.

Step 1 Access the process flow that you want to run.

Step 2 Click the 'play' icon to initialise the process flow:

Step 3 The process flow runs. As it runs, you'll see that each shape animates as it's reached, and real-time logs are displayed - for example:

Introduction

If a process flow is no longer required, you have the option to disable it (but keep the process flow in place for future reference or use), or to remove it permanently. This page explains how to remove a process flow permanently.

The steps

To remove a process flow, follow the steps below.

Step 1 Access the process flow that you want to enable/disable.

Step 2 Access settings for the process flow:

Step 3 Click the delete flow option:

...the process flow is removed immediately.

Introduction

Existing process flow labels can be and for a process flow via process flow settings. You can define labels for any purpose - there's no right or wrong way to use them. For example, you might define labels to indicate the testing status of a flow, or indicate a specific shape that's included in the flow, or perhaps you might want to flag a process flow for a specific user.

As the number of process flows grows for your organisation, it can also be useful to .

Applying labels to a process flow

Step 1 that you want to update.

Step 2 Click the 'cog' icon in the toolbar to access settings for this process flow:

Step 3 Click in the labels field to list all available labels:

Step 4 Select any labels that you want to apply (you can apply a single label or multiple labels at the same time):

Step 5 Save settings.

Removing labels to a process flow

Step 2 Access process flow settings.

Step 3 Click the cross associated with a label that you want to remove:

Step 4 Save settings.

Filtering process flows by label

To filter this list by specific labels, follow the steps below:

Step 1 Click the filter icon associated with the labels column:

Step 2 Click the select labels field:

Step 3 Select any labels that you want to apply for this filter:

Step 4 Apply your selections.

...the list is updated so only process flows with your selected label(s) are displayed: