Installing an app


Installing a Patchworks app is a straightforward, one-click operation via the Patchworks marketplace.

Once installed, all app components (connectors, process flows, scripts, etc.) are added to the relevant area of your Patchworks dashboard - connectors are added to your connectors page, process flows are added to your process flows list, custom scripts are added to your scripts list, etc.

You then need to complete a few setup tasks in order to make associated process flows live. This page details the installation and post-installation setup steps required.

Need to know

  • If you install an app which includes a connector that you've 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.

  • Prior to installing an app, you have the option to add instances for any connectors that are included - this is where you provide your authentication credentials for the associated third-party system. If you have the required credentials to hand then you can save some time by adding the instances here, but it's not mandatory - it's fine to simply install the app and add instances afterwards via your manage connectors page.

  • When an app is installed, its process flows are disabled and set to a draft status. When you are ready, you should enable and deploy any process flows that you want to use. Keep in mind that your Patchworks subscription tier determines the number of process flows and connectors that you can deploy.

App installation steps

To install an app, follow the steps below.

Step 1 Select marketplace from the left-hand navigation menu, then access the apps section.

Step 2 Click anywhere on the app that you want to install:

Step 3 Review the contents of the app. If required, you can choose to exclude individual process flows by toggling the associated install button OFF:

Typically, process flows are key to the successful implementation of apps. We recommend installing and using the process flows that are included unless you have a specific reason not to do so.

Step 4 If you have credentials to hand for required connector instances, move down to the connectors section and click the add instance option:

You're then prompted to enter details for the instance, including authentication credentials. For more information please see Adding connector instances prior to installation.

You cannot add instances that require OAuth 2 (Client Credentials) authentication, via the app install process. If an app includes connectors that require OAuth 2 (Client Credentials) authentication then you should install the app and add instances afterwards via your manage connectors page.

Step 5 Click the install button at the top of the app details page.

Step 6 You are returned to the marketplace and a confirmation message is displayed, advising that the app is queued for installation:

Step 7 Typically, installation is completed in a matter of seconds, but you can navigate away in the meantime. Once the installation is complete, you'll see a notification in the top information bar - for example:

Post-installation steps for an app

Having installed an app, follow the steps below to complete its setup:

Stage 1: Verify installed components

This step isn't mandatory, but it may be useful to have details of what components have been installed for this app. To do this, select the app from the marketplace once again, so you can see a list of all components.

Stage 2: 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 app will be shown here. If the app 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.

Stage 3: 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 any process flows associated with the app.

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 were added via the app installation.

Edit the first process flow associated with the app 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 4: 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 5: 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.

Your Patchworks subscription determines the number of deployed connectors and process flows that are permitted.

Stage 6: 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:

Last updated