Installing a prebuilt process flow

Introduction

Installing a prebuilt process flow is a straightforward, one-click operation via the Patchworks marketplace. 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 installation and post-installation setup steps required.

What is installed?

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 connectors page, custom scripts are added to your scripts list, etc.

For more information about the components of a prebuilt process flow please see The anatomy of a prebuilt process flow.

Need to know

• If you install a prebuilt process flow which includes a connector that you have already installed from the connector marketplace, 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 enable and deploy the process flow. Keep in mind that your Patchworks subscription tier determines the number of process flows and connectors that you can deploy.

Prebuilt process flow installation steps

To install a prebuilt process flow, follow the steps below.

Step 1 Select marketplace from the left-hand navigation menu, then access the process flows 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):

Don't forget that you can use the search bar to find process flows.

Step 3 Click the install button for the required process flow:

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 notification centre.

Post-installation steps for a prebuilt process flow

Having installed a prebuilt process flow, follow the steps below to complete its setup:

• Stage 1: Check installed connectors & add required instances

• Stage 2: Update process flow connection shapes

• Stage 3: Check other shapes

• Stage 4: Deploy the process flow

• Stage 5: Enable the process flow

Stage 1: Check installed connectors & add required instances

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.

I have an existing version of this connector that I'd like to use

That's fine. Chances are that if you already have the connector installed, you will have existing instances that can be used. In this case, you can go straight to Stage 2.

If you don't have all the instances that you need for your existing connector, you should add them now.

I want to use the new connector installed by the process flow

The new connector will not have any associated instances, so you need to add them now.

Stage 2: Update process flow connection shapes

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.

To do this, select process flows | process flows from the left-hand navigation menu. Here you'll find all of your process flows, including any that you have installed from the marketplace.

Edit the new process flow and check all connection shapes - you'll notice a warning symbol, indicating that the shape is not configured - for example:

Click the settings icon for the connection shape and choose the required instance and endpoint (leave all other connection settings as the default):

Don't forget to save your changes!

Stage 3: Check other shapes

Check all other shapes in the process flow for a warning symbol. If there is a warning, open settings and click save to confirm.

Other shapes should not need to be changed but sometimes you may need to confirm default details by saving the shape settings.

Stage 4: Deploy the process flow

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 process flow settings and change the draft status to deployed:

For more information please see Process flow versioning.

Stage 5: Enable the process flow

The final step is to enable the process flow. To do this, access process flow settings and toggle the ENABLE option to ON: