Installing a prebuilt process flow
Last updated
Last updated
Installing a prebuilt process flow is a straightforward, one-click operation via the . All required components are installed and added to the relevant part of your Patchworks dashboard.
Once the installation is complete, you need to complete a few setup tasks in order to make the process flow live. This page details the and steps required.
When a prebuilt process flow is installed, all components (connectors, scripts, etc.) are added to the relevant area of your Patchworks dashboard - connectors are added to your , custom scripts are added to etc.
For more information about the components of a prebuilt process flow please see .
If you install a prebuilt process flow which includes a connector that you have already installed from the , a fresh copy of that connector is installed alongside the existing one. You can then decide which one to use.
When a prebuilt process flow is installed, it is disabled and set to a draft status. When you are ready, you should and the process flow. Keep in mind that your determines the number of process flows and connectors that you can deploy.
To install a prebuilt process flow, follow the steps below.
Step 1 Select marketplace from the left-hand navigation menu, then access the section.
Step 2 Find the process flow that you want to install (if necessary, click the view button for a read-only view of the flow, to be sure):
Step 3 Click the install button for the required process flow:
Having installed a prebuilt process flow, follow the steps below to complete its setup:
Select process flows | connectors & instances from the left-hand navigation menu. Here you'll find all of your installed connectors.
Any connectors installed via the prebuilt process flow will be shown here. If the process flow installs a connector that you already had, you'll find a fresh version of the connector next to your existing one, so you can decide which one to use.
Once you're satisfied that all required instances are in place with your connector credentials, you need to apply these to connection shapes in the new process flow.
Click the settings icon for the connection shape and choose the required instance and endpoint (leave all other connection settings as the default):
Check all other shapes in the process flow for a warning symbol. If there is a warning, open settings and click save to confirm.
Step 4 A confirmation message is displayed, advising that the process flow is queued for installation. Typically, installation is completed in a few seconds, but you can navigate away in the meantime. Once the installation is complete, you'll see a notification in your .
To do this, select process flows | process flows from the left-hand navigation menu. Here you'll find , including any that you have installed from the marketplace.
Edit the new process flow and check all - you'll notice a warning symbol, indicating that the shape is not configured - for example:
Once you're satisfied that all connection shapes are configured and you're ready to put the process flow live, you should deploy it. To do this, access and change the draft status to deployed:
For more information please see .
The final step is to enable the process flow. To do this, access and toggle the ENABLE option to ON:
That's fine. Chances are that if you already have the connector installed, you will have existing that can be used. In this case, you can go straight to .
If you don't have all the instances that you need for your existing connector, you should .
The new connector will not have any associated instances, so you need to .
