- Starter
- Business
- Enterprise
- On-Premise
- Add-on
Overview
Note: Patch functionality only available to Super Admin users.
Flow patching allows you to copy changes from one flow to others across tenants. Primary use case for using Patch functionality is when you want to have multiple copies of the same flow across different tenants and want to propagate changes made in any of them to other instances to keep them in sync.
Flow patching can be accessed from the Flows page, click Export/Import, and select Patch.
Process
Patching process consists of 4 to 5 steps.
1. Select source flow
Select source flow from which changes will be copied.
2. Select destination flows
To add destination flows click Add Flows.
You can search destination flows by Name, Include tags (set of tags that flow has to have) and Exclude tags (set of tags that flows shouldn't have).
To add specific flows from the found list, select a checkbox next to desired flows and then click on Add selected. To add all found flows simply use Add all option.
3. Set Options
Options tab allows you to specified how elements of the flow should be matched in destinations as well as what things should be updated.
Available options
| Name | Description |
|---|---|
| Match connections by | When destination flow belongs to a tenant different from the source flow, patching process has to find matching pairs of connections. This option specifies whether connections should be matched by name or tags. |
| Add connection if not matched | If corresponding connection hasn't been found, add copy of the source connection. |
| Match formats by | When destination flow belongs to a tenant different from the source flow, patching process has to find matching pairs of formats. This option specifies whether formats should be matched by name or tags. |
| Add format if not matched | If corresponding format hasn't been found, add copy of the source format. |
| Match macros by | When destination flow belongs to a tenant different from the source flow, patching process has to find matching pairs of macros. This option specifies whether macros should be matched by name or tags. |
| Add macros if not matched | If corresponding macro hasn't been found, add copy of the source macro. |
| Update matched macros | If corresponding macro has been found, copy changes (if any) from the source macro. |
| Match flows by | When destination flow belongs to a tenant different from the source flow, patching process has to find matching pairs of nested flows. This option specifies whether flows should be matched by name or tags. |
| Import flow if not matched | If corresponding flow hasn't been found, import it from the source. |
| Flow import collision policy | What collision policy should be used when importing not matched flows. |
| Update flow name | If selected, destination flows names will be replaced with source flow name. |
| Update flow tags | If selected, destination flows tags will be replaced with source flow tags. |
| Update flow description | If selected, destination flows description will be replaced with source flow description. |
| Patch Message | "Save message" to add to all added, imported or updated items during the patch process. |
| Remember above options | If selected, the current state of above options will be preserved for next patch. |
4. Preview (optional)
To preview what will happen during the patch click on Preview button. Preview is optional, but we recommend using it every time to make sure there are no unexpected results.
Preview will show a table of all items that were or weren't matched as well as all items that will be added, imported or updated. Items that will be updated have Update status with an eye icon next to it that if clicked will show change diff.
5. Patch Results
To start patch click on Patch button. You will be presented with patch report as soon as it's done. Same as in preview, patch results will be presented in the table containing all the matched, added, imported and updated items.
Things to consider when using Patch
When creating connections, formats, flows and macros with Patch in mind make sure that you use distinct names, or tags for each element of the flow. During patch process all elements of the source flow will have to be match to corresponding elements in the destination. If more than one element in the destination matches same source element, patch process will not be allowed due to ambiguity. So if you are planning to match elements by name, don't use overly generic names, such as for example a format with name "JSON" that will match all other flows with names like: "Generic JSON", "Specific JSON", etc. Same logic applies when using tags to match elements.